itk::RealTimeClock Class Reference

Provides a timestamp from a real-time clock. More...

#include <itkRealTimeClock.h>

Inheritance diagram for itk::RealTimeClock:

Collaboration diagram for itk::RealTimeClock:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef double	FrequencyType
typedef SmartPointer< Self >	Pointer
typedef RealTimeClock	Self
typedef Object	Superclass
typedef double	TimeStampType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual FrequencyType	GetFrequency () const
virtual const char *	GetNameOfClass () const
RealTimeStamp	GetRealTimeStamp () const
TimeStampType	GetTimeInSeconds () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	RealTimeClock ()
virtual	~RealTimeClock ()
Private Member Functions
virtual const TimeStamp &	GetTimeStamp () const
Private Attributes
TimeStampType	m_Difference
FrequencyType	m_Frequency
TimeStampType	m_Origin

---

Detailed Description

Provides a timestamp from a real-time clock.

This class represents a real-time clock object and provides a timestamp in platform-independent format.

Author:

Hee-Su Kim, Compute Science Dept. Kyungpook National University, ISIS Center, Georgetown University.

Definition at line 39 of file itkRealTimeClock.h.

---

Member Typedef Documentation

typedef SmartPointer< const Self > itk::RealTimeClock::ConstPointer

Reimplemented from itk::Object.

Definition at line 45 of file itkRealTimeClock.h.

typedef double itk::RealTimeClock::FrequencyType

Define the type for the frequency of the clock

Definition at line 57 of file itkRealTimeClock.h.

typedef SmartPointer< Self > itk::RealTimeClock::Pointer

Reimplemented from itk::Object.

Definition at line 44 of file itkRealTimeClock.h.

typedef RealTimeClock itk::RealTimeClock::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

Definition at line 42 of file itkRealTimeClock.h.

typedef Object itk::RealTimeClock::Superclass

Reimplemented from itk::Object.

Definition at line 43 of file itkRealTimeClock.h.

typedef double itk::RealTimeClock::TimeStampType

Define the type for the timestap

Definition at line 51 of file itkRealTimeClock.h.

---

Constructor & Destructor Documentation

itk::RealTimeClock::RealTimeClock

(

)

[protected]

constructor

virtual itk::RealTimeClock::~RealTimeClock

(

)

[protected, virtual]

destructor

---

Member Function Documentation

virtual::itk::LightObject::Pointer itk::RealTimeClock::CreateAnother

(

void

)

const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

virtual FrequencyType itk::RealTimeClock::GetFrequency

(

)

const [virtual]

Returns the frequency of a clock

virtual const char* itk::RealTimeClock::GetNameOfClass

(

)

const [virtual]

Method for defining the name of the class

Reimplemented from itk::Object.

RealTimeStamp itk::RealTimeClock::GetRealTimeStamp

(

)

const

Get the time as a RealTimeStamp type.

TimeStampType itk::RealTimeClock::GetTimeInSeconds

(

)

const

Returns a timestamp in seconds e.g. 52.341243 seconds

virtual const TimeStamp& itk::RealTimeClock::GetTimeStamp

(

)

const [private, virtual]

Return this object's time stamp.

Reimplemented from itk::Object.

static Pointer itk::RealTimeClock::New

(

)

[static]

Method for creation through the object factory

Reimplemented from itk::Object.

virtual void itk::RealTimeClock::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Print the object information in a stream.

Reimplemented from itk::Object.

---

Member Data Documentation

TimeStampType itk::RealTimeClock::m_Difference [private]

Definition at line 81 of file itkRealTimeClock.h.

FrequencyType itk::RealTimeClock::m_Frequency [private]

Definition at line 80 of file itkRealTimeClock.h.

TimeStampType itk::RealTimeClock::m_Origin [private]

Definition at line 82 of file itkRealTimeClock.h.

---

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

• itkRealTimeClock.h