vtkTimePointUtility.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkTimePointUtility_h
#define vtkTimePointUtility_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkTimePointUtility : public vtkObject
{
public:
  static vtkTimePointUtility* New();
  vtkTypeMacro(vtkTimePointUtility, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  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 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);
 
  enum
  {
    ISO8601_DATETIME_MILLIS = 0,
    ISO8601_DATETIME = 1,
    ISO8601_DATE = 2,
    ISO8601_TIME_MILLIS = 3,
    ISO8601_TIME = 4
  };
 
  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;
 
  static vtkTypeUInt64 ISO8601ToTimePoint(const char* str, bool* ok = nullptr);
 
  static const char* TimePointToISO8601(vtkTypeUInt64, int format = ISO8601_DATETIME_MILLIS);
 
protected:
  vtkTimePointUtility() = default;
  ~vtkTimePointUtility() override = default;
 
private:
  vtkTimePointUtility(const vtkTimePointUtility&) = delete;
  void operator=(const vtkTimePointUtility&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif