DtClock Class Reference

Used to set and maintain time in a simulation. More...

Collaboration diagram for DtClock:

Public Member Functions
	DtClock ()
	constructor calls init()
	DtClock (const DtClock &orig)
	copy constructor
DtClock &	operator= (const DtClock &orig)
	assignment operator
virtual	~DtClock ()
	destructor
virtual void	init ()
	Initialize all VR-Link time object functionality.
virtual DtTime	simTime () const
	Get the current value of VR-Link's simulation time.
virtual void	setSimTime (DtTime NewSimTime)
	Set the current value of VR-Link simulation time.
virtual bool	isSimTimeSet () const
	Returns false if DtSetSimTime was never called and prints out warning message.
virtual DtTime	elapsedRealTime () const
	Return real seconds elapsed since DtTimeInit was called.
virtual DtTime	approximateElapsedRealTime () const
	Returns the value of getElapsedRealTime at the time that setSimTime was last invoked.
virtual bool	useSimTimeForApproxRealTime () const
	Check whether myUseSimTimeForApproxRealTime is set.
virtual void	setUseSimTimeForApproxRealTime ()
	Set/Clear whether simTime should be used to approximate the real time for the method approximateElapsedRealTime().
virtual void	clearUseSimTimeForApproxRealTime ()
virtual DtTime	absRealTime () const
	Return current wall-clock time - seconds since Jan 1, 1970.

Static Public Attributes
static const double	hour2sec
	Clock constants used for time conversions.
static const double	sec2hour

Protected Attributes
DtTime	myInitialTime
	Save starting time to subtract from current to get elapsed.
DtTime	mySimTime
	This is the internal vr-link simulation clock.
DtTime	myApproxElapsedRealTime
	This is the Elapsed Real Time at the point that SetSimTime() is called.
bool	mySimTimeSet
bool	myUseSimTimeForApproxRealTime
	Flag to change meaning of approximate real time.

Detailed Description

Used to set and maintain time in a simulation.

Examples

• Talk

Constructor & Destructor Documentation

DtClock::DtClock

(

)

constructor calls init()

DtClock::DtClock

(

const DtClock &

orig

)

copy constructor

virtual DtClock::~DtClock ( )

virtual

destructor

Member Function Documentation

virtual DtTime DtClock::absRealTime ( ) const

virtual

Return current wall-clock time - seconds since Jan 1, 1970.

virtual DtTime DtClock::approximateElapsedRealTime ( ) const

virtual

Returns the value of getElapsedRealTime at the time that setSimTime was last invoked.

virtual void DtClock::clearUseSimTimeForApproxRealTime ( )

virtual

virtual DtTime DtClock::elapsedRealTime ( ) const

virtual

Return real seconds elapsed since DtTimeInit was called.

virtual void DtClock::init ( )

virtual

Initialize all VR-Link time object functionality.

This must be called before any other time-related functions.

virtual bool DtClock::isSimTimeSet ( ) const

virtual

Returns false if DtSetSimTime was never called and prints out warning message.

DtClock& DtClock::operator=

(

const DtClock &

orig

)

assignment operator

virtual void DtClock::setSimTime ( DtTime  NewSimTime )

virtual

Set the current value of VR-Link simulation time.

Should be called once per simulation frame to let VR-Link know the value of simulation time for the frame.

virtual void DtClock::setUseSimTimeForApproxRealTime ( )

virtual

Set/Clear whether simTime should be used to approximate the real time for the method approximateElapsedRealTime().

virtual DtTime DtClock::simTime ( ) const

virtual

Get the current value of VR-Link's simulation time.

virtual bool DtClock::useSimTimeForApproxRealTime ( ) const

virtual

Check whether myUseSimTimeForApproxRealTime is set.

Member Data Documentation

const double DtClock::hour2sec

static

Clock constants used for time conversions.

DtTime DtClock::myApproxElapsedRealTime

protected

This is the Elapsed Real Time at the point that SetSimTime() is called.

It is good enough for timeouts, and is a LOT cheaper than getting the exact real time, which is overkill.

DtTime DtClock::myInitialTime

protected

Save starting time to subtract from current to get elapsed.

DtTime DtClock::mySimTime

protected

This is the internal vr-link simulation clock.

bool DtClock::mySimTimeSet

protected

bool DtClock::myUseSimTimeForApproxRealTime

protected

Flag to change meaning of approximate real time.

const double DtClock::sec2hour

static

---

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

• vlTime.h