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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkTimePointUtility *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkTimePointUtility *	New ()

static int	IsTypeOf (const char *type)

static vtkTimePointUtility *	SafeDownCast (vtkObjectBase *o)

static int	GetYear (vtkTypeUInt64 time)

static int	GetMonth (vtkTypeUInt64 time)

static int	GetDay (vtkTypeUInt64 time)

static int	GetHour (vtkTypeUInt64 time)

static int	GetMinute (vtkTypeUInt64 time)

static int	GetSecond (vtkTypeUInt64 time)

static int	GetMillisecond (vtkTypeUInt64 time)


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


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


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


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


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


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


static vtkTypeUInt64	ISO8601ToTimePoint (const char str, bool ok=NULL)


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

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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

	~vtkTimePointUtility ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

performs common time operations

vtkTimePointUtility is provides methods to perform common time operations.

Tests:: vtkTimePointUtility (Tests)

Definition at line 36 of file vtkTimePointUtility.h.

Member Typedef Documentation

typedef vtkObject vtkTimePointUtility::Superclass

Definition at line 40 of file vtkTimePointUtility.h.

Member Enumeration Documentation

anonymous enum

Enumerator
ISO8601_DATETIME_MILLIS
ISO8601_DATETIME
ISO8601_DATE
ISO8601_TIME_MILLIS
ISO8601_TIME

Definition at line 107 of file vtkTimePointUtility.h.

Constructor & Destructor Documentation

vtkTimePointUtility::vtkTimePointUtility ( )

inlineprotected

Definition at line 150 of file vtkTimePointUtility.h.

vtkTimePointUtility::~vtkTimePointUtility ( )

inlineprotected

Definition at line 151 of file vtkTimePointUtility.h.

Member Function Documentation

static vtkTimePointUtility* vtkTimePointUtility::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkTimePointUtility::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkTimePointUtility* vtkTimePointUtility::NewInstance ( ) const

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

virtual

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.

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

static

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

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.

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.

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.

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.

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.

static int vtkTimePointUtility::GetYear ( vtkTypeUInt64 time )

static

Retrieve the year from a time point.

static int vtkTimePointUtility::GetMonth ( vtkTypeUInt64 time )

static

Retrieve the month from a time point.

static int vtkTimePointUtility::GetDay ( vtkTypeUInt64 time )

static

Retrieve the day of the month from a time point.

static int vtkTimePointUtility::GetHour ( vtkTypeUInt64 time )

static

Retrieve the hour of the day from the time point.

static int vtkTimePointUtility::GetMinute ( vtkTypeUInt64 time )

static

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

static int vtkTimePointUtility::GetSecond ( vtkTypeUInt64 time )

static

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

static int vtkTimePointUtility::GetMillisecond ( vtkTypeUInt64 time )

static

Retrieve the milliseconds from the start of the last second.

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

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.

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

const int vtkTimePointUtility::MILLIS_PER_SECOND

static

Definition at line 115 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::MILLIS_PER_MINUTE

static

Definition at line 116 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::MILLIS_PER_HOUR

static

Definition at line 117 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::MILLIS_PER_DAY

static

Definition at line 118 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::SECONDS_PER_MINUTE

static

Definition at line 119 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::SECONDS_PER_HOUR

static

Definition at line 120 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::SECONDS_PER_DAY

static

Definition at line 121 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::MINUTES_PER_HOUR

static

Definition at line 122 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::MINUTES_PER_DAY

static

Definition at line 123 of file vtkTimePointUtility.h.

const int vtkTimePointUtility::HOURS_PER_DAY

static

Definition at line 124 of file vtkTimePointUtility.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/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

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation