MAK RTIspy API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtFedAmbWrapperChain Class Reference

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

+ Collaboration diagram for DtFedAmbWrapperChain:

Public Member Functions

 DtFedAmbWrapperChain ()
 
virtual ~DtFedAmbWrapperChain ()
 
virtual void init (RTI::FederateAmbassador *theBase)
 Initialize the chain for the given federate ambassador. More...
 
virtual void reset ()
 Reset the chain to empty. More...
 
virtual RTI::FederateAmbassador * first () const
 Return the first federate ambassador in the chain. More...
 
virtual void addWrapper (MAKRti::DtString const &name, DtFedAmbWrapper *fedWrap)
 Add/Remove a wrapper to the chain. More...
 
virtual DtFedAmbWrapperremoveWrapper (MAKRti::DtString const &name)
 
virtual bool addWrapperAtFront (MAKRti::DtString const &name, DtFedAmbWrapper *fedWrap)
 Add wrapper at the front of the chain. More...
 

Protected Attributes

RTI::FederateAmbassador * myBase
 
RTI::FederateAmbassador * myFirst
 
MAKRti::DtHashList myWrappers
 
bool myFrontTaken
 Has the front of the fedAmb Chain been reserved / taken? More...
 

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 ( )
virtual DtFedAmbWrapperChain::~DtFedAmbWrapperChain ( )
virtual

Member Function Documentation

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

Add/Remove a wrapper to the chain.

virtual 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.

RTI::FederateAmbassador * DtFedAmbWrapperChain::first ( ) const
inlinevirtual

Return the first federate ambassador in the chain.

References myFirst.

virtual void DtFedAmbWrapperChain::init ( RTI::FederateAmbassador *  theBase)
virtual

Initialize the chain for the given federate ambassador.

virtual DtFedAmbWrapper* DtFedAmbWrapperChain::removeWrapper ( MAKRti::DtString const &  name)
virtual
virtual void DtFedAmbWrapperChain::reset ( )
virtual

Reset the chain to empty.

Member Data Documentation

RTI::FederateAmbassador* DtFedAmbWrapperChain::myBase
protected
RTI::FederateAmbassador* DtFedAmbWrapperChain::myFirst
protected

Referenced by first().

bool DtFedAmbWrapperChain::myFrontTaken
protected

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

MAKRti::DtHashList DtFedAmbWrapperChain::myWrappers
protected

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

Document ID: Generated on Mon Sep 7 15:40:32 EDT 2020 from SVN revision 217499
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)