OdTimeStamp.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
 
 
#ifndef _ODTIME_INCLUDED_
#define _ODTIME_INCLUDED_
 
#include "TD_PackPush.h"
#include "OdResult.h"
class OdString;

class FIRSTDLL_EXPORT OdTimeStamp
{
public:
  enum InitialValue
  {
    kInitZero          = 1,  // Midnight, January 1, 1970, UTC.
    kInitLocalTime     = 2,  // Workstation date in local time.
    kInitUniversalTime = 3   // Workstation date in Universal (Greenwich Mean) Time.
  };

   OdTimeStamp();
  OdTimeStamp(
    InitialValue init);

  void getDate(
    short& month, 
    short& day, 
    short& year) const;

  OdResult setDate(
    short month, 
    short day, 
    short year);

  short month() const;

  void setMonth(
    short month);

  short day() const;

  void setDay(
    short day);

  short year() const;

  void setYear(
    short year);

  void getTime(
    short& hour, 
    short& minute, 
    short& second, 
    short& millisecond) const;

  void setTime(
    short hour, 
    short minute, 
    short second, 
    short millisecond);

  short hour() const;

  void setHour(
    short hour);

  short minute() const;

  void setMinute(
    short minute);

  short second() const;

  void setSecond(short second);

  short millisecond() const;

  void setMillisecond(
    short millisecond);

  void setToZero();

  void getLocalTime();

  void getUniversalTime();

  void localToUniversal();

  void universalToLocal();

  OdUInt32 julianDay() const;

  void setJulianDay(
    OdUInt32 julianDay);

  OdUInt32 msecsPastMidnight() const;

  void setMsecsPastMidnight(
    OdUInt32 msecsPastMidnight);

  void setJulianDate(
    OdUInt32 julianDay, 
    OdUInt32 msecsPastMidnight);

  double julianFraction() const;

  void setJulianFraction(
    double julianFraction);
 
  bool operator==(
    const OdTimeStamp& tStamp) const;
 
  bool operator!=(
    const OdTimeStamp& tStamp) const
  {
    return !(operator==(tStamp));
  }
 
  bool operator>(
    const OdTimeStamp& tStamp) const;
 
  bool operator>=(
    const OdTimeStamp& tStamp) const
  {
    return ! operator<(tStamp);
  }
 
  bool operator<(
    const OdTimeStamp& tStamp) const;
 
  bool operator<=(
    const OdTimeStamp& tStamp) const
  {
    return ! operator>(tStamp);
  }
 
  const OdTimeStamp operator+(
    const OdTimeStamp &tStamp) const
  {
    return OdTimeStamp(*this) += tStamp;
  }
 
  const OdTimeStamp operator-(
    const OdTimeStamp &tStamp) const
  {
    return OdTimeStamp(*this) -= tStamp;
  }
 
  const OdTimeStamp& operator+=(
    const OdTimeStamp &tStamp);
 
  const OdTimeStamp& operator-=(
    const OdTimeStamp &tStamp);

  const OdTimeStamp& add(
    const OdTimeStamp &tStamp)
  {
    return operator+=(tStamp);
  }

  const OdTimeStamp& subtract(
    const OdTimeStamp &tStamp)
  {
    return operator-=(tStamp);
  }

  void ctime(
    class OdString& timeString) const;

  void strftime(
    const OdString& format, 
    OdString &timeString) const;

  OdInt64 packedValue() const;
  void setPackedValue(OdInt64 t);
  short weekday() const;
private:
  OdUInt32 m_julianDay;
  OdUInt32 m_msec;
};
#include "TD_PackPop.h"
 
#endif // _ODTIME_INCLUDED_