VTK  9.2.20220810
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
vtkTimePointUtility Class Reference

performs common time operations More...

#include <vtkTimePointUtility.h>

Inheritance diagram for vtkTimePointUtility:
[legend]
Collaboration diagram for vtkTimePointUtility:
[legend]

Public Types

enum  {
  ISO8601_DATETIME_MILLIS = 0 , ISO8601_DATETIME = 1 , ISO8601_DATE = 2 , ISO8601_TIME_MILLIS = 3 ,
  ISO8601_TIME = 4
}
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkTimePointUtilityNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkTimePointUtilityNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTimePointUtilitySafeDownCast (vtkObjectBase *o)
 
static vtkTypeUInt64 DateToTimePoint (int year, int month, int day)
 Return the time point for 12:00am on a specified day. More...
 
static vtkTypeUInt64 TimeToTimePoint (int hour, int minute, int second, int millis=0)
 Return the time point for a time of day (the number of milliseconds from 12:00am. More...
 
static vtkTypeUInt64 DateTimeToTimePoint (int year, int month, int day, int hour, int minute, int sec, int millis=0)
 Return the time point for a date and time. More...
 
static void GetDate (vtkTypeUInt64 time, int &year, int &month, int &day)
 Retrieve the year, month, and day of a time point. More...
 
static void GetTime (vtkTypeUInt64 time, int &hour, int &minute, int &second, int &millis)
 Retrieve the hour, minute, second, and milliseconds of a time point. More...
 
static void GetDateTime (vtkTypeUInt64 time, int &year, int &month, int &day, int &hour, int &minute, int &second, int &millis)
 Retrieve the date and time of a time point. More...
 
static int GetYear (vtkTypeUInt64 time)
 Retrieve the year from a time point. More...
 
static int GetMonth (vtkTypeUInt64 time)
 Retrieve the month from a time point. More...
 
static int GetDay (vtkTypeUInt64 time)
 Retrieve the day of the month from a time point. More...
 
static int GetHour (vtkTypeUInt64 time)
 Retrieve the hour of the day from the time point. More...
 
static int GetMinute (vtkTypeUInt64 time)
 Retrieve the number of minutes from the start of the last hour. More...
 
static int GetSecond (vtkTypeUInt64 time)
 Retrieve the number of seconds from the start of the last minute. More...
 
static int GetMillisecond (vtkTypeUInt64 time)
 Retrieve the milliseconds from the start of the last second. More...
 
static vtkTypeUInt64 ISO8601ToTimePoint (const char *str, bool *ok=nullptr)
 Converts a ISO8601 string into a VTK timepoint. More...
 
static const char * TimePointToISO8601 (vtkTypeUInt64, int format=ISO8601_DATETIME_MILLIS)
 Converts a VTK timepoint into one of the following ISO8601 formats. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Static Public Attributes

static const int MILLIS_PER_SECOND
 
static const int MILLIS_PER_MINUTE
 
static const int MILLIS_PER_HOUR
 
static const int MILLIS_PER_DAY
 
static const int SECONDS_PER_MINUTE
 
static const int SECONDS_PER_HOUR
 
static const int SECONDS_PER_DAY
 
static const int MINUTES_PER_HOUR
 
static const int MINUTES_PER_DAY
 
static const int HOURS_PER_DAY
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTimePointUtility ()=default
 
 ~vtkTimePointUtility () override=default
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

performs common time operations

vtkTimePointUtility is provides methods to perform common time operations.

Tests:
vtkTimePointUtility (Tests)

Definition at line 37 of file vtkTimePointUtility.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkTimePointUtility.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ISO8601_DATETIME_MILLIS 
ISO8601_DATETIME 
ISO8601_DATE 
ISO8601_TIME_MILLIS 
ISO8601_TIME 

Definition at line 115 of file vtkTimePointUtility.h.

Constructor & Destructor Documentation

◆ vtkTimePointUtility()

vtkTimePointUtility::vtkTimePointUtility ( )
protecteddefault

◆ ~vtkTimePointUtility()

vtkTimePointUtility::~vtkTimePointUtility ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkTimePointUtility* vtkTimePointUtility::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkTimePointUtility::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkTimePointUtility::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkTimePointUtility* vtkTimePointUtility::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTimePointUtility::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkTimePointUtility* vtkTimePointUtility::NewInstance ( ) const

◆ PrintSelf()

void vtkTimePointUtility::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ DateToTimePoint()

static vtkTypeUInt64 vtkTimePointUtility::DateToTimePoint ( int  year,
int  month,
int  day 
)
static

Return the time point for 12:00am on a specified day.

◆ TimeToTimePoint()

static vtkTypeUInt64 vtkTimePointUtility::TimeToTimePoint ( int  hour,
int  minute,
int  second,
int  millis = 0 
)
static

Return the time point for a time of day (the number of milliseconds from 12:00am.

The hour should be from 0-23.

◆ DateTimeToTimePoint()

static vtkTypeUInt64 vtkTimePointUtility::DateTimeToTimePoint ( int  year,
int  month,
int  day,
int  hour,
int  minute,
int  sec,
int  millis = 0 
)
static

Return the time point for a date and time.

◆ GetDate()

static void vtkTimePointUtility::GetDate ( vtkTypeUInt64  time,
int &  year,
int &  month,
int &  day 
)
static

Retrieve the year, month, and day of a time point.

Everything but the first argument are output parameters.

◆ GetTime()

static void vtkTimePointUtility::GetTime ( vtkTypeUInt64  time,
int &  hour,
int &  minute,
int &  second,
int &  millis 
)
static

Retrieve the hour, minute, second, and milliseconds of a time point.

Everything but the first argument are output parameters.

◆ GetDateTime()

static void vtkTimePointUtility::GetDateTime ( vtkTypeUInt64  time,
int &  year,
int &  month,
int &  day,
int &  hour,
int &  minute,
int &  second,
int &  millis 
)
static

Retrieve the date and time of a time point.

Everything but the first argument are output parameters.

◆ GetYear()

static int vtkTimePointUtility::GetYear ( vtkTypeUInt64  time)
static

Retrieve the year from a time point.

◆ GetMonth()

static int vtkTimePointUtility::GetMonth ( vtkTypeUInt64  time)
static

Retrieve the month from a time point.

◆ GetDay()

static int vtkTimePointUtility::GetDay ( vtkTypeUInt64  time)
static

Retrieve the day of the month from a time point.

◆ GetHour()

static int vtkTimePointUtility::GetHour ( vtkTypeUInt64  time)
static

Retrieve the hour of the day from the time point.

◆ GetMinute()

static int vtkTimePointUtility::GetMinute ( vtkTypeUInt64  time)
static

Retrieve the number of minutes from the start of the last hour.

◆ GetSecond()

static int vtkTimePointUtility::GetSecond ( vtkTypeUInt64  time)
static

Retrieve the number of seconds from the start of the last minute.

◆ GetMillisecond()

static int vtkTimePointUtility::GetMillisecond ( vtkTypeUInt64  time)
static

Retrieve the milliseconds from the start of the last second.

◆ ISO8601ToTimePoint()

static vtkTypeUInt64 vtkTimePointUtility::ISO8601ToTimePoint ( const char *  str,
bool *  ok = nullptr 
)
static

Converts a ISO8601 string into a VTK timepoint.

The string must follow one of the ISO8601 formats described in ToISO8601. To check for a valid format, pass a bool* as the second argument. The value will be set to true if the string was parsed successfully, false otherwise.

◆ TimePointToISO8601()

static const char* vtkTimePointUtility::TimePointToISO8601 ( vtkTypeUInt64  ,
int  format = ISO8601_DATETIME_MILLIS 
)
static

Converts a VTK timepoint into one of the following ISO8601 formats.

The default format is ISO8601_DATETIME_MILLIS.

Type                      Format / Example
0 ISO8601_DATETIME_MILLIS [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[SSS]
2006-01-02T03:04:05.678
1 ISO8601_DATETIME        [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
2006-01-02T03:04:05
2 ISO8601_DATE            [YYYY]-[MM]-[DD]
2006-01-02
3 ISO8601_TIME_MILLIS     [hh]:[mm]:[ss].[SSS]
03:04:05.678
4 ISO8601_TIME            [hh]:[mm]:[ss]
03:04:05

Member Data Documentation

◆ MILLIS_PER_SECOND

const int vtkTimePointUtility::MILLIS_PER_SECOND
static

Definition at line 124 of file vtkTimePointUtility.h.

◆ MILLIS_PER_MINUTE

const int vtkTimePointUtility::MILLIS_PER_MINUTE
static

Definition at line 125 of file vtkTimePointUtility.h.

◆ MILLIS_PER_HOUR

const int vtkTimePointUtility::MILLIS_PER_HOUR
static

Definition at line 126 of file vtkTimePointUtility.h.

◆ MILLIS_PER_DAY

const int vtkTimePointUtility::MILLIS_PER_DAY
static

Definition at line 127 of file vtkTimePointUtility.h.

◆ SECONDS_PER_MINUTE

const int vtkTimePointUtility::SECONDS_PER_MINUTE
static

Definition at line 128 of file vtkTimePointUtility.h.

◆ SECONDS_PER_HOUR

const int vtkTimePointUtility::SECONDS_PER_HOUR
static

Definition at line 129 of file vtkTimePointUtility.h.

◆ SECONDS_PER_DAY

const int vtkTimePointUtility::SECONDS_PER_DAY
static

Definition at line 130 of file vtkTimePointUtility.h.

◆ MINUTES_PER_HOUR

const int vtkTimePointUtility::MINUTES_PER_HOUR
static

Definition at line 131 of file vtkTimePointUtility.h.

◆ MINUTES_PER_DAY

const int vtkTimePointUtility::MINUTES_PER_DAY
static

Definition at line 132 of file vtkTimePointUtility.h.

◆ HOURS_PER_DAY

const int vtkTimePointUtility::HOURS_PER_DAY
static

Definition at line 133 of file vtkTimePointUtility.h.


The documentation for this class was generated from the following file: