performs common time operations More...

#include <vtkTimePointUtility.h>

Inheritance diagram for vtkTimePointUtility:

Collaboration diagram for vtkTimePointUtility:

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.

vtkTimePointUtility *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTimePointUtility *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTimePointUtility *	SafeDownCast (vtkObjectBase *o)

static vtkTypeUInt64	DateToTimePoint (int year, int month, int day)
	Return the time point for 12:00am on a specified day.

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.

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.

static void	GetDate (vtkTypeUInt64 time, int &year, int &month, int &day)
	Retrieve the year, month, and day of a time point.

static void	GetTime (vtkTypeUInt64 time, int &hour, int &minute, int &second, int &millis)
	Retrieve the hour, minute, second, and milliseconds of a time point.

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.

static int	GetYear (vtkTypeUInt64 time)
	Retrieve the year from a time point.

static int	GetMonth (vtkTypeUInt64 time)
	Retrieve the month from a time point.

static int	GetDay (vtkTypeUInt64 time)
	Retrieve the day of the month from a time point.

static int	GetHour (vtkTypeUInt64 time)
	Retrieve the hour of the day from the time point.

static int	GetMinute (vtkTypeUInt64 time)
	Retrieve the number of minutes from the start of the last hour.

static int	GetSecond (vtkTypeUInt64 time)
	Retrieve the number of seconds from the start of the last minute.

static int	GetMillisecond (vtkTypeUInt64 time)
	Retrieve the milliseconds from the start of the last second.

static vtkTypeUInt64	ISO8601ToTimePoint (const char str, bool ok=nullptr)
	Converts a ISO8601 string into a VTK timepoint.

static const char *	TimePointToISO8601 (vtkTypeUInt64, int format=ISO8601_DATETIME_MILLIS)
	Converts a VTK timepoint into one of the following ISO8601 formats.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

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 vtkObjectBase *	NewInstanceInternal () 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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	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 22 of file vtkTimePointUtility.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTimePointUtility::Superclass

Definition at line 26 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 100 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 109 of file vtkTimePointUtility.h.

◆ MILLIS_PER_MINUTE

const int vtkTimePointUtility::MILLIS_PER_MINUTE

static

Definition at line 110 of file vtkTimePointUtility.h.

◆ MILLIS_PER_HOUR

const int vtkTimePointUtility::MILLIS_PER_HOUR

static

Definition at line 111 of file vtkTimePointUtility.h.

◆ MILLIS_PER_DAY

const int vtkTimePointUtility::MILLIS_PER_DAY

static

Definition at line 112 of file vtkTimePointUtility.h.

◆ SECONDS_PER_MINUTE

const int vtkTimePointUtility::SECONDS_PER_MINUTE

static

Definition at line 113 of file vtkTimePointUtility.h.

◆ SECONDS_PER_HOUR

const int vtkTimePointUtility::SECONDS_PER_HOUR

static

Definition at line 114 of file vtkTimePointUtility.h.

◆ SECONDS_PER_DAY

const int vtkTimePointUtility::SECONDS_PER_DAY

static

Definition at line 115 of file vtkTimePointUtility.h.

◆ MINUTES_PER_HOUR

const int vtkTimePointUtility::MINUTES_PER_HOUR

static

Definition at line 116 of file vtkTimePointUtility.h.

◆ MINUTES_PER_DAY

const int vtkTimePointUtility::MINUTES_PER_DAY

static

Definition at line 117 of file vtkTimePointUtility.h.

◆ HOURS_PER_DAY

const int vtkTimePointUtility::HOURS_PER_DAY

static

Definition at line 118 of file vtkTimePointUtility.h.

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

Common/Core/vtkTimePointUtility.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkTimePointUtility()

◆ ~vtkTimePointUtility()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ DateToTimePoint()

◆ TimeToTimePoint()

◆ DateTimeToTimePoint()

◆ GetDate()

◆ GetTime()

◆ GetDateTime()

◆ GetYear()

◆ GetMonth()

◆ GetDay()

◆ GetHour()

◆ GetMinute()

◆ GetSecond()

◆ GetMillisecond()

◆ ISO8601ToTimePoint()

◆ TimePointToISO8601()

Member Data Documentation

◆ MILLIS_PER_SECOND

◆ MILLIS_PER_MINUTE

◆ MILLIS_PER_HOUR

◆ MILLIS_PER_DAY

◆ SECONDS_PER_MINUTE

◆ SECONDS_PER_HOUR

◆ SECONDS_PER_DAY

◆ MINUTES_PER_HOUR

◆ MINUTES_PER_DAY

◆ HOURS_PER_DAY