DtDetonationTimerData Class Reference

DtDetonationTimerData; Container holding a detonation interaction and user data. More...

Public Member Functions
	DtDetonationTimerData ()
	constructor More...
	DtDetonationTimerData (const DtDetonationTimerData &orig)
	copy constructor More...
const DtDetonationTimerData &	operator= (const DtDetonationTimerData &orig)
	assignment operator More...
virtual	~DtDetonationTimerData ()
	destructor - destroys myDetonation More...
virtual void *	userData () const
virtual void	setUserData (void *userData)
virtual DtDetonationInteraction *	detonation () const
	Accessor/mutator for myDetonation. More...
virtual void	setDetonation (DtDetonationInteraction *detonation)

Protected Attributes
void *	myUserData
DtDetonationInteraction *	myDetonation

Detailed Description

DtDetonationTimerData; Container holding a detonation interaction and user data.

DtDetonationTimerData contains a pointer to a detonation interaction and a usr data ptr (usually the 'this' ptr of the instance registering the detonation) to use as user data for a timer. Generally this class is used when a detonation interaction needs to be scheduled for a later time. To make it easier for users of this class to "hand-off" their detonations, this class assumes ownership of the pointers, and will garbage collect them in its destructor.

Constructor & Destructor Documentation

DtDetonationTimerData::DtDetonationTimerData

(

)

constructor

DtDetonationTimerData::DtDetonationTimerData

(

const DtDetonationTimerData &

orig

)

copy constructor

virtual DtDetonationTimerData::~DtDetonationTimerData ( )

virtual

destructor - destroys myDetonation

Member Function Documentation

const DtDetonationTimerData& DtDetonationTimerData::operator=

(

const DtDetonationTimerData &

orig

)

assignment operator

virtual DtDetonationInteraction* DtDetonationTimerData::detonation ( ) const

virtual

Accessor/mutator for myDetonation.

DtDetonationTimerData will assume ownership of this pointer and it will be garbage collected in the destructor.

virtual void DtDetonationTimerData::setDetonation ( DtDetonationInteraction *  detonation )

virtual

virtual void* DtDetonationTimerData::userData ( ) const

virtual

virtual void DtDetonationTimerData::setUserData ( void *  userData )

virtual

Member Data Documentation

void* DtDetonationTimerData::myUserData

protected

DtDetonationInteraction* DtDetonationTimerData::myDetonation

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfmodel/detonationTimerData.h