MAKLogger::DtLgrTimeSteppedClock Class Reference

A clock which provides time steps via a time provider and with optional scaling. More...

Inheritance diagram for MAKLogger::DtLgrTimeSteppedClock:

Collaboration diagram for MAKLogger::DtLgrTimeSteppedClock:

Public Member Functions
	DtLgrTimeSteppedClock (DtTimeProvider *timeProvider)
	Constructor timeProvider - a pointer (owned by someone else) of the DtTime Provider class. More...
virtual	~DtLgrTimeSteppedClock ()
	Destructor. More...
virtual void	tick ()
	Tick the clock which increments the time. More...
virtual DtAbsoluteTime	currentTime () const
	Gets the current time, this value will not change until tick is called again. More...
virtual void	setCurrentTime (const DtAbsoluteTime &newTime)
	Sets the internal current time. More...
virtual DtAbsoluteTime	pendingTime () const
	Get the pending time - time if provider were ticked now. More...
DtRelativeTime	lastTimeStep () const
	The last change in time between ticks. More...
virtual void	stop ()
	The same as two calls to setCurrentTime( 0.0 ), setTimeScale( 0.0 );. More...
virtual void	pause ()
	The same as a call to setTimeScale( 0.0 );. More...
virtual void	unpause ()
	Unpause the clock. More...
virtual void	setTimeScale (double scaleValue)
	Changes the time scale. More...
virtual double	timeScale () const
	Gets the time scale value. More...
Public Member Functions inherited from MAKLogger::DtLgrClock
	DtLgrClock (DtTimeProvider *timeProvider)
	Constructor timeProvider - a pointer (owned by someone else) of the DtTime Provider class. More...
virtual	~DtLgrClock ()
	Destructor. More...
virtual void	setTimeProvider (DtTimeProvider *timeProvider)
	Set the time provider. More...
virtual const DtTimeProvider *	timeProvider () const
	Get the time provider. More...

Protected Attributes
DtAbsoluteTime	myLastTime
DtAbsoluteTime	myCurrentTime
DtRelativeTime	myLastTimeStep
double	myTimeScale
double	myPausedTimeScale
Protected Attributes inherited from MAKLogger::DtLgrClock
DtTimeProvider *	myTimeProvider

Additional Inherited Members
Protected Member Functions inherited from MAKLogger::DtLgrClock
virtual DtTimeProvider *	timeProvider ()
	Get the time provider. More...

Detailed Description

A clock which provides time steps via a time provider and with optional scaling.

Constructor & Destructor Documentation

MAKLogger::DtLgrTimeSteppedClock::DtLgrTimeSteppedClock

(

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::DtLgrTimeSteppedClock::~DtLgrTimeSteppedClock ( )

virtual

Destructor.

Member Function Documentation

virtual DtAbsoluteTime MAKLogger::DtLgrTimeSteppedClock::currentTime ( ) const

virtual

Gets the current time, this value will not change until tick is called again.

Implements MAKLogger::DtLgrClock.

DtRelativeTime MAKLogger::DtLgrTimeSteppedClock::lastTimeStep

(

)

const

The last change in time between ticks.

virtual void MAKLogger::DtLgrTimeSteppedClock::pause ( )

virtual

The same as a call to setTimeScale( 0.0 );.

Implements MAKLogger::DtLgrClock.

virtual DtAbsoluteTime MAKLogger::DtLgrTimeSteppedClock::pendingTime ( ) const

virtual

Get the pending time - time if provider were ticked now.

virtual void MAKLogger::DtLgrTimeSteppedClock::setCurrentTime ( const DtAbsoluteTime &  newTime )

virtual

Sets the internal current time.

Implements MAKLogger::DtLgrClock.

virtual void MAKLogger::DtLgrTimeSteppedClock::setTimeScale ( double  scaleValue )

virtual

Changes the time scale.

Warning

SetTimeScale internally calls tick before modifying the time scale.

virtual void MAKLogger::DtLgrTimeSteppedClock::stop ( )

virtual

The same as two calls to setCurrentTime( 0.0 ), setTimeScale( 0.0 );.

Implements MAKLogger::DtLgrClock.

virtual void MAKLogger::DtLgrTimeSteppedClock::tick ( )

virtual

Tick the clock which increments the time.

Calculated via currentTime = currentTime + time elapsed * timescale

Implements MAKLogger::DtLgrClock.

virtual double MAKLogger::DtLgrTimeSteppedClock::timeScale ( ) const

virtual

Gets the time scale value.

virtual void MAKLogger::DtLgrTimeSteppedClock::unpause ( )

virtual

Unpause the clock.

Implements MAKLogger::DtLgrClock.

Member Data Documentation

DtAbsoluteTime MAKLogger::DtLgrTimeSteppedClock::myCurrentTime

protected

DtAbsoluteTime MAKLogger::DtLgrTimeSteppedClock::myLastTime

protected

DtRelativeTime MAKLogger::DtLgrTimeSteppedClock::myLastTimeStep

protected

double MAKLogger::DtLgrTimeSteppedClock::myPausedTimeScale

protected

double MAKLogger::DtLgrTimeSteppedClock::myTimeScale

protected

---

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

• lgrClock.h