VTK  9.3.0
vtkTimePointUtility.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
15 #ifndef vtkTimePointUtility_h
16 #define vtkTimePointUtility_h
17 
18 #include "vtkCommonCoreModule.h" // For export macro
19 #include "vtkObject.h"
20 
21 VTK_ABI_NAMESPACE_BEGIN
22 class VTKCOMMONCORE_EXPORT vtkTimePointUtility : public vtkObject
23 {
24 public:
27  void PrintSelf(ostream& os, vtkIndent indent) override;
28 
32  static vtkTypeUInt64 DateToTimePoint(int year, int month, int day);
33 
38  static vtkTypeUInt64 TimeToTimePoint(int hour, int minute, int second, int millis = 0);
39 
43  static vtkTypeUInt64 DateTimeToTimePoint(
44  int year, int month, int day, int hour, int minute, int sec, int millis = 0);
45 
50  static void GetDate(vtkTypeUInt64 time, int& year, int& month, int& day);
51 
56  static void GetTime(vtkTypeUInt64 time, int& hour, int& minute, int& second, int& millis);
57 
62  static void GetDateTime(vtkTypeUInt64 time, int& year, int& month, int& day, int& hour,
63  int& minute, int& second, int& millis);
64 
68  static int GetYear(vtkTypeUInt64 time);
69 
73  static int GetMonth(vtkTypeUInt64 time);
74 
78  static int GetDay(vtkTypeUInt64 time);
79 
83  static int GetHour(vtkTypeUInt64 time);
84 
88  static int GetMinute(vtkTypeUInt64 time);
89 
93  static int GetSecond(vtkTypeUInt64 time);
94 
98  static int GetMillisecond(vtkTypeUInt64 time);
99 
100  enum
101  {
102  ISO8601_DATETIME_MILLIS = 0,
103  ISO8601_DATETIME = 1,
104  ISO8601_DATE = 2,
105  ISO8601_TIME_MILLIS = 3,
106  ISO8601_TIME = 4
107  };
108 
109  static const int MILLIS_PER_SECOND;
110  static const int MILLIS_PER_MINUTE;
111  static const int MILLIS_PER_HOUR;
112  static const int MILLIS_PER_DAY;
113  static const int SECONDS_PER_MINUTE;
114  static const int SECONDS_PER_HOUR;
115  static const int SECONDS_PER_DAY;
116  static const int MINUTES_PER_HOUR;
117  static const int MINUTES_PER_DAY;
118  static const int HOURS_PER_DAY;
119 
127  static vtkTypeUInt64 ISO8601ToTimePoint(const char* str, bool* ok = nullptr);
128 
147  static const char* TimePointToISO8601(vtkTypeUInt64, int format = ISO8601_DATETIME_MILLIS);
148 
149 protected:
150  vtkTimePointUtility() = default;
151  ~vtkTimePointUtility() override = default;
152 
153 private:
154  vtkTimePointUtility(const vtkTimePointUtility&) = delete;
155  void operator=(const vtkTimePointUtility&) = delete;
156 };
157 
158 VTK_ABI_NAMESPACE_END
159 #endif
a simple class to control print indentation
Definition: vtkIndent.h:29
abstract base class for most VTK objects
Definition: vtkObject.h:52
performs common time operations
static int GetMillisecond(vtkTypeUInt64 time)
Retrieve the milliseconds from the start of the last second.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkTypeUInt64 DateToTimePoint(int year, int month, int day)
Return the time point for 12:00am on a specified day.
static const int SECONDS_PER_DAY
static int GetDay(vtkTypeUInt64 time)
Retrieve the day of the month from a time point.
static const int MILLIS_PER_HOUR
vtkTimePointUtility()=default
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 const int HOURS_PER_DAY
static int GetYear(vtkTypeUInt64 time)
Retrieve the year from a time point.
static void GetDate(vtkTypeUInt64 time, int &year, int &month, int &day)
Retrieve the year, month, and day of a time point.
static const int MILLIS_PER_MINUTE
static int GetHour(vtkTypeUInt64 time)
Retrieve the hour of the day from the time point.
static const char * TimePointToISO8601(vtkTypeUInt64, int format=ISO8601_DATETIME_MILLIS)
Converts a VTK timepoint into one of the following ISO8601 formats.
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 vtkTypeUInt64 ISO8601ToTimePoint(const char *str, bool *ok=nullptr)
Converts a ISO8601 string into a VTK timepoint.
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 GetMinute(vtkTypeUInt64 time)
Retrieve the number of minutes from the start of the last hour.
~vtkTimePointUtility() override=default
static int GetMonth(vtkTypeUInt64 time)
Retrieve the month from a time point.
static vtkTimePointUtility * New()
static const int MILLIS_PER_DAY
static const int SECONDS_PER_MINUTE
static const int MINUTES_PER_DAY
static const int MILLIS_PER_SECOND
static const int SECONDS_PER_HOUR
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 int GetSecond(vtkTypeUInt64 time)
Retrieve the number of seconds from the start of the last minute.
static const int MINUTES_PER_HOUR
@ time
Definition: vtkX3D.h:497