MAKLogger::DtLgrClock Class Reference

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.
virtual	~DtLgrClock ()
	Destructor.
virtual void	tick ()=0
	Tick the clock which increments the time.
virtual DtAbsoluteTime	currentTime () const =0
	Gets the current time.
virtual void	setCurrentTime (const DtAbsoluteTime &newTime)=0
	Sets the internal current time.
virtual void	stop ()=0
	Stop and reset the clock to 0.0.
virtual void	pause ()=0
	Pause the clock, time will not advance while paused even when ticked.
virtual void	unpause ()=0
	Unpause the clock, resume clock advancement.
virtual void	setTimeProvider (DtTimeProvider *timeProvider)
	Set the time provider.
virtual const DtTimeProvider *	timeProvider () const
	Get the time provider.

Protected Member Functions
virtual DtTimeProvider *	timeProvider ()
	Get the time provider.

Protected Attributes
DtTimeProvider *	myTimeProvider

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:

• lgrClock.h