MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
MAKLogger::DtLgrClock Class Referenceabstract

A clock that provides current time via a time provider. More...

+ Inheritance diagram for MAKLogger::DtLgrClock:
+ Collaboration diagram for MAKLogger::DtLgrClock:

Public Member Functions

 DtLgrClock (DtTimeProvider *timeProvider)
 Constructor timeProvider - a pointer (owned by someone else) of the DtTime Provider class. More...
 
virtual ~DtLgrClock ()
 Destructor. More...
 
virtual void tick ()=0
 Tick the clock which increments the time. More...
 
virtual DtAbsoluteTime currentTime () const =0
 Gets the current time. More...
 
virtual void setCurrentTime (const DtAbsoluteTime &newTime)=0
 Sets the internal current time. More...
 
virtual void stop ()=0
 Stop and reset the clock to 0.0. More...
 
virtual void pause ()=0
 Pause the clock, time will not advance while paused even when ticked. More...
 
virtual void unpause ()=0
 Unpause the clock, resume clock advancement. More...
 
virtual void setTimeProvider (DtTimeProvider *timeProvider)
 Set the time provider. More...
 
virtual const DtTimeProvidertimeProvider () const
 Get the time provider. More...
 

Protected Member Functions

virtual DtTimeProvidertimeProvider ()
 Get the time provider. More...
 

Protected Attributes

DtTimeProvidermyTimeProvider
 

Detailed Description

A clock that provides current time via a time provider.

Constructor & Destructor Documentation

MAKLogger::DtLgrClock::DtLgrClock ( DtTimeProvider timeProvider)

Constructor timeProvider - a pointer (owned by someone else) of the DtTime Provider class.

This class does not take ownership of this provider, it only uses it.

virtual MAKLogger::DtLgrClock::~DtLgrClock ( )
virtual

Destructor.

Member Function Documentation

virtual DtAbsoluteTime MAKLogger::DtLgrClock::currentTime ( ) const
pure virtual

Gets the current time.

Implemented in MAKLogger::DtLgrTimeSteppedClock, and MAKLogger::DtLgrContinuousClock.

virtual void MAKLogger::DtLgrClock::pause ( )
pure virtual

Pause the clock, time will not advance while paused even when ticked.

Implemented in MAKLogger::DtLgrTimeSteppedClock, and MAKLogger::DtLgrContinuousClock.

virtual void MAKLogger::DtLgrClock::setCurrentTime ( const DtAbsoluteTime newTime)
pure virtual

Sets the internal current time.

Implemented in MAKLogger::DtLgrTimeSteppedClock, and MAKLogger::DtLgrContinuousClock.

virtual void MAKLogger::DtLgrClock::setTimeProvider ( DtTimeProvider timeProvider)
virtual

Set the time provider.

This class does not take ownership of this pointer, and only uses it.

Reimplemented in MAKLogger::DtLgrContinuousClock.

virtual void MAKLogger::DtLgrClock::stop ( )
pure virtual

Stop and reset the clock to 0.0.

Implemented in MAKLogger::DtLgrTimeSteppedClock, and MAKLogger::DtLgrContinuousClock.

virtual void MAKLogger::DtLgrClock::tick ( )
pure virtual

Tick the clock which increments the time.

Implemented in MAKLogger::DtLgrTimeSteppedClock, and MAKLogger::DtLgrContinuousClock.

virtual const DtTimeProvider* MAKLogger::DtLgrClock::timeProvider ( ) const
virtual

Get the time provider.

virtual DtTimeProvider* MAKLogger::DtLgrClock::timeProvider ( )
protectedvirtual

Get the time provider.

virtual void MAKLogger::DtLgrClock::unpause ( )
pure virtual

Unpause the clock, resume clock advancement.

Implemented in MAKLogger::DtLgrTimeSteppedClock, and MAKLogger::DtLgrContinuousClock.

Member Data Documentation

DtTimeProvider* MAKLogger::DtLgrClock::myTimeProvider
protected

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

Document ID: Generated on Thu Dec 18 15:35:09 EST 2025 from SVN revision 282494
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)