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 Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtJoinResponseMsg Class Reference
+ Inheritance diagram for DtJoinResponseMsg:
+ Collaboration diagram for DtJoinResponseMsg:

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, DT_FEDEX_STILL_CREATING,
  DT_UNAUTHORIZED
}
 error codes for the errorValue flag More...
 

Public Member Functions

virtual ~DtJoinResponseMsg ()
 Destructor. More...
 
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this. More...
 
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(), bool adjustBufferSize=true)
 Set all fields simultaneously (adjust buffer size if not pre-allocated for this data) More...
 
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
 Print the data section. More...
 
 DtJoinResponseMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
 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)
 Constructor. More...
 
 DtJoinResponseMsg (const DtNetJoinResponseMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
virtual unsigned long destinationID () const
 Set/Get message component values. More...
 
virtual void setDestinationID (unsigned long destinationIDValue)
 Set/Get message component values. More...
 
virtual unsigned short requestID () const
 Set/Get message component values. More...
 
virtual void setRequestID (unsigned short requestIDValue)
 Set/Get message component values. More...
 
virtual MAKRti::DtString fullFedExName () const
 Set/Get message component values. More...
 
virtual void setFullFedExName (MAKRti::DtString const &name, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual unsigned short fedexHandleToUse () const
 Set/Get message component values. More...
 
virtual void setFedexHandleToUse (unsigned short handle)
 Set/Get message component values. More...
 
virtual MAKRti::DtString federateName () const
 Set/Get message component values. More...
 
virtual void setFederateName (MAKRti::DtString const &name, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual MAKRti::DtString timeImplName () const
 Set/Get message component values. More...
 
virtual void setTimeImplName (MAKRti::DtString const &name, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual MAKRti::DtString momModuleName () const
 Set/Get message component values. More...
 
virtual void setMomModuleName (MAKRti::DtString const &name, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual void setfomModuleNames (const std::vector< MAKRti::DtString > &moduleNames, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual void getFomModuleNames (std::vector< MAKRti::DtString > &modules) const
 Set/Get message component values. More...
 
virtual DtFederateHandle federateHandleToUse () const
 Set/Get message component values. More...
 
virtual void setFederateHandleToUse (DtFederateHandle handle)
 Set/Get message component values. More...
 
virtual unsigned int crcOfFedFile () const
 Set/Get message component values. More...
 
virtual void setCrcOfFedFile (unsigned int crc)
 Set/Get message component values. More...
 
virtual void setErrorValue (errorCodes value)
 Set/Get message component values. More...
 
virtual errorCodes errorValue () const
 Set/Get message component values. More...
 
virtual void setErrorString (MAKRti::DtString const &errorStr, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual MAKRti::DtString errorString () const
 Set/Get message component values. More...
 
virtual void setFlags (unsigned long value)
 Set/Get message component values. More...
 
virtual unsigned long flags () const
 Set/Get message component values. More...
 
virtual void setAllowNetworkTest (bool value)
 Set/Get message component values. More...
 
virtual bool allowNetworkTest () const
 Set/Get message component values. More...
 
virtual void setNetworkTestEnabled (bool value)
 Set/Get message component values. More...
 
virtual bool networkTestEnabled () const
 Set/Get message component values. More...
 
virtual void setFederateNamesAndHandles (const std::map< MAKRti::DtString, DtFederateHandle > &namesAndHandles, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual void getFederateNamesAndHandles (std::map< MAKRti::DtString, DtFederateHandle > &namesAndHdls) const
 Set/Get message component values. More...
 
virtual void setFederateNamesSize (unsigned long size)
 Set/Get message component values. More...
 
virtual unsigned long federateNamesSize () const
 Set/Get message component values. More...
 
virtual unsigned numFederates () const
 Set/Get message component values. More...
 
virtual void setNumFederates (unsigned num)
 Set/Get message component values. More...
 
- Public Member Functions inherited from DtRtiMsg
virtual ~DtRtiMsg ()
 Destructor. More...
 
virtual DtRtiMsgcloneWithTransport (bool copy=true) const
 Return a copy/empty object of the same type as this using clone and set the transport type from the host message. More...
 
virtual DtNetMsgHeadernetHeader () const
 Get header of network representation. More...
 
virtual int version () const
 Return the message version. More...
 
virtual bool isValidVersion () const
 Returns bool: message version is valid? More...
 
virtual void setFedEx (const MAKRti::DtString &name)
 All RTI messages contain information to identify which federation execution the message applies to. More...
 
virtual void setFedEx (int handle)
 Set federation execution identifier as a handle. More...
 
virtual bool isForExec (const MAKRti::DtString &execName, int execHandle) const
 Returns true if the current message belongs to the indicated federation execution, false otherwise. More...
 
virtual DtRtiMsgKind msgKind () const
 Get the message kind. More...
 
virtual const char * kindString () const
 Returns the message kind string name. More...
 
virtual bool isConstrained () const
 Return boolean: message type can be time constrained? More...
 
virtual bool isAllowedDuringSave () const
 Return boolean: message type can be processed during save? More...
 
virtual void setTime (const DtRtiApiTime &time)
 Set/Get time Used in timestamped messages. More...
 
virtual DtRtiApiTime const * time (DtLogicalTimeFactory *fedTimeFactory) const
 
virtual bool hasTime () const
 Returns true if time field is valid. More...
 
virtual void setSerialNumber (unsigned long serialNumberValue)
 Set/Get event retraction serial number Used in timestamped messages. More...
 
virtual unsigned long serialNumber () const
 
virtual void setTransportType (DtTransportHandle type)
 Set/Get transport type. More...
 
virtual DtTransportHandle transportType () const
 
virtual DtOrderHandle orderType () const
 This base implementation always returns recieve order. More...
 
virtual bool isMetadataPresent () const
 Test if metadata has been added to a DtRtiMsg object. More...
 
virtual bool addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
 Allocate space for next block of metadata. More...
 
virtual void removeMetadata (unsigned int size)
 Update the size of the message when metadata has been removed. More...
 
bool isInteractionMsgType () const
 Utility functions, check the message type against known interaciton/update message types. More...
 
bool isUpdateMsgType () const
 
virtual void print (DtLogicalTimeFactory *logicalTimeFactory) const
 Printing functions. More...
 
virtual void printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
 
virtual void printTime (const char *label, DtRtiApiTime const *timeValue) const
 Print the given time. More...
 
virtual void printInterval (const char *label, DtRtiApiTimeInterval const *intervalValue) const
 Print the interval. More...
 
virtual int status () const
 Returns MSG_STATUS_OK if OK, a reason enumeration otherwise. More...
 
virtual int timeFieldSize (int encodedLength) const
 Returns size of a timestamp field (including byte alignment adjustment) given the time's encoded length. More...
 
virtual int tagFieldSize (int encodedLength) const
 Returns size of a tag field (including byte alignment adjustment) given the tag's encoded length. More...
 
virtual const MAKRti::DtString fedExName () const
 These two functions should be avoided in favor of isForExec(). More...
 
virtual int fedExHandle () const
 Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name. More...
 
virtual void setFederateHandle (DtFederateHandle handle)
 Set/Get federate handle. More...
 
virtual DtFederateHandle federateHandle () const
 Set/Get federate handle. More...
 
virtual void setSequenceNumber (unsigned long value)
 Set/Get message sequence number. More...
 
virtual unsigned long sequenceNumber () const
 Set/Get message sequence number. More...
 
virtual void setServiceCallNumber (unsigned long value)
 Set/Get service call number. More...
 
virtual unsigned long serviceCallNumber () const
 Set/Get service call number. More...
 
virtual void setTriggerMessageNumber (unsigned long value)
 Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...
 
virtual unsigned long triggerMessageNumber () const
 Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...
 

Static Public Member Functions

static DtRtiMsgcreate (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator for receiving. More...
 
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator for sending. More...
 
static void addCallback (DtConnectionMgr *conn, DtJoinResponseCb cb, void *usr, bool isMomCallback=false)
 Callback management. More...
 
static void removeCallback (DtConnectionMgr *conn, DtJoinResponseCb cb, void *usr, bool isMomCallback=false)
 Callback management. More...
 
- Static Public Member Functions inherited from DtRtiMsg
static const DtNetMsgHeadernetHeader (const void *buffer)
 Extracts the header network representation from the buffer. More...
 
static const char * kindToString (DtRtiMsgKind kind)
 Returns the name of the message, by kind enumeration. More...
 
static const char * kindString (const void *buffer)
 Extracts the message kind from the given buffer and returns its string name. More...
 
static unsigned long totalSize (const void *buffer)
 Extracts the message total size form the given buffer. More...
 
static const DtRtiMsgKind msgKind (const void *buffer)
 Extracts the message kind from the given buffer. More...
 
static unsigned int version (const void *buffer)
 Extracts the message version form the given buffer. More...
 
static unsigned int fedExHandle (const void *buffer)
 Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name) More...
 
static DtFederateHandle federateHandle (const void *buffer)
 Extracts the message federate handle form the given buffer. More...
 
static unsigned long sequenceNumber (const void *buffer)
 Extracts the message sequence number form the given buffer. More...
 
static unsigned char flags (const void *buffer)
 Extracts the message flags form the given buffer. More...
 
static unsigned long metadataSize (const void *buffer)
 Extracts the message metadata size form the given buffer. More...
 
static void setDefaultRegionSet (unsigned long defaultRegionSet)
 Set the default region set handle. More...
 
static void setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
 Set/Get flag to enable use of 32 bit size field for attribute/parameter values. More...
 
static bool use32BitsForValueSize ()
 
static void setSmartForwardingEnabled (bool enabled)
 Set/Get is SmartForwarding enabled? More...
 
static bool smartForwardingEnabled ()
 

Protected Member Functions

virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an JoinResponse Msg. More...
 
virtual int minSize () const
 Return the minimum buffer size needed for this message. More...
 
virtual int minSize (const MAKRti::DtString &fedExNameVal, const MAKRti::DtString &federateNameVal, const MAKRti::DtString &timeImplNameVal, const std::vector< MAKRti::DtString > &fomModuleNamesVal, const MAKRti::DtString &momModuleNameVal, const DtFederateNameAndHdlMap *namesAndHdls, const MAKRti::DtString &errorString)
 Return the buffer size needed for this message with the given variable data. More...
 
virtual DtJoinResponseMsgself () const
 Casts away const-ness. More...
 
virtual DtNetJoinResponseMsgnetJoinResponseMsg ()
 The network representation. More...
 
virtual const
DtNetJoinResponseMsg
netJoinResponseMsg () const
 The network representation. More...
 
virtual void setFedExNameSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long fedExNameSize () const
 Set/Get the size of variable sized components. More...
 
virtual void setFederateNameSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long federateNameSize () const
 Set/Get the size of variable sized components. More...
 
virtual void setErrorStringSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long errorStringSize () const
 Set/Get the size of variable sized components. More...
 
virtual void setTimeImplNameSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long timeImplNameSize () const
 Set/Get the size of variable sized components. More...
 
virtual void setMomModuleNameSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long momModuleNameSize () const
 Set/Get the size of variable sized components. More...
 
virtual void setfomModuleNameSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long fomModuleNameSize () const
 Set/Get the size of variable sized components. More...
 
virtual char * fedExNamePtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * fedExNamePtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * federateNamePtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * federateNamePtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * timeImplNamePtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * timeImplNamePtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * momModuleNamePtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * momModuleNamePtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * fomModuleNamesPtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * fomModuleNamesPtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * federateNamesPtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * federateNamesPtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * errorStringPtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * errorStringPtr () const
 Get the pointer to the variable sized components. More...
 
virtual DtNetU32 * federateHandlesPtr ()
 Get the pointer to the variable sized components. More...
 
virtual const DtNetU32 * federateHandlesPtr () const
 Get the pointer to the variable sized components. More...
 
- Protected Member Functions inherited from DtRtiMsg
 DtRtiMsg ()
 Constructor. More...
 
virtual void sizeChanged (int size)
 Called whenever size is changed using changeSize, or insert/deleteBytes. More...
 
void initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
 Called by ctor, so not virtual. More...
 
void initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)
 
void initDtRtiMsg (const DtNetMsgHeader *header, DtBufferPtr buffer)
 
virtual void adjustBytes (int offset, int numBytes)
 Adjust numBytes bytes at the indicated offset in the net rep. More...
 
virtual void adjustBytes (void *address, int numBytes)
 Adjust the numBytes starting at the indicated addres. More...
 

Protected Attributes

DtFederateHandleSetmySet
 Our federate handle set. More...
 
- Protected Attributes inherited from DtRtiMsg
DtTransportHandle myTransportType
 
DtOrderHandle myOrderType
 
DtRtiApiTimemyFedTime
 
bool myTimeIsValid
 
bool myConstrained
 
bool myAllowedDuringSave
 
unsigned long mySerialNumber
 
unsigned long myServiceCallNumber
 
unsigned long myTriggerMessage
 

Additional Inherited Members

- Static Public Attributes inherited from DtRtiMsg
static unsigned long theDefaultRegionSetHandle
 
static const
DtRtiApiVariableLengthData 
theDefaultTag
 
- Static Protected Attributes inherited from DtRtiMsg
static bool theUse32BitsForValueSize
 
static bool theSmartForwardingEnabled
 

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.

DT_FEDEX_STILL_CREATING 
DT_UNAUTHORIZED 

Constructor & Destructor Documentation

DtJoinResponseMsg::DtJoinResponseMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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 
)

Constructor.

DtJoinResponseMsg::DtJoinResponseMsg ( const DtNetJoinResponseMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

virtual DtJoinResponseMsg::~DtJoinResponseMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtJoinResponseMsg::addCallback ( DtConnectionMgr conn,
DtJoinResponseCb  cb,
void *  usr,
bool  isMomCallback = false 
)
static

Callback management.

virtual bool DtJoinResponseMsg::allowNetworkTest ( ) const
virtual

Set/Get message component values.

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.

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

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

Implements DtRtiMsg.

virtual unsigned int DtJoinResponseMsg::crcOfFedFile ( ) const
virtual

Set/Get message component values.

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.

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

Creator for receiving.

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

Creator for sending.

virtual unsigned long DtJoinResponseMsg::destinationID ( ) const
virtual

Set/Get message component values.

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.

virtual MAKRti::DtString DtJoinResponseMsg::errorString ( ) const
virtual

Set/Get message component values.

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.

virtual char* DtJoinResponseMsg::errorStringPtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const char* DtJoinResponseMsg::errorStringPtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinResponseMsg::errorStringSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual errorCodes DtJoinResponseMsg::errorValue ( ) const
virtual

Set/Get message component values.

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.

virtual DtNetU32* DtJoinResponseMsg::federateHandlesPtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const DtNetU32* DtJoinResponseMsg::federateHandlesPtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual DtFederateHandle DtJoinResponseMsg::federateHandleToUse ( ) const
virtual

Set/Get message component values.

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.

virtual MAKRti::DtString DtJoinResponseMsg::federateName ( ) const
virtual

Set/Get message component values.

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.

virtual char* DtJoinResponseMsg::federateNamePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const char* DtJoinResponseMsg::federateNamePtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinResponseMsg::federateNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual char* DtJoinResponseMsg::federateNamesPtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const char* DtJoinResponseMsg::federateNamesPtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinResponseMsg::federateNamesSize ( ) const
virtual

Set/Get message component values.

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.

virtual unsigned short DtJoinResponseMsg::fedexHandleToUse ( ) const
virtual

Set/Get message component values.

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.

virtual char* DtJoinResponseMsg::fedExNamePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const char* DtJoinResponseMsg::fedExNamePtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinResponseMsg::fedExNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual unsigned long DtJoinResponseMsg::flags ( ) const
virtual

Set/Get message component values.

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.

virtual unsigned long DtJoinResponseMsg::fomModuleNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual char* DtJoinResponseMsg::fomModuleNamesPtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const char* DtJoinResponseMsg::fomModuleNamesPtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual MAKRti::DtString DtJoinResponseMsg::fullFedExName ( ) const
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::getFederateNamesAndHandles ( std::map< MAKRti::DtString, DtFederateHandle > &  namesAndHdls) const
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::getFomModuleNames ( std::vector< MAKRti::DtString > &  modules) const
virtual

Set/Get message component values.

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.

virtual DtRtiMsgKind DtJoinResponseMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an JoinResponse Msg.

Implements DtRtiMsg.

virtual int DtJoinResponseMsg::minSize ( ) const
protectedvirtual

Return the minimum buffer size needed for this message.

virtual int DtJoinResponseMsg::minSize ( const MAKRti::DtString &  fedExNameVal,
const MAKRti::DtString &  federateNameVal,
const MAKRti::DtString &  timeImplNameVal,
const std::vector< MAKRti::DtString > &  fomModuleNamesVal,
const MAKRti::DtString &  momModuleNameVal,
const DtFederateNameAndHdlMap namesAndHdls,
const MAKRti::DtString &  errorString 
)
protectedvirtual

Return the buffer size needed for this message with the given variable data.

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

Set/Get message component values.

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.

virtual char* DtJoinResponseMsg::momModuleNamePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const char* DtJoinResponseMsg::momModuleNamePtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinResponseMsg::momModuleNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual DtNetJoinResponseMsg* DtJoinResponseMsg::netJoinResponseMsg ( )
protectedvirtual

The network representation.

virtual const DtNetJoinResponseMsg* DtJoinResponseMsg::netJoinResponseMsg ( ) const
protectedvirtual

The network representation.

virtual bool DtJoinResponseMsg::networkTestEnabled ( ) const
virtual

Set/Get message component values.

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.

virtual unsigned DtJoinResponseMsg::numFederates ( ) const
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual

Print the data section.

Reimplemented from DtRtiMsg.

static void DtJoinResponseMsg::removeCallback ( DtConnectionMgr conn,
DtJoinResponseCb  cb,
void *  usr,
bool  isMomCallback = false 
)
static

Callback management.

virtual unsigned short DtJoinResponseMsg::requestID ( ) const
virtual

Set/Get message component values.

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.

DtJoinResponseMsg * DtJoinResponseMsg::self ( ) const
inlineprotectedvirtual

Casts away const-ness.

virtual 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(),
bool  adjustBufferSize = true 
)
virtual

Set all fields simultaneously (adjust buffer size if not pre-allocated for this data)

virtual void DtJoinResponseMsg::setAllowNetworkTest ( bool  value)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setCrcOfFedFile ( unsigned int  crc)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setDestinationID ( unsigned long  destinationIDValue)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setErrorString ( MAKRti::DtString const &  errorStr,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setErrorStringSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

virtual void DtJoinResponseMsg::setErrorValue ( errorCodes  value)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setFederateHandleToUse ( DtFederateHandle  handle)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setFederateName ( MAKRti::DtString const &  name,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setFederateNamesAndHandles ( const std::map< MAKRti::DtString, DtFederateHandle > &  namesAndHandles,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setFederateNameSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

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

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setFedexHandleToUse ( unsigned short  handle)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setFedExNameSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

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

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setfomModuleNames ( const std::vector< MAKRti::DtString > &  moduleNames,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setfomModuleNameSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

virtual void DtJoinResponseMsg::setFullFedExName ( MAKRti::DtString const &  name,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setMomModuleName ( MAKRti::DtString const &  name,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setMomModuleNameSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

virtual void DtJoinResponseMsg::setNetworkTestEnabled ( bool  value)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setNumFederates ( unsigned  num)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setRequestID ( unsigned short  requestIDValue)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setTimeImplName ( MAKRti::DtString const &  name,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

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.

virtual void DtJoinResponseMsg::setTimeImplNameSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

virtual MAKRti::DtString DtJoinResponseMsg::timeImplName ( ) const
virtual

Set/Get message component values.

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.

virtual char* DtJoinResponseMsg::timeImplNamePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual const char* DtJoinResponseMsg::timeImplNamePtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinResponseMsg::timeImplNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

Member Data Documentation

DtFederateHandleSet* DtJoinResponseMsg::mySet
protected

Our federate handle set.


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

Document ID: Generated on Wed Jul 8 16:20:32 EDT 2026 from SVN revision 291616
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)