CFx SDK Documentation  2023 SP0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdBcf::OdBcfTimeStamp Class Reference

#include <BcfTimeStamp.h>

Inheritance diagram for OdBcf::OdBcfTimeStamp:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfTimeStamp)
 
 OdBcfTimeStamp ()
 
OdString toString () const
 
bool operator== (const OdBcfTimeStamp &val) const
 
bool operator!= (const OdBcfTimeStamp &val) const
 
bool operator< (const OdBcfTimeStamp &val) const
 
 operator OdString () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdSmartPtr< OdBcfTimeStampcreateObject (const OdString &timeString)
 
static OdSmartPtr< OdBcfTimeStampcreateObject (const OdTimeStamp &localTimeStamp)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

void init (const OdUInt16 year, const OdUInt8 month, const OdUInt8 day, const OdUInt8 hour, const OdUInt8 minute, const OdUInt8 second, const OdUInt16 msecond, const OdInt8 timeZoneSign, const OdUInt8 timeZoneHour, const OdUInt8 timeZoneMinute)
 
OdTimeStamp toUTC () const
 

Protected Attributes

OdTimeStamp m_timeStamp
 
OdInt m_timeZone
 
bool m_isUTC
 

Detailed Description

A class that provides functionality for working with DateTime data type.

Definition at line 39 of file BcfTimeStamp.h.

Constructor & Destructor Documentation

◆ OdBcfTimeStamp()

OdBcf::OdBcfTimeStamp::OdBcfTimeStamp ( )

Creates a new object with default parameters.

Member Function Documentation

◆ createObject() [1/2]

static OdSmartPtr<OdBcfTimeStamp> OdBcf::OdBcfTimeStamp::createObject ( const OdString timeString)
static

Creates a new time stamp object for specified DateTime value.

Parameters
value[in] A string that contains DateTime value.
Returns
Returns a smart pointer to the created <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> instance.

◆ createObject() [2/2]

static OdSmartPtr<OdBcfTimeStamp> OdBcf::OdBcfTimeStamp::createObject ( const OdTimeStamp localTimeStamp)
static

Creates a new time stamp object for specified OdTimeStamp value.

Parameters
localTimeStamp[in] An OdTimeStamp value.
Returns
Returns a smart pointer to the created <link OdBcf::OdBcfTimeStamp, OdBcfTimeStamp> instance.
Remarks
The method records provided value in native for system time zone.

◆ init()

void OdBcf::OdBcfTimeStamp::init ( const OdUInt16  year,
const OdUInt8  month,
const OdUInt8  day,
const OdUInt8  hour,
const OdUInt8  minute,
const OdUInt8  second,
const OdUInt16  msecond,
const OdInt8  timeZoneSign,
const OdUInt8  timeZoneHour,
const OdUInt8  timeZoneMinute 
)
protected

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfTimeStamp::ODRX_DECLARE_MEMBERS ( OdBcfTimeStamp  )

◆ operator OdString()

OdBcf::OdBcfTimeStamp::operator OdString ( ) const

OdString conversion function for BCF time stamp objects.

Returns
Returns OdString representation of contained time stamp in accordance with DateTime format.

◆ operator!=()

bool OdBcf::OdBcfTimeStamp::operator!= ( const OdBcfTimeStamp val) const

Unequal to operator for BCF time stamp objects.

Parameters
val[in] Another BCF time stamp value to be compared with (right-hand operand).
Returns
Returns true if the BCF time stamp object is unequal to another BCF time stamp object; otherwise, the method returns false.

◆ operator<()

bool OdBcf::OdBcfTimeStamp::operator< ( const OdBcfTimeStamp val) const

Less than operator for BCF time stamp objects.

Parameters
val[in] Another BCF time stamp value to be compared with (right-hand operand).
Returns
Returns true if the BCF time stamp object is less than another BCF time stamp object; otherwise, the method returns false.

◆ operator==()

bool OdBcf::OdBcfTimeStamp::operator== ( const OdBcfTimeStamp val) const

Equal to operator for BCF time stamp objects.

Parameters
val[in] Another BCF time stamp value to be compared with (right-hand operand).
Returns
Returns true if the BCF time stamp object is equal to another BCF time stamp object; otherwise, the method returns false.

◆ toString()

OdString OdBcf::OdBcfTimeStamp::toString ( ) const

Converts contained time stamp to DateTime string.

Returns
Returns OdString representation of contained time stamp in accordance with DateTime format.

◆ toUTC()

OdTimeStamp OdBcf::OdBcfTimeStamp::toUTC ( ) const
protected

Member Data Documentation

◆ m_isUTC

bool OdBcf::OdBcfTimeStamp::m_isUTC
protected

Definition at line 106 of file BcfTimeStamp.h.

◆ m_timeStamp

OdTimeStamp OdBcf::OdBcfTimeStamp::m_timeStamp
protected

Definition at line 104 of file BcfTimeStamp.h.

◆ m_timeZone

OdInt OdBcf::OdBcfTimeStamp::m_timeZone
protected

Definition at line 105 of file BcfTimeStamp.h.


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