ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::RealTimeClock Class Reference

#include <itkRealTimeClock.h>

+ Inheritance diagram for itk::RealTimeClock:
+ Collaboration diagram for itk::RealTimeClock:

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.

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

Definition at line 39 of file itkRealTimeClock.h.

Public Types

using ConstPointer = SmartPointer< const Self >
using FrequencyType = double
using Pointer = SmartPointer< Self >
using Self = RealTimeClock
using Superclass = Object
using TimeStampType = double
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
using Pointer = SmartPointer< Self >
using Self = Object
using Superclass = LightObject
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
using Pointer = SmartPointer< Self >
using Self = LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
virtual FrequencyType GetFrequency () const
virtual const char * GetNameOfClass () const
RealTimeStamp GetRealTimeStamp () const
TimeStampType GetTimeInSeconds () const
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary ()
const MetaDataDictionaryGetMetaDataDictionary () const
virtual ModifiedTimeType GetMTime () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
void Register () const override
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetReferenceCount (int) override
void UnRegister () const noexceptoverride
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void SetObjectName (std::string _arg)
virtual const std::string & GetObjectName () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static Pointer New ()
static void SetGlobalWarningDisplay (bool flag)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
static Pointer New ()

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 RealTimeClock ()
 ~RealTimeClock () override
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
 ~Object () override
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

const TimeStampGetTimeStamp () const override

Private Attributes

TimeStampType m_Difference
FrequencyType m_Frequency {1}
TimeStampType m_Origin

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount

Member Typedef Documentation

Definition at line 45 of file itkRealTimeClock.h.

Define the type for the frequency of the clock

Definition at line 57 of file itkRealTimeClock.h.

Definition at line 44 of file itkRealTimeClock.h.

Definition at line 42 of file itkRealTimeClock.h.

Definition at line 43 of file itkRealTimeClock.h.

Define the type for the timestap

Definition at line 54 of file itkRealTimeClock.h.

Constructor & Destructor Documentation

itk::RealTimeClock::RealTimeClock ( )


itk::RealTimeClock::~RealTimeClock ( )


Member Function Documentation

virtual::itk::LightObject::Pointer itk::RealTimeClock::CreateAnother ( ) const

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

Returns the frequency of a clock

virtual const char* itk::RealTimeClock::GetNameOfClass ( ) const

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

const TimeStamp& itk::RealTimeClock::GetTimeStamp ( ) const

Return this object's time stamp.

Reimplemented from itk::Object.

static Pointer itk::RealTimeClock::New ( )

Method for creation through the object factory

void itk::RealTimeClock::PrintSelf ( std::ostream &  os,
Indent  indent 
) const

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

Member Data Documentation

TimeStampType itk::RealTimeClock::m_Difference

Definition at line 80 of file itkRealTimeClock.h.

FrequencyType itk::RealTimeClock::m_Frequency {1}

Definition at line 79 of file itkRealTimeClock.h.

TimeStampType itk::RealTimeClock::m_Origin

Definition at line 81 of file itkRealTimeClock.h.

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