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

Public Member Functions

virtual ~DtJoinMsg ()
 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 sourceIDValue, unsigned short requestIDValue, MAKRti::DtString const &fedTypeValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &fedNameValue, MAKRti::DtString const &federateHostNameValue, const std::wstring &credentialsType, char const *credentialsData, int credentialsDataSize, const std::vector< MAKRti::DtString > &moduleNames, DtHlaVersionId hlaVersion, int astntCompId, unsigned long flagsValue, unsigned int needPartnerValue, const std::vector< unsigned int > &joinModulesCrcs, bool adjustBufferSize=true)
 Set all fields simultaneously. More...
 
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
 Print the data section. More...
 
 DtJoinMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
 DtJoinMsg (unsigned long sourceIDValue, unsigned short requestIDValue, MAKRti::DtString const &fedTypeValue, MAKRti::DtString const &fedExNameValue, MAKRti::DtString const &fedNameValue, MAKRti::DtString const &federateHostNameValue, const std::wstring &credentialsType, char const *credentialsData, int credentialsDataSize, const std::vector< MAKRti::DtString > &moduleNames, DtHlaVersionId hlaVersion, int astntCompId, unsigned long flagsValue, unsigned int needPartnerValue, const std::vector< unsigned int > &joinModulesCrcs, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
 DtJoinMsg (const DtNetJoinMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
virtual unsigned long sourceID () const
 Set/Get message component values. More...
 
virtual void setSourceID (unsigned long sourceIDValue)
 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 void setFederateType (MAKRti::DtString const &type, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual MAKRti::DtString federateType () const
 Set/Get message component values. More...
 
virtual void setFullFedExName (MAKRti::DtString const &name, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual MAKRti::DtString fullFedExName () 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 federateName () const
 Set/Get message component values. More...
 
virtual void setFederateHostName (MAKRti::DtString const &name, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual MAKRti::DtString federateHostName () const
 Set/Get message component values. More...
 
virtual void setCredentialsType (const std::wstring &type, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual std::wstring credentialsType () const
 Set/Get message component values. More...
 
virtual std::wstring & getCredentialsType (std::wstring &type) const
 Set/Get message component values. More...
 
virtual void setCredentialsData (void const *data, unsigned short size, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual void setCredentialsData (const std::vector< char > &data, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual std::vector< char > & getCredentialsData (std::vector< char > &data) const
 Set/Get message component values. More...
 
virtual void const * credentialsData () const
 Set/Get message component values. More...
 
virtual unsigned short credentialsDataSize () const
 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 void setIpAddress (const MAKRti::DtInetAddr &ip)
 Set/Get message component values. More...
 
virtual MAKRti::DtInetAddr ipAddress () const
 Set/Get message component values. More...
 
virtual void setHlaVersion (DtHlaVersionId version)
 Set/Get message component values. More...
 
virtual DtHlaVersionId hlaVersion () const
 Set/Get message component values. More...
 
virtual void setAssistantCompId (int id)
 Set/Get message component values. More...
 
virtual int assistantCompId () 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 setNeedPartner (unsigned int value)
 Set/Get message component values. More...
 
virtual unsigned int needPartner () const
 Set/Get message component values. More...
 
unsigned int numOfCrcs () const
 Set/Get message component values. More...
 
void setNumOfCrcs (unsigned int value)
 Set/Get message component values. More...
 
virtual void setCrcsOfFedFiles (const std::vector< unsigned int > &moduleCrcs, bool adjustBufferSize=true)
 Set/Get message component values. More...
 
virtual void getCRCsOfFedFiles (std::vector< unsigned int > &crcOfFedFiles) const
 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, DtJoinCb cb, void *usr)
 Callback management. More...
 
static void removeCallback (DtConnectionMgr *conn, DtJoinCb cb, void *usr)
 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 Join Msg. More...
 
virtual int minSize () const
 Return the minimum buffer size needed for this message. More...
 
virtual int minSize (MAKRti::DtString const &federateType, MAKRti::DtString const &fedExName, MAKRti::DtString const &federateName, MAKRti::DtString const &federateHostName, const std::wstring &credentialsType, int credentialsDataSize, const std::vector< MAKRti::DtString > &fomModuleNamesVal, const std::vector< unsigned int > &joinModulesCrcs)
 Return the buffer size needed for this message with the given variable data. More...
 
virtual DtJoinMsgself () const
 Casts away const-ness. More...
 
virtual DtNetJoinMsgnetJoinMsg ()
 The network representation. More...
 
virtual const DtNetJoinMsgnetJoinMsg () const
 The network representation. More...
 
virtual void setFederateTypeSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long federateTypeSize () const
 Set/Get the size of variable sized components. 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 setFederateHostNameSize (unsigned long size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned long federateHostNameSize () 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 void setNumberFomModules (unsigned int count)
 Set/Get the size of variable sized components. More...
 
virtual unsigned int numberFomModules () const
 Set/Get the size of variable sized components. More...
 
virtual void setCredentialsTypeSize (unsigned short size)
 Set/Get the size of variable sized components. More...
 
virtual unsigned short credentialsTypeSize () const
 Set/Get the size of variable sized components. More...
 
virtual void setCredentialsDataSize (unsigned short size)
 credentialsDataSize getter is public More...
 
virtual const char * federateNamePtr () 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 * fedExNamePtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * fedExNamePtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * federateTypePtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * federateTypePtr ()
 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 * fomModuleNamesPtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * federateHostNamePtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * federateHostNamePtr ()
 Get the pointer to the variable sized components. More...
 
virtual const DtNetU32 * crcsOfFomModulesPtr () const
 Get the pointer to the variable sized components. More...
 
virtual DtNetU32 * crcsOfFomModulesPtr ()
 Get the pointer to the variable sized components. More...
 
virtual const DtNetU16 * credentialsTypePtr () const
 Get the pointer to the variable sized components. More...
 
virtual DtNetU16 * credentialsTypePtr ()
 Get the pointer to the variable sized components. More...
 
virtual const char * credentialsDataPtr () const
 Get the pointer to the variable sized components. More...
 
virtual char * credentialsDataPtr ()
 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...
 

Additional Inherited Members

- Static Public Attributes inherited from DtRtiMsg
static unsigned long theDefaultRegionSetHandle
 
static const
DtRtiApiVariableLengthData 
theDefaultTag
 
- 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
 
- Static Protected Attributes inherited from DtRtiMsg
static bool theUse32BitsForValueSize
 
static bool theSmartForwardingEnabled
 

Constructor & Destructor Documentation

DtJoinMsg::DtJoinMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

DtJoinMsg::DtJoinMsg ( unsigned long  sourceIDValue,
unsigned short  requestIDValue,
MAKRti::DtString const &  fedTypeValue,
MAKRti::DtString const &  fedExNameValue,
MAKRti::DtString const &  fedNameValue,
MAKRti::DtString const &  federateHostNameValue,
const std::wstring &  credentialsType,
char const *  credentialsData,
int  credentialsDataSize,
const std::vector< MAKRti::DtString > &  moduleNames,
DtHlaVersionId  hlaVersion,
int  astntCompId,
unsigned long  flagsValue,
unsigned int  needPartnerValue,
const std::vector< unsigned int > &  joinModulesCrcs,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

DtJoinMsg::DtJoinMsg ( const DtNetJoinMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

virtual DtJoinMsg::~DtJoinMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtJoinMsg::addCallback ( DtConnectionMgr conn,
DtJoinCb  cb,
void *  usr 
)
static

Callback management.

virtual int DtJoinMsg::assistantCompId ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

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

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

Implements DtRtiMsg.

virtual const DtNetU32* DtJoinMsg::crcsOfFomModulesPtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual DtNetU32* DtJoinMsg::crcsOfFomModulesPtr ( )
protectedvirtual

Get the pointer to the variable sized components.

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

Creator for receiving.

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

Creator for sending.

virtual void const* DtJoinMsg::credentialsData ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual const char* DtJoinMsg::credentialsDataPtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual char* DtJoinMsg::credentialsDataPtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned short DtJoinMsg::credentialsDataSize ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual std::wstring DtJoinMsg::credentialsType ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual const DtNetU16* DtJoinMsg::credentialsTypePtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual DtNetU16* DtJoinMsg::credentialsTypePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned short DtJoinMsg::credentialsTypeSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual MAKRti::DtString DtJoinMsg::federateHostName ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual const char* DtJoinMsg::federateHostNamePtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual char* DtJoinMsg::federateHostNamePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinMsg::federateHostNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

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

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

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

Get the pointer to the variable sized components.

virtual char* DtJoinMsg::federateNamePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinMsg::federateNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual MAKRti::DtString DtJoinMsg::federateType ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual const char* DtJoinMsg::federateTypePtr ( ) const
protectedvirtual

Get the pointer to the variable sized components.

virtual char* DtJoinMsg::federateTypePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinMsg::federateTypeSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

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

Get the pointer to the variable sized components.

virtual char* DtJoinMsg::fedExNamePtr ( )
protectedvirtual

Get the pointer to the variable sized components.

virtual unsigned long DtJoinMsg::fedExNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

virtual unsigned long DtJoinMsg::flags ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual unsigned long DtJoinMsg::fomModuleNameSize ( ) const
protectedvirtual

Set/Get the size of variable sized components.

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

Get the pointer to the variable sized components.

virtual char* DtJoinMsg::fomModuleNamesPtr ( )
protectedvirtual

Get the pointer to the variable sized components.

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

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::getCRCsOfFedFiles ( std::vector< unsigned int > &  crcOfFedFiles) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual std::vector<char>& DtJoinMsg::getCredentialsData ( std::vector< char > &  data) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual std::wstring& DtJoinMsg::getCredentialsType ( std::wstring &  type) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::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 source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual DtHlaVersionId DtJoinMsg::hlaVersion ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual DtRtiMsgKind DtJoinMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an Join Msg.

Implements DtRtiMsg.

virtual MAKRti::DtInetAddr DtJoinMsg::ipAddress ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual int DtJoinMsg::minSize ( ) const
protectedvirtual

Return the minimum buffer size needed for this message.

virtual int DtJoinMsg::minSize ( MAKRti::DtString const &  federateType,
MAKRti::DtString const &  fedExName,
MAKRti::DtString const &  federateName,
MAKRti::DtString const &  federateHostName,
const std::wstring &  credentialsType,
int  credentialsDataSize,
const std::vector< MAKRti::DtString > &  fomModuleNamesVal,
const std::vector< unsigned int > &  joinModulesCrcs 
)
protectedvirtual

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

virtual unsigned int DtJoinMsg::needPartner ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual DtNetJoinMsg* DtJoinMsg::netJoinMsg ( )
protectedvirtual

The network representation.

virtual const DtNetJoinMsg* DtJoinMsg::netJoinMsg ( ) const
protectedvirtual

The network representation.

virtual unsigned int DtJoinMsg::numberFomModules ( ) const
protectedvirtual

Set/Get the size of variable sized components.

unsigned int DtJoinMsg::numOfCrcs ( ) const

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

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

Print the data section.

Reimplemented from DtRtiMsg.

static void DtJoinMsg::removeCallback ( DtConnectionMgr conn,
DtJoinCb  cb,
void *  usr 
)
static

Callback management.

virtual unsigned short DtJoinMsg::requestID ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

DtJoinMsg * DtJoinMsg::self ( ) const
inlineprotectedvirtual

Casts away const-ness.

virtual void DtJoinMsg::set ( unsigned long  sourceIDValue,
unsigned short  requestIDValue,
MAKRti::DtString const &  fedTypeValue,
MAKRti::DtString const &  fedExNameValue,
MAKRti::DtString const &  fedNameValue,
MAKRti::DtString const &  federateHostNameValue,
const std::wstring &  credentialsType,
char const *  credentialsData,
int  credentialsDataSize,
const std::vector< MAKRti::DtString > &  moduleNames,
DtHlaVersionId  hlaVersion,
int  astntCompId,
unsigned long  flagsValue,
unsigned int  needPartnerValue,
const std::vector< unsigned int > &  joinModulesCrcs,
bool  adjustBufferSize = true 
)
virtual

Set all fields simultaneously.

virtual void DtJoinMsg::setAssistantCompId ( int  id)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setCrcsOfFedFiles ( const std::vector< unsigned int > &  moduleCrcs,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setCredentialsData ( void const *  data,
unsigned short  size,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setCredentialsData ( const std::vector< char > &  data,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setCredentialsDataSize ( unsigned short  size)
protectedvirtual

credentialsDataSize getter is public

virtual void DtJoinMsg::setCredentialsType ( const std::wstring &  type,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setCredentialsTypeSize ( unsigned short  size)
protectedvirtual

Set/Get the size of variable sized components.

virtual void DtJoinMsg::setFederateHostName ( 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 source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setFederateHostNameSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

virtual void DtJoinMsg::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 source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

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

Set/Get the size of variable sized components.

virtual void DtJoinMsg::setFederateType ( MAKRti::DtString const &  type,
bool  adjustBufferSize = true 
)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setFederateTypeSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

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

Set/Get the size of variable sized components.

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

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::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 source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setFomModuleNameSize ( unsigned long  size)
protectedvirtual

Set/Get the size of variable sized components.

virtual void DtJoinMsg::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 source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setHlaVersion ( DtHlaVersionId  version)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setIpAddress ( const MAKRti::DtInetAddr &  ip)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setNeedPartner ( unsigned int  value)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setNumberFomModules ( unsigned int  count)
protectedvirtual

Set/Get the size of variable sized components.

void DtJoinMsg::setNumOfCrcs ( unsigned int  value)

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

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

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual void DtJoinMsg::setSourceID ( unsigned long  sourceIDValue)
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).

virtual unsigned long DtJoinMsg::sourceID ( ) const
virtual

Set/Get message component values.

The federate name is not enough to uniquely identify it among other federates. This source ID should uniquely identify the federate (at least in conjunction with name). (at least in conjunction with name).


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)