FREE::TimeStampedObject Class Reference
[Statistics]

Class containing a time stamped. More...

#include <freTimeStampedObject.h>

Inheritance diagram for FREE::TimeStampedObject:

[legend]

Collaboration diagram for FREE::TimeStampedObject:

[legend]

List of all members.

Public Member Functions
DurationType	GetDurationTo (const TimeStampedObject &object) const
DurationType	GetInterimDurationTo (const TimeStampedObject &object) const
DurationType	GetDuration () const
TimeStampedObject &	operator= (const TimeStampedObject &object)
	TimeStampedObject (clock_t &stampOffset, const std::string &sXMLTag=XMLTags::TimeStamp)
	TimeStampedObject (const TimeStampedObject &object)
virtual	~TimeStampedObject ()
const TimeStampType &	GetCreationTimeStamp () const
const TimeStampType &	GetClosingTimeStamp () const
void	SetCreationTimeStamp ()
void	SetCreationTimeStamp (const TimeStampType &timeStamp)
void	SetClosingTimeStamp ()
void	SetClosingTimeStamp (const TimeStampType &timeStamp)
const bool	IsClosed () const
const bool	IsCreated () const
virtual void	Reset ()
Protected Member Functions
virtual void	AttributesLoadProcessing (const AttributesType &rAttributes)
virtual void	SaveAttributes (AttributesSaveListType &rAttributes) const
clock_t &	GetStampOffset () const
Static Private Member Functions
static void	Stamp (TimeStampType &rTimeStamp, clock_t &stampOffset)
Private Attributes
TimeStampType	m_CreationTimeStamp
TimeStampType	m_ClosingTimeStamp
clock_t &	m_StampOffset

---

Detailed Description

Class containing a time stamped.

TimeStampedObject is an object with a time stamped set explicit or while the creation. It is used to store statistical information (e.g. as StepStatisitic).

Definition at line 49 of file freTimeStampedObject.h.

---

Constructor & Destructor Documentation

FREE::TimeStampedObject::TimeStampedObject	(	clock_t &	stampOffset,
		const std::string &	sXMLTag = XMLTags::TimeStamp
	)

Definition at line 72 of file freTimeStampedObject.cxx.

References Reset().

Here is the call graph for this function:

FREE::TimeStampedObject::TimeStampedObject

(

const TimeStampedObject &

object

)

Copy constructor

Definition at line 78 of file freTimeStampedObject.cxx.

FREE::TimeStampedObject::~TimeStampedObject

(

)

[virtual]

Definition at line 84 of file freTimeStampedObject.cxx.

---

Member Function Documentation

DurationType FREE::TimeStampedObject::GetDurationTo

(

const TimeStampedObject &

object

)

const

Calcuates the Duration between the creation of this and the passed object.

Parameters:

[in]

object

Reference to a time stamped object for duration calculation

Returns:

Duration of the time span between this and object.

Implementation of FREE::TimeStampedObject //////////////////////////

Definition at line 35 of file freTimeStampedObject.cxx.

References GetCreationTimeStamp(), and m_CreationTimeStamp.

Here is the call graph for this function:

DurationType FREE::TimeStampedObject::GetInterimDurationTo

(

const TimeStampedObject &

object

)

const

Calcuates the Duration between the closing of this and the creation of the passed object.

Parameters:

[in]

object

Reference to a time stamped object for duration calculation

Returns:

Duration of the time span between this closing and the creation of the passed object.

Definition at line 43 of file freTimeStampedObject.cxx.

References GetCreationTimeStamp(), and m_ClosingTimeStamp.

Here is the call graph for this function:

DurationType FREE::TimeStampedObject::GetDuration

(

)

const

Calcuates the Duration between the creating and the closing of itself.

Returns:

Duration of the time span between creation and closing.

Definition at line 51 of file freTimeStampedObject.cxx.

References m_ClosingTimeStamp, and m_CreationTimeStamp.

TimeStampedObject & FREE::TimeStampedObject::operator=

(

const TimeStampedObject &

object

)

Assignment operator.

Definition at line 59 of file freTimeStampedObject.cxx.

References m_ClosingTimeStamp, m_CreationTimeStamp, and m_StampOffset.

Referenced by FREE::StatisticEntry::operator=().

const TimeStampType & FREE::TimeStampedObject::GetCreationTimeStamp

(

)

const

Returns the creation time stamp

Definition at line 90 of file freTimeStampedObject.cxx.

References m_CreationTimeStamp.

Referenced by GetDurationTo(), and GetInterimDurationTo().

const TimeStampType & FREE::TimeStampedObject::GetClosingTimeStamp

(

)

const

Returns the closing time stamp

Definition at line 97 of file freTimeStampedObject.cxx.

References m_ClosingTimeStamp.

void FREE::TimeStampedObject::SetCreationTimeStamp

(

)

[inline]

Sets the creation time stamp to now

Definition at line 82 of file freTimeStampedObject.h.

References m_CreationTimeStamp, m_StampOffset, and Stamp().

Here is the call graph for this function:

void FREE::TimeStampedObject::SetCreationTimeStamp

(

const TimeStampType &

timeStamp

)

[inline]

Sets the creation time stamp to the passed timestamp.

Definition at line 87 of file freTimeStampedObject.h.

References m_CreationTimeStamp.

void FREE::TimeStampedObject::SetClosingTimeStamp

(

)

[inline]

Sets the closing time stamp of the object to now

Definition at line 93 of file freTimeStampedObject.h.

References m_ClosingTimeStamp, m_StampOffset, and Stamp().

Referenced by FREE::StatisticEntry::CloseEntry().

Here is the call graph for this function:

void FREE::TimeStampedObject::SetClosingTimeStamp

(

const TimeStampType &

timeStamp

)

[inline]

Sets the closing time stamp of the object to the passed timestamp.

Definition at line 98 of file freTimeStampedObject.h.

References m_ClosingTimeStamp.

const bool FREE::TimeStampedObject::IsClosed

(

)

const

Definition at line 111 of file freTimeStampedObject.cxx.

References m_ClosingTimeStamp.

Referenced by FREE::StatisticEntry::CloseEntry(), FREE::StatisticEntry::CreateChildEntry(), and FREE::StatisticEntry::PostCreateChildEntry().

const bool FREE::TimeStampedObject::IsCreated

(

)

const

Definition at line 118 of file freTimeStampedObject.cxx.

References m_CreationTimeStamp.

void FREE::TimeStampedObject::Reset

(

)

[virtual]

Resets by reseting the time stamp.

Reimplemented from FREE::XMLStreamObject.

Reimplemented in FREE::StatisticEntry.

Definition at line 125 of file freTimeStampedObject.cxx.

References m_ClosingTimeStamp, m_CreationTimeStamp, and FREE::XMLStreamObject::Reset().

Referenced by FREE::StatisticEntry::Reset(), and TimeStampedObject().

Here is the call graph for this function:

void FREE::TimeStampedObject::AttributesLoadProcessing

(

const AttributesType &

rAttributes

)

[protected, virtual]

Reimplemented in FREE::StatisticEntry.

Definition at line 134 of file freTimeStampedObject.cxx.

References m_ClosingTimeStamp, m_CreationTimeStamp, and FREE::Convert::ToLong().

Referenced by FREE::StatisticEntry::AttributesLoadProcessing().

Here is the call graph for this function:

void FREE::TimeStampedObject::SaveAttributes

(

AttributesSaveListType &

rAttributes

)

const [protected, virtual]

Reimplemented in FREE::StatisticEntry.

Definition at line 145 of file freTimeStampedObject.cxx.

References m_ClosingTimeStamp, m_CreationTimeStamp, and FREE::Convert::ToStr().

Referenced by FREE::StatisticEntry::SaveAttributes().

Here is the call graph for this function:

clock_t & FREE::TimeStampedObject::GetStampOffset

(

)

const [protected]

Definition at line 104 of file freTimeStampedObject.cxx.

References m_StampOffset.

void FREE::TimeStampedObject::Stamp	(	TimeStampType &	rTimeStamp,
		clock_t &	stampOffset
	)			[static, private]

Definition at line 153 of file freTimeStampedObject.cxx.

Referenced by SetClosingTimeStamp(), and SetCreationTimeStamp().

---

Member Data Documentation

TimeStampType FREE::TimeStampedObject::m_CreationTimeStamp [private]

Timestamp of the moment of creation. -1 indicates that it is not set yet

Definition at line 125 of file freTimeStampedObject.h.

Referenced by AttributesLoadProcessing(), GetCreationTimeStamp(), GetDuration(), GetDurationTo(), IsCreated(), operator=(), Reset(), SaveAttributes(), and SetCreationTimeStamp().

TimeStampType FREE::TimeStampedObject::m_ClosingTimeStamp [private]

Timestamp of the moment the object is regarded as closed. -1 indicates that it is not set yet

Definition at line 128 of file freTimeStampedObject.h.

Referenced by AttributesLoadProcessing(), GetClosingTimeStamp(), GetDuration(), GetInterimDurationTo(), IsClosed(), operator=(), Reset(), SaveAttributes(), and SetClosingTimeStamp().

clock_t& FREE::TimeStampedObject::m_StampOffset [private]

Offset information to adjust the time stamp creation

Definition at line 131 of file freTimeStampedObject.h.

Referenced by GetStampOffset(), operator=(), SetClosingTimeStamp(), and SetCreationTimeStamp().

---

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

• freTimeStampedObject.h
• freTimeStampedObject.cxx

---