DtBaseExerciseConn Class Reference

DtBaseExerciseConn is an abstract base class. More...

Inheritance diagram for DtBaseExerciseConn:

Collaboration diagram for DtBaseExerciseConn:

Public Member Functions
virtual	~DtBaseExerciseConn ()
	destructor More...
virtual void	send (const DtStateMsg &msg)=0
	Send a state message to the network. More...
virtual void	send (const DtInteraction &msg)=0
	Send an interaction to the network. More...
virtual void	sendStamped (const DtStateMsg &msg)=0
	Send a state message to the network which has been time stamped with the current time. More...
virtual void	sendStamped (const DtInteraction &msg)=0
	Send an interaction to the network which has been time stamped with the current time. More...
virtual void	addPostDrainCallback (DtPostDrainCb cb, void *usr)
	Add/remove callbacks to be executed from within drainInput right before it returns. More...
virtual void	removePostDrainCallback (DtPostDrainCb cb, void *usr)
virtual void	removeAllPostDrainCallbacks ()
virtual void	setClock (DtClock *clock)
	This function allows one to set the exercise connection's clock – overriding the default clock and setting the simulation time to zero. More...
virtual DtClock *	clock ()
	Get reference to exercise connection's clock. More...
virtual int	lastDrainInputReceiveCount () const
virtual void	incrementNumberOfMessagesProcessed ()
	Increments myNumberOfMessagesProcessed. More...
virtual void	setApplicationId (int siteId, int applNum)
	----------------—— ID MANAGEMENT ----------------—— More...
virtual DtSimulationAddress	applicationId ()
virtual const DtEntityIdentifier &	nextId ()
	Returns the next valid entity ID formed by calling makeEntityId with the current value of a entity number counter. More...
virtual DtEntityIdentifier	makeEntityId (int entityNum)
	Returns an entity ID consisting of the DtExerciseConn's site and host numbers, and entityNum as the entity number. More...
virtual void	setIsUpdateRateWarningEnabled (bool value)
	Setter/getter methods for updateRateWArning toggle. More...
virtual bool	isUpdateRateWarningEnabled () const

Protected Member Functions
	DtBaseExerciseConn ()
	Constructors are protected since this is an abstract base class. More...
	DtBaseExerciseConn (const DtBaseExerciseConn &)
	copy constructor – Not implemented More...
DtBaseExerciseConn &	operator= (const DtBaseExerciseConn &)
	Assignment Operator – Not Implemented. More...
virtual void	executePostDrainCbs ()
	Should be called by derived class's drainInputs. More...

Protected Attributes
DtSimulationAddress	myAppId
DtEntityIdentifier	myCurrentId
DtList	myPostDrainCbs
DtClock *	myClock
int	myNumberOfMessagesProcessed
bool	myIsUpdateRateWarningEnabled

Detailed Description

DtBaseExerciseConn is an abstract base class.

It provides an application's interface or connection to a network.

Constructor & Destructor Documentation

virtual DtBaseExerciseConn::~DtBaseExerciseConn ( )

virtual

destructor

DtBaseExerciseConn::DtBaseExerciseConn ( )

protected

Constructors are protected since this is an abstract base class.

default constructor

DtBaseExerciseConn::DtBaseExerciseConn ( const DtBaseExerciseConn &  )

protected

copy constructor – Not implemented

Member Function Documentation

virtual void DtBaseExerciseConn::addPostDrainCallback ( DtPostDrainCb  cb, void *  usr  )

virtual

Add/remove callbacks to be executed from within drainInput right before it returns.

virtual DtSimulationAddress DtBaseExerciseConn::applicationId ( )

virtual

virtual DtClock* DtBaseExerciseConn::clock ( )

virtual

Get reference to exercise connection's clock.

virtual void DtBaseExerciseConn::executePostDrainCbs ( )

protectedvirtual

Should be called by derived class's drainInputs.

virtual void DtBaseExerciseConn::incrementNumberOfMessagesProcessed ( )

virtual

Increments myNumberOfMessagesProcessed.

This is called by the federate ambassador each time it receives an object update.

virtual bool DtBaseExerciseConn::isUpdateRateWarningEnabled ( ) const

virtual

virtual int DtBaseExerciseConn::lastDrainInputReceiveCount ( ) const

virtual

virtual DtEntityIdentifier DtBaseExerciseConn::makeEntityId ( int  entityNum )

virtual

Returns an entity ID consisting of the DtExerciseConn's site and host numbers, and entityNum as the entity number.

virtual const DtEntityIdentifier& DtBaseExerciseConn::nextId ( )

virtual

Returns the next valid entity ID formed by calling makeEntityId with the current value of a entity number counter.

DtBaseExerciseConn& DtBaseExerciseConn::operator= ( const DtBaseExerciseConn &  )

protected

Assignment Operator – Not Implemented.

virtual void DtBaseExerciseConn::removeAllPostDrainCallbacks ( )

virtual

virtual void DtBaseExerciseConn::removePostDrainCallback ( DtPostDrainCb  cb, void *  usr  )

virtual

virtual void DtBaseExerciseConn::send ( const DtStateMsg &  msg )

pure virtual

Send a state message to the network.

Implemented in DtExerciseConn.

virtual void DtBaseExerciseConn::send ( const DtInteraction &  msg )

pure virtual

Send an interaction to the network.

Implemented in DtExerciseConn.

virtual void DtBaseExerciseConn::sendStamped ( const DtStateMsg &  msg )

pure virtual

Send a state message to the network which has been time stamped with the current time.

Implemented in DtExerciseConn.

virtual void DtBaseExerciseConn::sendStamped ( const DtInteraction &  msg )

pure virtual

Send an interaction to the network which has been time stamped with the current time.

Implemented in DtExerciseConn.

virtual void DtBaseExerciseConn::setApplicationId ( int  siteId, int  applNum  )

virtual

----------------—— ID MANAGEMENT ----------------——

Set/get the current application ID (DIS/RPR FOM site Id & host Id (application Id)).

virtual void DtBaseExerciseConn::setClock ( DtClock *  clock )

virtual

This function allows one to set the exercise connection's clock – overriding the default clock and setting the simulation time to zero.

virtual void DtBaseExerciseConn::setIsUpdateRateWarningEnabled ( bool  value )

virtual

Setter/getter methods for updateRateWArning toggle.

Member Data Documentation

DtSimulationAddress DtBaseExerciseConn::myAppId

protected

DtClock* DtBaseExerciseConn::myClock

protected

DtEntityIdentifier DtBaseExerciseConn::myCurrentId

protected

bool DtBaseExerciseConn::myIsUpdateRateWarningEnabled

protected

int DtBaseExerciseConn::myNumberOfMessagesProcessed

protected

DtList DtBaseExerciseConn::myPostDrainCbs

protected

---

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

• baseExerciseConn.h