vtkTimePointUtility Class Reference

#include <vtkTimePointUtility.h>

Inheritance diagram for vtkTimePointUtility:

[legend]

Collaboration diagram for vtkTimePointUtility:

[legend]

List of all members.

Detailed Description

performs common time operations

vtkTimePointUtility is provides methods to perform common time operations.

Tests:: vtkTimePointUtility (Tests)

Definition at line 35 of file vtkTimePointUtility.h.


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 const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Static Public Member Functions
static vtkTimePointUtility *	New ()
static int	IsTypeOf (const char *type)
static vtkTimePointUtility *	SafeDownCast (vtkObject *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 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
	vtkTimePointUtility ()
	~vtkTimePointUtility ()

Member Typedef Documentation

typedef vtkObject vtkTimePointUtility::Superclass

Reimplemented from vtkObject.

Definition at line 39 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 106 of file vtkTimePointUtility.h.

Constructor & Destructor Documentation

vtkTimePointUtility::vtkTimePointUtility ( ) [inline, protected]

Definition at line 149 of file vtkTimePointUtility.h.

vtkTimePointUtility::~vtkTimePointUtility ( ) [inline, protected]

Definition at line 150 of file vtkTimePointUtility.h.

Member Function Documentation

static vtkTimePointUtility* vtkTimePointUtility::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkTimePointUtility::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkTimePointUtility::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

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 ( vtkObject * o ) [static]

Reimplemented from vtkObject.

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