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

Instances of DtPartnerMgr process partner messages to establish federate partners in an unlicensed federation execution. More...

+ Collaboration diagram for DtPartnerMgr:

Public Member Functions

 DtPartnerMgr (DtConnectionMgr *connectMgr)
 Constructor. More...
 
 ~DtPartnerMgr ()
 Destructor. More...
 
virtual void joinFederationExecution (const char *federateType, const char *executionName, const char *federateName, unsigned long flags)
 Start up partner management. More...
 
virtual void resign ()
 Shut down partner management. More...
 
virtual bool acceptMessage (const DtRtiMsg &msg)
 Return boolean: message should be accepted? More...
 

Protected Member Functions

virtual void sendJoinMessage (MAKRti::DtString federateType, MAKRti::DtString fedexName, MAKRti::DtString federateName)
 Send a lightweight join message. More...
 
virtual void sendPartnerMessage (DtFederateHandle partnerFederate, DtPartnerResponse response)
 Send a partner response message. More...
 
virtual void processOtherMessage (DtRtiMsg const &msg)
 Process all other messages. More...
 
virtual void processResignMessage (const DtResignMsg &msg)
 Process resign message. More...
 
virtual void processPartnerMessage (const DtPartnerFederateMsg &msg)
 Partner federate message callback. More...
 
virtual void processPartnerAccept (const DtPartnerFederateMsg &msg)
 Process partner federate message callback for accept response. More...
 
virtual void processPartnerConfirm (const DtPartnerFederateMsg &msg)
 Process partner federate message callback for confirm response. More...
 
virtual void processPartnerReject (const DtPartnerFederateMsg &msg)
 Process partner federate message callback for reject response. More...
 
virtual bool partnerSlotAvailable () const
 Return boolean: Is a partner slot available? More...
 
virtual bool waitingForConfirm () const
 Return boolean: Is there any partner that needs to be confirmed? More...
 
virtual bool isPartner (DtFederateHandle federate) const
 Return boolean: Is the given federate a partner? More...
 
virtual bool isPending (DtFederateHandle federate) const
 Return boolean: Is the given federate a pending partner? (false if not a partner or partner but confirmed) More...
 
virtual bool isConfirmed (DtFederateHandle federate) const
 Return boolean: Is the given federate a confirmed partner? (false if not a partner or partner but pending) More...
 
virtual void acceptPartner (DtFederateHandle federate, bool confirmed=false)
 Accept the given federate as a partner. Partner may either be pending or confirmed. More...
 
virtual void confirmPartner (DtFederateHandle federate)
 Change the status of a partner to confirmed. More...
 
virtual void removePartner (DtFederateHandle federate)
 Remove the given federate as a partner. More...
 
virtual void removePendingPartner (DtFederateHandle federate)
 Remove the given federate as a pending partner. More...
 
virtual void removeConfirmedPartner (DtFederateHandle federate)
 Remove the given federate as a confirmed partner. More...
 
virtual bool isMe (DtFederateHandle federate) const
 Return boolean: given federate handle is mine. More...
 
virtual DtFederateHandle federateHandle () const
 Return federate handle. More...
 

Protected Attributes

DtConnectionMgrmyConnectMgr
 Access to connection manager. More...
 
bool myIsJoined
 Join status. More...
 
DtPartnerState myPartnerState
 Partnering acceptance/confirm state. More...
 
std::vector< DtFederateHandlemyPartners
 List of partners. More...
 
std::vector< DtFederateHandlemyPendingPartners
 List of pending partners. More...
 
std::vector< DtFederateHandlemyConfirmedPartners
 List of confirmed partners. More...
 
DtFederateHandleStdSet myFilteredFederates
 List of license opposites that are being filtered. More...
 

Private Member Functions

 DtPartnerMgr (DtPartnerMgr const &)
 Copy Constructor not implemented – Copy Not Allowed! More...
 
DtPartnerMgroperator= (DtPartnerMgr const &)
 Assignment not implemented – Assignment Not Allowed! More...
 

Detailed Description

Instances of DtPartnerMgr process partner messages to establish federate partners in an unlicensed federation execution.

Constructor & Destructor Documentation

DtPartnerMgr::DtPartnerMgr ( DtConnectionMgr connectMgr)

Constructor.

DtPartnerMgr::~DtPartnerMgr ( )

Destructor.

DtPartnerMgr::DtPartnerMgr ( DtPartnerMgr const &  )
private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

virtual bool DtPartnerMgr::acceptMessage ( const DtRtiMsg msg)
virtual

Return boolean: message should be accepted?

virtual void DtPartnerMgr::acceptPartner ( DtFederateHandle  federate,
bool  confirmed = false 
)
protectedvirtual

Accept the given federate as a partner. Partner may either be pending or confirmed.

virtual void DtPartnerMgr::confirmPartner ( DtFederateHandle  federate)
protectedvirtual

Change the status of a partner to confirmed.

virtual DtFederateHandle DtPartnerMgr::federateHandle ( ) const
protectedvirtual

Return federate handle.

virtual bool DtPartnerMgr::isConfirmed ( DtFederateHandle  federate) const
protectedvirtual

Return boolean: Is the given federate a confirmed partner? (false if not a partner or partner but pending)

virtual bool DtPartnerMgr::isMe ( DtFederateHandle  federate) const
protectedvirtual

Return boolean: given federate handle is mine.

virtual bool DtPartnerMgr::isPartner ( DtFederateHandle  federate) const
protectedvirtual

Return boolean: Is the given federate a partner?

virtual bool DtPartnerMgr::isPending ( DtFederateHandle  federate) const
protectedvirtual

Return boolean: Is the given federate a pending partner? (false if not a partner or partner but confirmed)

virtual void DtPartnerMgr::joinFederationExecution ( const char *  federateType,
const char *  executionName,
const char *  federateName,
unsigned long  flags 
)
virtual

Start up partner management.

DtPartnerMgr& DtPartnerMgr::operator= ( DtPartnerMgr const &  )
private

Assignment not implemented – Assignment Not Allowed!

virtual bool DtPartnerMgr::partnerSlotAvailable ( ) const
protectedvirtual

Return boolean: Is a partner slot available?

virtual void DtPartnerMgr::processOtherMessage ( DtRtiMsg const &  msg)
protectedvirtual

Process all other messages.

virtual void DtPartnerMgr::processPartnerAccept ( const DtPartnerFederateMsg msg)
protectedvirtual

Process partner federate message callback for accept response.

virtual void DtPartnerMgr::processPartnerConfirm ( const DtPartnerFederateMsg msg)
protectedvirtual

Process partner federate message callback for confirm response.

virtual void DtPartnerMgr::processPartnerMessage ( const DtPartnerFederateMsg msg)
protectedvirtual

Partner federate message callback.

virtual void DtPartnerMgr::processPartnerReject ( const DtPartnerFederateMsg msg)
protectedvirtual

Process partner federate message callback for reject response.

virtual void DtPartnerMgr::processResignMessage ( const DtResignMsg msg)
protectedvirtual

Process resign message.

virtual void DtPartnerMgr::removeConfirmedPartner ( DtFederateHandle  federate)
protectedvirtual

Remove the given federate as a confirmed partner.

noop if federate was not confirmed.

virtual void DtPartnerMgr::removePartner ( DtFederateHandle  federate)
protectedvirtual

Remove the given federate as a partner.

noop if federate was not partner.

virtual void DtPartnerMgr::removePendingPartner ( DtFederateHandle  federate)
protectedvirtual

Remove the given federate as a pending partner.

noop if federate was not pending.

virtual void DtPartnerMgr::resign ( )
virtual

Shut down partner management.

virtual void DtPartnerMgr::sendJoinMessage ( MAKRti::DtString  federateType,
MAKRti::DtString  fedexName,
MAKRti::DtString  federateName 
)
protectedvirtual

Send a lightweight join message.

virtual void DtPartnerMgr::sendPartnerMessage ( DtFederateHandle  partnerFederate,
DtPartnerResponse  response 
)
protectedvirtual

Send a partner response message.

virtual bool DtPartnerMgr::waitingForConfirm ( ) const
protectedvirtual

Return boolean: Is there any partner that needs to be confirmed?

Member Data Documentation

std::vector<DtFederateHandle> DtPartnerMgr::myConfirmedPartners
protected

List of confirmed partners.

DtConnectionMgr* DtPartnerMgr::myConnectMgr
protected

Access to connection manager.

DtFederateHandleStdSet DtPartnerMgr::myFilteredFederates
protected

List of license opposites that are being filtered.

bool DtPartnerMgr::myIsJoined
protected

Join status.

std::vector<DtFederateHandle> DtPartnerMgr::myPartners
protected

List of partners.

DtPartnerState DtPartnerMgr::myPartnerState
protected

Partnering acceptance/confirm state.

std::vector<DtFederateHandle> DtPartnerMgr::myPendingPartners
protected

List of pending partners.


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

Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)