MAK RTIspy API Documentation for HLA Evolved
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtJoinResponseMsg Class Reference
+ Inheritance diagram for DtJoinResponseMsg:
+ Collaboration diagram for DtJoinResponseMsg:

List of all members.

Public Types

enum  errorCodes {
  DT_NO_ERROR = 0, DT_FEDEX_DOES_NOT_EXIST, DT_SAVE_IN_PROGRESS, DT_RESTORE_IN_PROGRESS,
  DT_FED_FILE_NOT_READY, DT_MAX_FEDERATES_JOINED, DT_FED_FILE_MERGE_PROBLEM, DT_FAILED_TO_GET_LICENSE,
  DT_RTIEXEC_LICENSING_PARAM_MISMATCH, DT_PARTNER_TAKEN, DT_TYPE_CONFLICT, DT_NAME_IN_USE,
  DT_UNKNOWN_ERROR, DT_WAITING, DT_CRC_FAILURE
}
 error codes for the errorValue flag More...

Public Member Functions

 DtJoinResponseMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtJoinResponseMsg (unsigned long destinationIDValue, unsigned short requestIDValue, DtFederateHandle federateHandleValue, MAKRti::DtString federateNameValue, unsigned short fedExHandleValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &timeImplNameValue, unsigned int crcOfFedFileValue, const MAKRti::DtString &momModule, const std::vector< MAKRti::DtString > &moduleNames, unsigned long flagsValue, bool allowNetworkTestValue, bool enableNetworkTestValue, const DtFederateNameAndHdlMap *namesAndHdls, errorCodes errorValue=DT_NO_ERROR, const DtString &errorString=DtString::nullString(), DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtJoinResponseMsg (const DtNetJoinResponseMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtJoinResponseMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (unsigned long destinationIDValue, unsigned short requestIDValue, DtFederateHandle federateHandleValue, MAKRti::DtString federateNameValue, unsigned short fedExHandleValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &timeImplNameValue, unsigned int crcOfFedFileValue, const MAKRti::DtString &momModule, const std::vector< MAKRti::DtString > &moduleNames, unsigned long flagsValue, bool allowNetworkTestValue, bool enableNetworkTestValue, const DtFederateNameAndHdlMap *namesAndHdls, errorCodes errorValue=DT_NO_ERROR, const DtString &errorString=DtString::nullString())
 Set all fields simultaneously.
virtual unsigned long destinationID () const
 Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.
virtual void setDestinationID (unsigned long destinationIDValue)
virtual unsigned short requestID () const
 Set/Get request ID.
virtual void setRequestID (unsigned short requestIDValue)
virtual MAKRti::DtString fullFedExName () const
 Set/Get full name of federation execution.
virtual void setFullFedExName (MAKRti::DtString const &name)
virtual unsigned short fedexHandleToUse () const
 Set/Get federate handle assigned by fedex.
virtual void setFedexHandleToUse (unsigned short handle)
virtual MAKRti::DtString federateName () const
 Set/Get federate name.
virtual void setFederateName (MAKRti::DtString const &name)
virtual MAKRti::DtString timeImplName () const
 Set/Get time implementation name.
virtual void setTimeImplName (MAKRti::DtString const &name)
virtual MAKRti::DtString momModuleName () const
 Set/Get MOM module name.
virtual void setMomModuleName (MAKRti::DtString const &name)
virtual void setfomModuleNames (const std::vector< MAKRti::DtString > &moduleNames)
 Set/Get Fom Module Names.
virtual void getFomModuleNames (std::vector< MAKRti::DtString > &modules) const
virtual DtFederateHandle federateHandleToUse () const
 Set/Get federate handle assigned by fedex.
virtual void setFederateHandleToUse (DtFederateHandle handle)
virtual unsigned int crcOfFedFile () const
 Set / get the crc of the fed file.
virtual void setCrcOfFedFile (unsigned int crc)
virtual void setErrorValue (errorCodes value)
 Set/Get error value.
virtual errorCodes errorValue () const
virtual void setErrorString (MAKRti::DtString const &errorStr)
 Set/Get error string.
virtual MAKRti::DtString errorString () const
virtual void setFlags (unsigned long value)
 Set/Get flags.
virtual unsigned long flags () const
virtual void setAllowNetworkTest (bool value)
 Set/Get whether network testing is ever allowed in this federation.
virtual bool allowNetworkTest () const
virtual void setNetworkTestEnabled (bool value)
 Set/Get whether network testing is currently enabled.
virtual bool networkTestEnabled () const
virtual void setFederateNamesAndHandles (const std::map< MAKRti::DtString, DtFederateHandle > &)
 Set/Get the federate names and handles.
virtual void getFederateNamesAndHandles (std::map< MAKRti::DtString, DtFederateHandle > &namesAndHdls) const
virtual void setFederateNamesSize (unsigned long size)
 Set/Get the federate names size.
virtual unsigned long federateNamesSize () const
virtual unsigned numFederates () const
 Set/Get the number of federate names and handles.
virtual void setNumFederates (unsigned num)
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
 Print the data section.

Static Public Member Functions

static DtRtiMsgcreate (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static void addCallback (DtConnectionMgr *conn, DtJoinResponseCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtJoinResponseCb cb, void *usr)

Protected Member Functions

virtual DtNetJoinResponseMsgnetJoinResponseMsg ()
 The network representation.
virtual const
DtNetJoinResponseMsg
netJoinResponseMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an JoinResponse Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual int setMinSizes (const MAKRti::DtString &fedExNameVal, const MAKRti::DtString &federateNameVal, const MAKRti::DtString &timeImplNameVal, const std::vector< MAKRti::DtString > &fomModuleNamesVal, const DtFederateNameAndHdlMap *namesAndHdls, const MAKRti::DtString &errorString)
 Sets the field sizes for the variant components and returns the minimum size needed for the message, including header DOES NOT allocate memory for the components.
virtual void setFedExNameSize (unsigned long size)
 Set/Get fedEx name size.
virtual unsigned long fedExNameSize () const
virtual void setFederateNameSize (unsigned long size)
 Set/Get federate name size.
virtual unsigned long federateNameSize () const
virtual void setErrorStringSize (unsigned long size)
 Set/Get error String size.
virtual unsigned long errorStringSize () const
virtual void setTimeImplNameSize (unsigned long size)
 Set/Get time implementation name size.
virtual unsigned long timeImplNameSize () const
virtual void setMomModuleNameSize (unsigned long size)
 Set/Get MOM module name size.
virtual unsigned long momModuleNameSize () const
virtual void setfomModuleNameSize (unsigned long size)
 Set/Get fomModules Names Size.
virtual unsigned long fomModuleNameSize () const
virtual char * fedExNamePtr ()
 Return pointer to component location in message.
virtual char * federateNamePtr ()
virtual char * timeImplNamePtr ()
virtual char * momModuleNamePtr ()
virtual char * fomModuleNamesPtr ()
virtual char * federateNamesPtr ()
virtual char * errorStringPtr ()
virtual DtNetU32 * federateHandlesPtr ()
virtual const char * fedExNamePtr () const
 Return pointer to component location in message.
virtual const char * federateNamePtr () const
virtual const char * timeImplNamePtr () const
virtual const char * momModuleNamePtr () const
virtual const char * fomModuleNamesPtr () const
virtual const char * federateNamesPtr () const
virtual const char * errorStringPtr () const
virtual const DtNetU32 * federateHandlesPtr () const
virtual DtJoinResponseMsgself () const
 Casts away const-ness.

Protected Attributes

DtFederateHandleSetmySet
 Our federate handle set.

Member Enumeration Documentation

error codes for the errorValue flag

Enumerator:
DT_NO_ERROR 
DT_FEDEX_DOES_NOT_EXIST 
DT_SAVE_IN_PROGRESS 
DT_RESTORE_IN_PROGRESS 
DT_FED_FILE_NOT_READY 
DT_MAX_FEDERATES_JOINED 
DT_FED_FILE_MERGE_PROBLEM 
DT_FAILED_TO_GET_LICENSE 
DT_RTIEXEC_LICENSING_PARAM_MISMATCH 
DT_PARTNER_TAKEN 
DT_TYPE_CONFLICT 
DT_NAME_IN_USE 
DT_UNKNOWN_ERROR 
DT_WAITING 
DT_CRC_FAILURE 

Used as a invalid value while waiting for a response.


Constructor & Destructor Documentation

DtJoinResponseMsg::DtJoinResponseMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().

Referenced by clone(), create(), and setMinSizes().

DtJoinResponseMsg::DtJoinResponseMsg ( unsigned long  destinationIDValue,
unsigned short  requestIDValue,
DtFederateHandle  federateHandleValue,
MAKRti::DtString  federateNameValue,
unsigned short  fedExHandleValue,
MAKRti::DtString const &  fedExNameValue,
MAKRti::DtString const &  timeImplNameValue,
unsigned int  crcOfFedFileValue,
const MAKRti::DtString &  momModule,
const std::vector< MAKRti::DtString > &  moduleNames,
unsigned long  flagsValue,
bool  allowNetworkTestValue,
bool  enableNetworkTestValue,
const DtFederateNameAndHdlMap namesAndHdls,
errorCodes  errorValue = DT_NO_ERROR,
const DtString &  errorString = DtString::nullString(),
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtJoinResponseMsg::DtJoinResponseMsg ( const DtNetJoinResponseMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

void DtJoinResponseMsg::addCallback ( DtConnectionMgr conn,
DtJoinResponseCb  cb,
void *  usr 
) [static]

References netJoinResponseMsg().

DtRtiMsg * DtJoinResponseMsg::clone ( bool  copy = true) const [virtual]

Return a copy/empty object of the same type as this.

Implements DtRtiMsg.

References DtJoinResponseMsg(), and netJoinResponseMsg().

Referenced by DtRtiExecFederateMgr::processJoinResponseMsg().

unsigned int DtJoinResponseMsg::crcOfFedFile ( ) const [virtual]

Set / get the crc of the fed file.

References DtNetJoinResponseMsg::crcOfFedFile, and netJoinResponseMsg().

Referenced by DtRtiExecFederateMgr::initializeFOM(), and printData().

DtRtiMsg * DtJoinResponseMsg::create ( const DtNetMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creator.

References DtJoinResponseMsg().

DtRtiMsg * DtJoinResponseMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]

Creator.

References DtJoinResponseMsg().

unsigned long DtJoinResponseMsg::destinationID ( ) const [virtual]

Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.

This destination ID was the unique source ID that the federate supplied for join.

References DtNetJoinResponseMsg::destinationID, and netJoinResponseMsg().

Referenced by DtFederateTrackingFilter::handleJoinResponseMsg(), printData(), and DtRtiExecFederateMgr::processJoinResponseMsg().

MAKRti::DtString DtJoinResponseMsg::errorString ( ) const [virtual]
char * DtJoinResponseMsg::errorStringPtr ( ) [protected, virtual]
const char * DtJoinResponseMsg::errorStringPtr ( ) const [protected, virtual]
unsigned long DtJoinResponseMsg::errorStringSize ( ) const [protected, virtual]
DtNetU32 * DtJoinResponseMsg::federateHandlesPtr ( ) [protected, virtual]
const DtNetU32 * DtJoinResponseMsg::federateHandlesPtr ( ) const [protected, virtual]

References netJoinResponseMsg().

Set/Get federate handle assigned by fedex.

References DtNetJoinResponseMsg::federateHandleToUse, and netJoinResponseMsg().

Referenced by printData(), and DtRtiExecFederateMgr::processJoinResponseMsg().

MAKRti::DtString DtJoinResponseMsg::federateName ( ) const [virtual]
char * DtJoinResponseMsg::federateNamePtr ( ) [protected, virtual]
const char * DtJoinResponseMsg::federateNamePtr ( ) const [protected, virtual]
unsigned long DtJoinResponseMsg::federateNameSize ( ) const [protected, virtual]
char * DtJoinResponseMsg::federateNamesPtr ( ) [protected, virtual]
const char * DtJoinResponseMsg::federateNamesPtr ( ) const [protected, virtual]
unsigned long DtJoinResponseMsg::federateNamesSize ( ) const [virtual]
unsigned short DtJoinResponseMsg::fedexHandleToUse ( ) const [virtual]

Set/Get federate handle assigned by fedex.

References DtNetJoinResponseMsg::fedexHandleToUse, and netJoinResponseMsg().

Referenced by printData().

char * DtJoinResponseMsg::fedExNamePtr ( ) [protected, virtual]

Return pointer to component location in message.

References federateNamesPtr(), and federateNamesSize().

Referenced by fullFedExName(), setFullFedExName(), and timeImplNamePtr().

const char * DtJoinResponseMsg::fedExNamePtr ( ) const [protected, virtual]

Return pointer to component location in message.

References federateNamesPtr(), and federateNamesSize().

unsigned long DtJoinResponseMsg::fedExNameSize ( ) const [protected, virtual]
unsigned long DtJoinResponseMsg::flags ( ) const [virtual]
unsigned long DtJoinResponseMsg::fomModuleNameSize ( ) const [protected, virtual]
char * DtJoinResponseMsg::fomModuleNamesPtr ( ) [protected, virtual]
const char * DtJoinResponseMsg::fomModuleNamesPtr ( ) const [protected, virtual]
MAKRti::DtString DtJoinResponseMsg::fullFedExName ( ) const [virtual]

Set/Get full name of federation execution.

References federateHandlesPtr(), fedExNamePtr(), and fedExNameSize().

Referenced by DtRtiExecFederateMgr::initializeFOM(), and printData().

void DtJoinResponseMsg::getFederateNamesAndHandles ( std::map< MAKRti::DtString, DtFederateHandle > &  namesAndHdls) const [virtual]
void DtJoinResponseMsg::getFomModuleNames ( std::vector< MAKRti::DtString > &  modules) const [virtual]

Returns the kind of an JoinResponse Msg.

Implements DtRtiMsg.

References DtJoinResponseMsgKind.

Referenced by DtJoinResponseMsg().

int DtJoinResponseMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtJoinResponseMsg(), and set().

MAKRti::DtString DtJoinResponseMsg::momModuleName ( ) const [virtual]

Set/Get MOM module name.

References momModuleNamePtr(), and momModuleNameSize().

Referenced by DtRtiExecFederateMgr::initializeFOM().

char * DtJoinResponseMsg::momModuleNamePtr ( ) [protected, virtual]
const char * DtJoinResponseMsg::momModuleNamePtr ( ) const [protected, virtual]
unsigned long DtJoinResponseMsg::momModuleNameSize ( ) const [protected, virtual]
const DtNetJoinResponseMsg * DtJoinResponseMsg::netJoinResponseMsg ( ) const [protected, virtual]

References netJoinResponseMsg().

unsigned DtJoinResponseMsg::numFederates ( ) const [virtual]

Set/Get the number of federate names and handles.

References netJoinResponseMsg(), and DtNetJoinResponseMsg::numFederates.

Referenced by federateNamesPtr(), getFederateNamesAndHandles(), and setFederateNamesAndHandles().

void DtJoinResponseMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const [virtual]
void DtJoinResponseMsg::removeCallback ( DtConnectionMgr conn,
DtJoinResponseCb  cb,
void *  usr 
) [static]
unsigned short DtJoinResponseMsg::requestID ( ) const [virtual]
DtJoinResponseMsg * DtJoinResponseMsg::self ( ) const [inline, protected, virtual]

Casts away const-ness.

void DtJoinResponseMsg::set ( unsigned long  destinationIDValue,
unsigned short  requestIDValue,
DtFederateHandle  federateHandleValue,
MAKRti::DtString  federateNameValue,
unsigned short  fedExHandleValue,
MAKRti::DtString const &  fedExNameValue,
MAKRti::DtString const &  timeImplNameValue,
unsigned int  crcOfFedFileValue,
const MAKRti::DtString &  momModule,
const std::vector< MAKRti::DtString > &  moduleNames,
unsigned long  flagsValue,
bool  allowNetworkTestValue,
bool  enableNetworkTestValue,
const DtFederateNameAndHdlMap namesAndHdls,
errorCodes  errorValue = DT_NO_ERROR,
const DtString &  errorString = DtString::nullString() 
) [virtual]
void DtJoinResponseMsg::setAllowNetworkTest ( bool  value) [virtual]

Set/Get whether network testing is ever allowed in this federation.

References netJoinResponseMsg(), and DtNetJoinResponseMsg::networkTestFlags.

Referenced by DtJoinResponseMsg(), and set().

void DtJoinResponseMsg::setCrcOfFedFile ( unsigned int  crc) [virtual]
void DtJoinResponseMsg::setDestinationID ( unsigned long  destinationIDValue) [virtual]
void DtJoinResponseMsg::setErrorString ( MAKRti::DtString const &  errorStr) [virtual]
void DtJoinResponseMsg::setErrorStringSize ( unsigned long  size) [protected, virtual]

Set/Get error String size.

References DtNetJoinResponseMsg::errorStringSize, and netJoinResponseMsg().

Referenced by setMinSizes().

void DtJoinResponseMsg::setErrorValue ( errorCodes  value) [virtual]

Set/Get error value.

References DtNetJoinResponseMsg::errorValue, and netJoinResponseMsg().

Referenced by DtJoinResponseMsg(), and set().

void DtJoinResponseMsg::setFederateName ( MAKRti::DtString const &  name) [virtual]
void DtJoinResponseMsg::setFederateNamesAndHandles ( const std::map< MAKRti::DtString, DtFederateHandle > &  namesAndHdls) [virtual]
void DtJoinResponseMsg::setFederateNameSize ( unsigned long  size) [protected, virtual]

Set/Get federate name size.

References DtNetJoinResponseMsg::federateNameSize, and netJoinResponseMsg().

Referenced by setMinSizes().

void DtJoinResponseMsg::setFederateNamesSize ( unsigned long  size) [virtual]

Set/Get the federate names size.

References DtNetJoinResponseMsg::federateNamesSize, and netJoinResponseMsg().

Referenced by setFederateNamesAndHandles(), and setMinSizes().

void DtJoinResponseMsg::setFedexHandleToUse ( unsigned short  handle) [virtual]
void DtJoinResponseMsg::setFedExNameSize ( unsigned long  size) [protected, virtual]

Set/Get fedEx name size.

References DtNetJoinResponseMsg::fedExNameSize, and netJoinResponseMsg().

Referenced by setMinSizes().

void DtJoinResponseMsg::setFlags ( unsigned long  value) [virtual]

Set/Get flags.

References DtNetJoinResponseMsg::flags, flags(), and netJoinResponseMsg().

Referenced by DtJoinResponseMsg(), and set().

void DtJoinResponseMsg::setfomModuleNames ( const std::vector< MAKRti::DtString > &  moduleNames) [virtual]
void DtJoinResponseMsg::setfomModuleNameSize ( unsigned long  size) [protected, virtual]

Set/Get fomModules Names Size.

References DtNetJoinResponseMsg::fomModuleNamesSize, and netJoinResponseMsg().

Referenced by setMinSizes().

void DtJoinResponseMsg::setFullFedExName ( MAKRti::DtString const &  name) [virtual]
int DtJoinResponseMsg::setMinSizes ( const MAKRti::DtString &  fedExNameVal,
const MAKRti::DtString &  federateNameVal,
const MAKRti::DtString &  timeImplNameVal,
const std::vector< MAKRti::DtString > &  fomModuleNamesVal,
const DtFederateNameAndHdlMap namesAndHdls,
const MAKRti::DtString &  errorString 
) [protected, virtual]

Sets the field sizes for the variant components and returns the minimum size needed for the message, including header DOES NOT allocate memory for the components.

References DtJoinResponseMsg(), setErrorStringSize(), setFederateNameSize(), setFederateNamesSize(), setFedExNameSize(), setfomModuleNameSize(), setNumFederates(), and setTimeImplNameSize().

Referenced by DtJoinResponseMsg(), and set().

void DtJoinResponseMsg::setMomModuleName ( MAKRti::DtString const &  name) [virtual]
void DtJoinResponseMsg::setMomModuleNameSize ( unsigned long  size) [protected, virtual]

Set/Get MOM module name size.

References DtNetJoinResponseMsg::momModuleNameSize, and netJoinResponseMsg().

Set/Get whether network testing is currently enabled.

References netJoinResponseMsg(), and DtNetJoinResponseMsg::networkTestFlags.

Referenced by DtJoinResponseMsg(), and set().

void DtJoinResponseMsg::setNumFederates ( unsigned  num) [virtual]
void DtJoinResponseMsg::setRequestID ( unsigned short  requestIDValue) [virtual]
void DtJoinResponseMsg::setTimeImplName ( MAKRti::DtString const &  name) [virtual]
void DtJoinResponseMsg::setTimeImplNameSize ( unsigned long  size) [protected, virtual]

Set/Get time implementation name size.

References netJoinResponseMsg(), and DtNetJoinResponseMsg::timeImplNameSize.

Referenced by setMinSizes().

MAKRti::DtString DtJoinResponseMsg::timeImplName ( ) const [virtual]
char * DtJoinResponseMsg::timeImplNamePtr ( ) [protected, virtual]
const char * DtJoinResponseMsg::timeImplNamePtr ( ) const [protected, virtual]

References fedExNamePtr(), and fedExNameSize().

unsigned long DtJoinResponseMsg::timeImplNameSize ( ) const [protected, virtual]

Member Data Documentation

Our federate handle set.


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)