MAK RTIspy API Documentation for HLA 1.3
Public Member Functions | Static Public Member Functions | Private Member Functions
DtSimpleFederateMgr Class Reference

Instances of DtSimpleFederateMgr process federation-level messages (such as create, destroy, join, resign, and sync points) for LRCs that are communicating peer to peer. More...

+ Inheritance diagram for DtSimpleFederateMgr:
+ Collaboration diagram for DtSimpleFederateMgr:

List of all members.

Public Member Functions

 DtSimpleFederateMgr (DtRIDParameters *params, DtRtiAmbassadorBaseImplementor *ambImplPtr, DtConnectionMgr *connMgr, DtBoost::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
 Constructor.
virtual ~DtSimpleFederateMgr ()
 Destructor.
virtual void testSaveProgress ()
 Test if save/restore in progress.
CreateDestoryJoinServices

Handle the create/destroy and join/resign services

virtual void createFederationExecution (const char *executionName, const char *timeImplName, const char *fed)
 Process the create federation execution service.
virtual void destroyFederationExecution (const char *executionName)
 Process the destroy federation execution service.
virtual RTI::FederateHandle joinFederationExecution (const char *federateType, const char *executionName, RTI::FederateAmbassador *federateAmbassadorReference, unsigned long flags)
 Process the join federation execution service.
virtual void resignFederationExecution (RTI::ResignAction theAction)
 Process the resign federation execution service.
SynchronizationPointServices

Handle the synchronization point services

virtual void registerFederationSynchronizationPoint (char const *label, char const *theTag)
 Process the register synchronization point service.
virtual void registerFederationSynchronizationPoint (char const *label, char const *theTag, DtFederateHandleSet const &syncSet)
 Process the register synchronization point service.
virtual void synchronizationPointAchieved (const char *label, bool successfully=true)
 Process the synchronization point achieved service.
SaveRestoreServices

Process the save and restore services

virtual void requestFederationSave (char const *label, RTI::FedTime const *time=NULL)
 Process request federation save.
virtual void federateSaveBegun ()
 Process federate save begun.
virtual void federateSaveComplete ()
 Process federate save complete.
virtual void federateSaveNotComplete ()
 Process federate save complete.
virtual void requestFederationRestore (const char *label)
 Process request federation restore.
virtual void federateRestoreComplete ()
 Process federate restore complete.
virtual void federateRestoreNotComplete ()
 Process federate restore complete.

Static Public Member Functions

static DtFederateMgrcreate (DtRIDParameters *params, DtRtiAmbassadorBaseImplementor *ambImplPtr, DtConnectionMgr *connMgr, DtBoost::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
 Creates an instance of this derived class;.

Private Member Functions

 DtSimpleFederateMgr (DtFederateMgr const &)
 Copy Constructor not implemented -- Copy Not Allowed!
DtSimpleFederateMgroperator= (DtSimpleFederateMgr const &)
 Assignment not implemented -- Assignment Not Allowed!

Detailed Description

Instances of DtSimpleFederateMgr process federation-level messages (such as create, destroy, join, resign, and sync points) for LRCs that are communicating peer to peer.

It also manages the objects responsible for handling general communication, objects, interactions, the FOM, MOM, and data distribution mmg. Override this class if you want to change how federation-level messages get processed. To inspect federation data, users can obtain a pointer to an instance of this class through the RTI's DtRtiAmbassadorImplementor instance.


Constructor & Destructor Documentation

DtSimpleFederateMgr::DtSimpleFederateMgr ( DtRIDParameters params,
DtRtiAmbassadorBaseImplementor ambImplPtr,
DtConnectionMgr connMgr,
DtBoost::shared_ptr< DtRtiAssistantLrcClient assistantClient 
)

Constructor.

Referenced by create().

Destructor.

Copy Constructor not implemented -- Copy Not Allowed!


Member Function Documentation

DtFederateMgr * DtSimpleFederateMgr::create ( DtRIDParameters params,
DtRtiAmbassadorBaseImplementor ambImplPtr,
DtConnectionMgr connMgr,
DtBoost::shared_ptr< DtRtiAssistantLrcClient assistantClient 
) [static]

Creates an instance of this derived class;.

Reimplemented from DtFederateMgr.

References DtSimpleFederateMgr().

Referenced by DtRtiAmbassadorBaseImplementor::completeConnection().

void DtSimpleFederateMgr::createFederationExecution ( const char *  executionName,
const char *  timeImplName,
const char *  fed 
) [virtual]

Process the create federation execution service.

Implements DtFederateMgr.

void DtSimpleFederateMgr::destroyFederationExecution ( const char *  executionName) [virtual]

Process the destroy federation execution service.

Implements DtFederateMgr.

Process federate restore complete.

Implements DtFederateMgr.

Process federate restore complete.

Implements DtFederateMgr.

Process federate save begun.

Implements DtFederateMgr.

Process federate save complete.

Implements DtFederateMgr.

Process federate save complete.

Implements DtFederateMgr.

RTI::FederateHandle DtSimpleFederateMgr::joinFederationExecution ( const char *  federateType,
const char *  executionName,
RTI::FederateAmbassador federateAmbassadorReference,
unsigned long  flags 
) [virtual]
DtSimpleFederateMgr& DtSimpleFederateMgr::operator= ( DtSimpleFederateMgr const &  ) [private]

Assignment not implemented -- Assignment Not Allowed!

void DtSimpleFederateMgr::registerFederationSynchronizationPoint ( char const *  label,
char const *  theTag 
) [virtual]

Process the register synchronization point service.

Implements DtFederateMgr.

void DtSimpleFederateMgr::registerFederationSynchronizationPoint ( char const *  label,
char const *  theTag,
DtFederateHandleSet const &  syncSet 
) [virtual]

Process the register synchronization point service.

Implements DtFederateMgr.

void DtSimpleFederateMgr::requestFederationRestore ( const char *  label) [virtual]

Process request federation restore.

Implements DtFederateMgr.

void DtSimpleFederateMgr::requestFederationSave ( char const *  label,
RTI::FedTime const *  time = NULL 
) [virtual]

Process request federation save.

Implements DtFederateMgr.

Process the resign federation execution service.

Reimplemented from DtFederateMgr.

References DtFederateMgr::resignFederationExecution().

void DtSimpleFederateMgr::synchronizationPointAchieved ( const char *  label,
bool  successfully = true 
) [virtual]

Process the synchronization point achieved service.

Implements DtFederateMgr.

Test if save/restore in progress.

Implements DtFederateMgr.


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)