OdBcf::OdBcfTimeStamp Class Reference

#include <BcfTimeStamp.h>

Inheritance diagram for OdBcf::OdBcfTimeStamp:

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 OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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< OdBcfTimeStamp >	createObject (const OdString &timeStampString)
static OdSmartPtr< OdBcfTimeStamp >	createObject (const OdTimeStamp &localTimeStamp)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

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
OdTimeStamp	m_unsetTime
OdInt	m_timeZone
bool	m_isUTC
bool	m_isTimePeriod

Detailed Description

A class that provides functionality for working with DateTime data type values within the BCF format.

Definition at line 39 of file BcfTimeStamp.h.

Constructor & Destructor Documentation

OdBcfTimeStamp()

OdBcf::OdBcfTimeStamp::OdBcfTimeStamp

(

)

Creates a new timestamp object with default parameters.

Member Function Documentation

createObject() [1/2]

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

static

Creates a new timestamp object for a specified datetime value.

Parameters

timeStampString

[in] A string that contains a datetime value.

Returns

A smart pointer to the created <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdBcf__OdBcfTimeStamp.html>OdBcfTimeStamp</exref> OdBcfTimeStamp> instance.

createObject() [2/2]

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

static

Creates a new timestamp object for a specified <exref target="https://docs.opendesign.com/tkernel_api_cpp/OdTimeStamp.html">OdTimeStamp</exref> value.

Parameters

localTimeStamp

[in] An OdTimeStamp value.

Returns

A smart pointer to the created <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdBcf__OdBcfTimeStamp.html>OdBcfTimeStamp</exref> OdBcfTimeStamp> instance.

Remarks

The method records provided value using the system native 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

The conversion operator to an OdString for BCF timestamp objects.

Returns

An OdString object that contains the timestamp data formatted in accordance with datetime style.

operator!=()

bool OdBcf::OdBcfTimeStamp::operator!=

(

const OdBcfTimeStamp &

val

)

const

Unequality operator for BCF timestamp objects.

Parameters

val	[in] Another BCF timestamp value to be compared with (right-hand operand).

Returns

true if the BCF timestamp object is unequal to another BCF timestamp object; otherwise, the method returns false.

operator<()

bool OdBcf::OdBcfTimeStamp::operator<

(

const OdBcfTimeStamp &

val

)

const

Less than operator for BCF timestamp objects.

Parameters

val	[in] Another BCF timestamp value to be compared with (right-hand operand).

Returns

true if the BCF timestamp object is less than another BCF timestamp object; otherwise, the method returns false.

operator==()

bool OdBcf::OdBcfTimeStamp::operator==

(

const OdBcfTimeStamp &

val

)

const

Equality operator for BCF timestamp objects.

Parameters

val	[in] Another BCF timestamp value to be compared with (right-hand operand).

Returns

true if the BCF timestamp object is equal to another BCF timestamp object; otherwise, the method returns false.

toString()

OdString OdBcf::OdBcfTimeStamp::toString

(

)

const

Converts the timestamp value to a datetime-style formatted string.

Returns

An OdString object that contains the timestamp value formatted in accordance with the datetime style.

toUTC()

OdTimeStamp OdBcf::OdBcfTimeStamp::toUTC ( ) const

protected

Member Data Documentation

m_isTimePeriod

bool OdBcf::OdBcfTimeStamp::m_isTimePeriod

protected

Definition at line 109 of file BcfTimeStamp.h.

m_isUTC

bool OdBcf::OdBcfTimeStamp::m_isUTC

protected

Definition at line 108 of file BcfTimeStamp.h.

m_timeStamp

OdTimeStamp OdBcf::OdBcfTimeStamp::m_timeStamp

protected

Definition at line 105 of file BcfTimeStamp.h.

m_timeZone

OdInt OdBcf::OdBcfTimeStamp::m_timeZone

protected

Definition at line 107 of file BcfTimeStamp.h.

m_unsetTime

OdTimeStamp OdBcf::OdBcfTimeStamp::m_unsetTime

protected

Definition at line 106 of file BcfTimeStamp.h.

---

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

• BcfTimeStamp.h