DtPeriodicTimer Class Reference

Inheritance diagram for DtPeriodicTimer:

Public Member Functions
	DtPeriodicTimer (const DtSimManager *clock, const unsigned int type, const DtTime period, const DtTimerCallbackFcn callback, void *usr, bool periodIsRealTime=false)
virtual	~DtPeriodicTimer ()
virtual void	fire ()
virtual bool	periodIsRealTime () const override
Public Member Functions inherited from DtTimer
	DtTimer (const unsigned int type, const DtTime fireTime, const DtTimerCallbackFcn callback, void *usr)
	DtTimer (const DtTimer &orig)
DtTimer &	operator= (const DtTimer &orig)
virtual	~DtTimer ()
virtual bool	tick (const DtTime simTime)
virtual void	reset (const DtTime fireTime)
virtual void	cancel ()
virtual bool	fired () const
virtual DtTime	fireTime () const
virtual unsigned int	timerType () const
virtual void *	usrData ()
virtual bool	cancelled () const
virtual void	setResortPending ()
virtual void	clearResortPending ()
virtual bool	resortPending () const
virtual void	setDeleteAfterFire ()
virtual void	clearDeleteAfterFire ()
virtual bool	deleteAfterFire () const
virtual bool	managed () const
virtual void	setScheduler (DtScheduler *scheduler)

Protected Member Functions
DtPeriodicTimer &	operator= (const DtPeriodicTimer &orig)

Protected Attributes
const DtTime	myPeriod
const DtSimManager *	myClock
bool	myPeriodIsRealTime
Protected Attributes inherited from DtTimer
DtScheduler *	myScheduler
const DtTimerCallbackFcn	myCallback
const unsigned int	myType
void *	myUsrData
bool	myFired
bool	myDeleteAfterFire
bool	myCancelled
DtTime	myFireTime
bool	myResortPending

Constructor & Destructor Documentation

DtPeriodicTimer::DtPeriodicTimer	(	const DtSimManager *	clock,
		const unsigned int	type,
		const DtTime	period,
		const DtTimerCallbackFcn	callback,
		void *	usr,
		bool	periodIsRealTime = false
	)

The usr pointer points to some user-specified data that will be passed into the given callback when the timer fires. The usr pointer is owned by the caller (who is therefore responsible for destroying it) and it should not be modified by this class in any way.

virtual DtPeriodicTimer::~DtPeriodicTimer ( )

virtual

Member Function Documentation

DtPeriodicTimer& DtPeriodicTimer::operator= ( const DtPeriodicTimer &  orig )

protected

not defined

virtual void DtPeriodicTimer::fire ( )

virtual

Sets off (fires) the timer. Sets the fired state to true. If a callback exists, invokes the callback. If myScheduler has been set, calls scheduler's reSort() member passing in this object as the argument.

Reimplemented from DtTimer.

virtual bool DtPeriodicTimer::periodIsRealTime ( ) const

inlineoverridevirtual

Whether or not to measure period in real time (vs. sim time). Default is false.

Reimplemented from DtTimer.

Member Data Documentation

const DtTime DtPeriodicTimer::myPeriod

protected

const DtSimManager* DtPeriodicTimer::myClock

protected

bool DtPeriodicTimer::myPeriodIsRealTime

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfcore/periodicTimer.h