Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
igtl::TimeStamp Class Reference

#include <igtlTimeStamp.h>

Inheritance diagram for igtl::TimeStamp:
Inheritance graph
[legend]
Collaboration diagram for igtl::TimeStamp:
Collaboration graph
[legend]

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef TimeStamp Self
 
typedef Object Superclass
 

Public Member Functions

virtual LightObject::Pointer CreateAnother () const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
virtual void Delete ()
 
bool GetDebug () const
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void GetTime ()
 
double GetTimeStamp ()
 
void GetTimeStamp (igtlUint32 *second, igtlUint32 *nanosecond)
 
igtlUint64 GetTimeStampInNanoseconds () const
 
igtlUint64 GetTimeStampUint64 ()
 
 igtlGetConstMacro (Frequency, igtlUint32)
 
 igtlGetConstMacro (Nanosecond, igtlUint32)
 
 igtlGetConstMacro (Second, igtlUint32)
 
 igtlNewMacro (Self)
 
 igtlTypeMacro (Object, LightObject)
 
 igtlTypeMacro (TimeStamp, Object)
 
void Print (std::ostream &os) const
 
virtual void Register () const
 
void SetDebug (bool debugFlag) const
 
virtual void SetReferenceCount (int)
 
void SetTime (double tm)
 
void SetTime (igtlUint32 second, igtlUint32 nanosecond)
 
void SetTime (igtlUint64 tm)
 
void SetTimeInNanoseconds (igtlUint64 tm)
 
virtual void UnRegister () const
 

Static Public Member Functions

static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

virtual void PrintSelf (std::ostream &os) const
 
 TimeStamp ()
 
virtual ~TimeStamp ()
 
virtual void PrintHeader (std::ostream &os) const
 
virtual void PrintTrailer (std::ostream &os) const
 
volatile int m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Detailed Description

Definition at line 30 of file igtlTimeStamp.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 36 of file igtlTimeStamp.h.

◆ Pointer

Definition at line 35 of file igtlTimeStamp.h.

◆ Self

Definition at line 33 of file igtlTimeStamp.h.

◆ Superclass

Definition at line 34 of file igtlTimeStamp.h.

Constructor & Destructor Documentation

◆ TimeStamp()

igtl::TimeStamp::TimeStamp ( )
protected

constructor

◆ ~TimeStamp()

virtual igtl::TimeStamp::~TimeStamp ( )
protectedvirtual

destructor

Member Function Documentation

◆ BreakOnError()

static void igtl::LightObject::BreakOnError ( )
staticinherited

This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.

◆ CreateAnother()

virtual LightObject::Pointer igtl::Object::CreateAnother ( ) const
virtualinherited

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 igtl::LightObject.

◆ DebugOff()

virtual void igtl::Object::DebugOff ( ) const
virtualinherited

Turn debugging output off.

◆ DebugOn()

virtual void igtl::Object::DebugOn ( ) const
virtualinherited

Turn debugging output on.

◆ Delete()

virtual void igtl::LightObject::Delete ( )
virtualinherited

Delete an igtl object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

◆ GetDebug()

bool igtl::Object::GetDebug ( ) const
inherited

Get the value of the debug flag.

◆ GetGlobalWarningDisplay()

static bool igtl::Object::GetGlobalWarningDisplay ( )
staticinherited

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.

◆ GetNameOfClass()

virtual const char* igtl::LightObject::GetNameOfClass ( ) const
inlinevirtualinherited

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.

Definition at line 84 of file igtlLightObject.h.

◆ GetReferenceCount()

virtual int igtl::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 110 of file igtlLightObject.h.

◆ GetTime()

void igtl::TimeStamp::GetTime ( )

Gets the current time from the system's clock and save it as a time stamp.

◆ GetTimeStamp() [1/2]

double igtl::TimeStamp::GetTimeStamp ( )

Gets the time stamp. Returns a double floating-point value.

◆ GetTimeStamp() [2/2]

void igtl::TimeStamp::GetTimeStamp ( igtlUint32 *  second,
igtlUint32 *  nanosecond 
)

Gets the time stamp. The second and nanosecond parts are stored in 'second' and 'nanosecond'.

◆ GetTimeStampInNanoseconds()

igtlUint64 igtl::TimeStamp::GetTimeStampInNanoseconds ( ) const

Gets the time in nano-seconds since the start of time (Unix Epoch = 1 Jan 1970). Note: This is deliberately different to GetTimeStampUint64();

◆ GetTimeStampUint64()

igtlUint64 igtl::TimeStamp::GetTimeStampUint64 ( )

Gets the time stamp. Returns a 64-bit fixed-point expression used in OpenIGTLink.

◆ GlobalWarningDisplayOff()

static void igtl::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited

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.

Definition at line 116 of file igtlObject.h.

References igtl::Object::SetGlobalWarningDisplay().

◆ GlobalWarningDisplayOn()

static void igtl::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

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.

Definition at line 114 of file igtlObject.h.

References igtl::Object::SetGlobalWarningDisplay().

◆ igtlGetConstMacro() [1/3]

igtl::TimeStamp::igtlGetConstMacro ( Frequency  ,
igtlUint32   
)

Gets the frequency of a clock.

◆ igtlGetConstMacro() [2/3]

igtl::TimeStamp::igtlGetConstMacro ( Nanosecond  ,
igtlUint32   
)

Gets the fraction of second part of the time stamp.

◆ igtlGetConstMacro() [3/3]

igtl::TimeStamp::igtlGetConstMacro ( Second  ,
igtlUint32   
)

Gets the second part of the time stamp.

◆ igtlNewMacro()

igtl::TimeStamp::igtlNewMacro ( Self  )

◆ igtlTypeMacro() [1/2]

igtl::Object::igtlTypeMacro ( Object  ,
LightObject   
)
inherited

Standard part of all igtl objects.

◆ igtlTypeMacro() [2/2]

igtl::TimeStamp::igtlTypeMacro ( TimeStamp  ,
Object   
)

◆ New()

static Pointer igtl::Object::New ( )
staticinherited

Method for creation through the object factory.

◆ Print()

void igtl::LightObject::Print ( std::ostream &  os) const
inherited

Cause the object to print itself out.

◆ PrintHeader()

virtual void igtl::LightObject::PrintHeader ( std::ostream &  os) const
protectedvirtualinherited

Number of uses of this object by other objects.

◆ PrintSelf()

virtual void igtl::TimeStamp::PrintSelf ( std::ostream &  os) const
protectedvirtual

Print the object information in a stream.

Reimplemented from igtl::Object.

◆ PrintTrailer()

virtual void igtl::LightObject::PrintTrailer ( std::ostream &  os) const
protectedvirtualinherited

Number of uses of this object by other objects.

◆ Register()

virtual void igtl::Object::Register ( ) const
virtualinherited

Return this objects modified time.
Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Increase the reference count (mark as used by another object).

Reimplemented from igtl::LightObject.

◆ SetDebug()

void igtl::Object::SetDebug ( bool  debugFlag) const
inherited

Set the value of the debug flag. A non-zero value turns debugging on.

◆ SetGlobalWarningDisplay()

static void igtl::Object::SetGlobalWarningDisplay ( bool  flag)
staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by igtl::Object::GlobalWarningDisplayOff(), and igtl::Object::GlobalWarningDisplayOn().

◆ SetReferenceCount()

virtual void igtl::Object::SetReferenceCount ( int  )
virtualinherited

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

◆ SetTime() [1/3]

void igtl::TimeStamp::SetTime ( double  tm)

Sets the time by double floating-point value.

◆ SetTime() [2/3]

void igtl::TimeStamp::SetTime ( igtlUint32  second,
igtlUint32  nanosecond 
)

Sets the time by second and nanosecond.

◆ SetTime() [3/3]

void igtl::TimeStamp::SetTime ( igtlUint64  tm)

Sets the time by using 64-bit fixed-point expression used in OpenIGTLink.

◆ SetTimeInNanoseconds()

void igtl::TimeStamp::SetTimeInNanoseconds ( igtlUint64  tm)

Sets the time using the total number of nano-seconds since the start of time (Unix Epoch = 1 Jan 1970). Note: This is deliberately different to SetTime();

◆ UnRegister()

virtual void igtl::Object::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

Reimplemented from igtl::LightObject.

Member Data Documentation

◆ m_ReferenceCount

volatile int igtl::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 131 of file igtlLightObject.h.

◆ m_ReferenceCountLock

SimpleFastMutexLock igtl::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 134 of file igtlLightObject.h.


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

Generated for OpenIGTLink by Doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2012