DtFedAmbWrapperChain Class Reference

Instances of DtFedAmbWrapperChain store a linked list of DtFedAmbWrappers. More...

Collaboration diagram for DtFedAmbWrapperChain:

List of all members.

Public Member Functions
	DtFedAmbWrapperChain ()
virtual	~DtFedAmbWrapperChain ()
virtual void	init (RTI::FederateAmbassador *theBase)
	Initialize the chain for the given federate ambassador.
virtual void	reset ()
	Reset the chain to empty.
virtual RTI::FederateAmbassador *	first () const
	Return the first federate ambassador in the chain.
virtual void	addWrapper (MAKRti::DtString const &name, DtFedAmbWrapper *fedWrap)
	Add/Remove a wrapper to the chain.
virtual DtFedAmbWrapper *	removeWrapper (MAKRti::DtString const &name)
virtual bool	addWrapperAtFront (MAKRti::DtString const &name, DtFedAmbWrapper *fedWrap)
	Add wrapper at the front of the chain.
Protected Attributes
RTI::FederateAmbassador *	myBase
RTI::FederateAmbassador *	myFirst
MAKRti::DtHashList	myWrappers
bool	myFrontTaken
	Has the front of the fedAmb Chain been reserved / taken?

---

Detailed Description

Instances of DtFedAmbWrapperChain store a linked list of DtFedAmbWrappers.

Whenever the RTI calls a federate service, the corresponding service call for each wrapper in the chain will also get called. The last federate ambassador in the list is always the pointer given to the RTI by the user in 'joinFederationExecution'. To register a DtFedAmbWrapper with the MAK RTI, simply call DtConnectMgr::addFedAmbWrapper()

---

Constructor & Destructor Documentation

DtFedAmbWrapperChain::DtFedAmbWrapperChain

(

)

DtFedAmbWrapperChain::~DtFedAmbWrapperChain

(

)

[virtual]

References myWrappers, and NULL.

---

Member Function Documentation

void DtFedAmbWrapperChain::addWrapper	(	MAKRti::DtString const &	name,
		DtFedAmbWrapper *	fedWrap
	)		[virtual]

Add/Remove a wrapper to the chain.

References myFirst, myFrontTaken, myWrappers, and NULL.

Referenced by DtConnectionMgr::addFedAmbWrapper(), and addWrapperAtFront().

bool DtFedAmbWrapperChain::addWrapperAtFront	(	MAKRti::DtString const &	name,
		DtFedAmbWrapper *	fedWrap
	)		[virtual]

Add wrapper at the front of the chain.

Preserve that position when new wrappers are added. There can be only one wrapper at the front. Returns success.

References addWrapper(), and myFrontTaken.

Referenced by DtConnectionMgr::addFedAmbWrapperAtFront().

RTI::FederateAmbassador * DtFedAmbWrapperChain::first

(

)

const [inline, virtual]

Return the first federate ambassador in the chain.

References myFirst.

void DtFedAmbWrapperChain::init

(

RTI::FederateAmbassador *

theBase

)

[virtual]

Initialize the chain for the given federate ambassador.

Referenced by DtSmConnectionMgr::connectFederation(), DtConnectionMgr::connectFederation(), and removeWrapper().

DtFedAmbWrapper * DtFedAmbWrapperChain::removeWrapper

(

MAKRti::DtString const &

name

)

[virtual]

References init(), myBase, myFirst, myFrontTaken, and myWrappers.

Referenced by DtConnectionMgr::removeFedAmbWrapper().

void DtFedAmbWrapperChain::reset

(

)

[virtual]

Reset the chain to empty.

References myBase, myFirst, and myFrontTaken.

Referenced by DtSmConnectionMgr::disconnectFederation(), DtConnectionMgr::disconnectFederation(), and DtConnectionMgr::~DtConnectionMgr().

---

Member Data Documentation

RTI::FederateAmbassador* DtFedAmbWrapperChain::myBase [protected]

Referenced by removeWrapper(), and reset().

RTI::FederateAmbassador* DtFedAmbWrapperChain::myFirst [protected]

Referenced by addWrapper(), first(), removeWrapper(), and reset().

bool DtFedAmbWrapperChain::myFrontTaken [protected]

Has the front of the fedAmb Chain been reserved / taken?

Referenced by addWrapper(), addWrapperAtFront(), removeWrapper(), and reset().

MAKRti::DtHashList DtFedAmbWrapperChain::myWrappers [protected]

Referenced by addWrapper(), removeWrapper(), and ~DtFedAmbWrapperChain().

---

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

• fedWrapChain.h
• fedWrapChain.cxx