MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtJoinMsg Class Reference
+ Inheritance diagram for DtJoinMsg:
+ Collaboration diagram for DtJoinMsg:

List of all members.

Public Member Functions

 DtJoinMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 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::vector< MAKRti::DtString > &moduleNames, DtHlaVersionId hlaVersion, unsigned long flagsValue, unsigned int needPartnerValue, const std::vector< unsigned int > &joinModulesCrcs, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtJoinMsg (const DtNetJoinMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtJoinMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
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::vector< MAKRti::DtString > &moduleNames, DtHlaVersionId hlaVersion, unsigned long flagsValue, unsigned int needPartnerValue, const std::vector< unsigned int > &joinModulesCrcs)
 Set all fields simultaneously.
virtual unsigned long sourceID () const
 Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.
virtual void setSourceID (unsigned long sourceIDValue)
virtual unsigned short requestID () const
 Set/Get request ID.
virtual void setRequestID (unsigned short requestIDValue)
virtual void setFederateType (MAKRti::DtString const &type)
 Set/Get federate type.
virtual MAKRti::DtString federateType () const
virtual void setFullFedExName (MAKRti::DtString const &name)
 Set/Get full name of federation execution.
virtual MAKRti::DtString fullFedExName () const
virtual void setFederateName (MAKRti::DtString const &name)
 Set/Get federate name.
virtual MAKRti::DtString federateName () const
virtual void setFederateHostName (MAKRti::DtString const &name)
 Set / Get fed host name.
virtual MAKRti::DtString federateHostName () const
virtual void setFomModuleNames (const std::vector< MAKRti::DtString > &moduleNames)
 Set/Get Fom Module Names.
virtual void getFomModuleNames (std::vector< MAKRti::DtString > &modules) const
virtual void setIpAddress (const MAKRti::DtInetAddr &ip)
 Set/Get federate IP address ( by default message will contain address of primary interface )
virtual MAKRti::DtInetAddr ipAddress () const
virtual MAKRti::DtInetAddr webServerAddress () const
 Set/Get the federate's web werver IP address.
virtual void setWebServerAddress (const MAKRti::DtInetAddr &ip)
virtual int webServerPort () const
 Get/Set the federate's web server HTTP port.
virtual void setWebServerPort (int port)
virtual void setHlaVersion (DtHlaVersionId version)
 Set/Get the HLA version of the federate.
virtual DtHlaVersionId hlaVersion () const
virtual void setFlags (unsigned long value)
 Set/Get flags.
virtual unsigned long flags () const
virtual void setNeedPartner (unsigned int value)
 Set/Get need partner indicator.
virtual unsigned int needPartner () const
unsigned int numOfCrcs () const
 Set/Get number of CRCs.
void setNumOfCrcs (unsigned int value)
virtual void setCrcsOfFedFiles (const std::vector< unsigned int > &moduleCrcs)
 Set/Get CRCs of Fed Files.
virtual void getCRCsOfFedFiles (std::vector< unsigned int > &crcOfFedFiles) const
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, DtJoinCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtJoinCb cb, void *usr)

Protected Member Functions

virtual DtNetJoinMsgnetJoinMsg ()
 The network representation.
virtual const DtNetJoinMsgnetJoinMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Join Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual int setMinSizes (MAKRti::DtString const &federateType, MAKRti::DtString const &fedExName, MAKRti::DtString const &federateName, MAKRti::DtString const &federateHostName, const std::vector< MAKRti::DtString > &fomModuleNamesVal, const std::vector< unsigned int > &joinModulesCrcs)
 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 setFederateTypeSize (unsigned long size)
 Set/Get fed type size.
virtual unsigned long federateTypeSize () const
virtual void setFedExNameSize (unsigned long size)
 Set/Get fedEx name size.
virtual unsigned long fedExNameSize () const
virtual void setFederateNameSize (unsigned long size)
 Set/Get fed name size.
virtual unsigned long federateNameSize () const
virtual void setFederateHostNameSize (unsigned long size)
 Set Get size of federate host name.
virtual unsigned long federateHostNameSize () const
virtual void setfomModuleNameSize (unsigned long size)
 Set/Get fomModules Names Size.
virtual unsigned long fomModuleNameSize () const
virtual const char * federateNamePtr () const
 Return pointer to component location in message.
virtual const char * fedExNamePtr () const
virtual const char * federateTypePtr () const
virtual const char * fomModuleNamesPtr () const
virtual const char * federateHostNamePtr () const
virtual const DtNetU32 * crcsOfFomModulesPtr () const
virtual char * federateNamePtr ()
virtual char * fedExNamePtr ()
virtual char * federateTypePtr ()
virtual char * fomModuleNamesPtr ()
virtual char * federateHostNamePtr ()
virtual DtNetU32 * crcsOfFomModulesPtr ()
virtual DtJoinMsgself () const
 Casts away const-ness.

Constructor & Destructor Documentation

DtJoinMsg::DtJoinMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
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::vector< MAKRti::DtString > &  moduleNames,
DtHlaVersionId  hlaVersion,
unsigned long  flagsValue,
unsigned int  needPartnerValue,
const std::vector< unsigned int > &  joinModulesCrcs,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtJoinMsg::DtJoinMsg ( const DtNetJoinMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

References DtNetJoinMsg::header, and DtRtiMsg::initDtRtiMsg().

DtJoinMsg::~DtJoinMsg ( ) [virtual]

Destructor.


Member Function Documentation

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

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtJoinMsgKind.

Referenced by DtFedExec::DtFedExec(), and DtRtiExec::DtRtiExec().

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

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

Implements DtRtiMsg.

References DtJoinMsg(), and netJoinMsg().

const DtNetU32 * DtJoinMsg::crcsOfFomModulesPtr ( ) const [protected, virtual]
DtNetU32 * DtJoinMsg::crcsOfFomModulesPtr ( ) [protected, virtual]

References netJoinMsg().

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

Creator.

References DtJoinMsg().

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

Creator.

References DtJoinMsg().

MAKRti::DtString DtJoinMsg::federateHostName ( ) const [virtual]
const char * DtJoinMsg::federateHostNamePtr ( ) const [protected, virtual]
char * DtJoinMsg::federateHostNamePtr ( ) [protected, virtual]
unsigned long DtJoinMsg::federateHostNameSize ( ) const [protected, virtual]
MAKRti::DtString DtJoinMsg::federateName ( ) const [virtual]
const char * DtJoinMsg::federateNamePtr ( ) const [protected, virtual]

Return pointer to component location in message.

References fedExNamePtr(), and fedExNameSize().

Referenced by federateHostNamePtr(), federateName(), and setFederateName().

char * DtJoinMsg::federateNamePtr ( ) [protected, virtual]

References fedExNamePtr(), and fedExNameSize().

unsigned long DtJoinMsg::federateNameSize ( ) const [protected, virtual]
MAKRti::DtString DtJoinMsg::federateType ( ) const [virtual]
const char * DtJoinMsg::federateTypePtr ( ) const [protected, virtual]
char * DtJoinMsg::federateTypePtr ( ) [protected, virtual]
unsigned long DtJoinMsg::federateTypeSize ( ) const [protected, virtual]
const char * DtJoinMsg::fedExNamePtr ( ) const [protected, virtual]
char * DtJoinMsg::fedExNamePtr ( ) [protected, virtual]
unsigned long DtJoinMsg::fedExNameSize ( ) const [protected, virtual]
unsigned long DtJoinMsg::flags ( ) const [virtual]
unsigned long DtJoinMsg::fomModuleNameSize ( ) const [protected, virtual]
const char * DtJoinMsg::fomModuleNamesPtr ( ) const [protected, virtual]
char * DtJoinMsg::fomModuleNamesPtr ( ) [protected, virtual]
MAKRti::DtString DtJoinMsg::fullFedExName ( ) const [virtual]
void DtJoinMsg::getCRCsOfFedFiles ( std::vector< unsigned int > &  crcOfFedFiles) const [virtual]
void DtJoinMsg::getFomModuleNames ( std::vector< MAKRti::DtString > &  modules) const [virtual]

Returns the kind of an Join Msg.

Implements DtRtiMsg.

References DtJoinMsgKind.

Referenced by DtJoinMsg().

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

References netJoinMsg().

Referenced by printData(), and DtFedExec::processJoinMsg().

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

Returns minimum size of a message, including header.

Referenced by DtJoinMsg(), and set().

unsigned int DtJoinMsg::needPartner ( ) const [virtual]
DtNetJoinMsg * DtJoinMsg::netJoinMsg ( ) [protected, virtual]
const DtNetJoinMsg * DtJoinMsg::netJoinMsg ( ) const [protected, virtual]
unsigned int DtJoinMsg::numOfCrcs ( ) const

Set/Get number of CRCs.

References netJoinMsg(), and DtNetJoinMsg::numOfCrcs.

Referenced by fedExNamePtr(), getCRCsOfFedFiles(), and setCrcsOfFedFiles().

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

Casts away const-ness.

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::vector< MAKRti::DtString > &  moduleNames,
DtHlaVersionId  hlaVersion,
unsigned long  flagsValue,
unsigned int  needPartnerValue,
const std::vector< unsigned int > &  joinModulesCrcs 
) [virtual]
void DtJoinMsg::setCrcsOfFedFiles ( const std::vector< unsigned int > &  moduleCrcs) [virtual]

Set/Get CRCs of Fed Files.

References crcsOfFomModulesPtr(), rti1516e::insertBytes(), numOfCrcs(), and setNumOfCrcs().

Referenced by DtJoinMsg(), and set().

void DtJoinMsg::setFederateHostName ( MAKRti::DtString const &  name) [virtual]
void DtJoinMsg::setFederateHostNameSize ( unsigned long  size) [protected, virtual]

Set Get size of federate host name.

References DtNetJoinMsg::fedHostNameSize, and netJoinMsg().

Referenced by setFederateHostName(), and setMinSizes().

void DtJoinMsg::setFederateName ( MAKRti::DtString const &  name) [virtual]

Set/Get federate name.

References federateNamePtr(), federateNameSize(), rti1516e::insertBytes(), and setFederateNameSize().

Referenced by DtJoinMsg(), and set().

void DtJoinMsg::setFederateNameSize ( unsigned long  size) [protected, virtual]

Set/Get fed name size.

References DtNetJoinMsg::fedNameSize, and netJoinMsg().

Referenced by setFederateName(), and setMinSizes().

void DtJoinMsg::setFederateType ( MAKRti::DtString const &  type) [virtual]

Set/Get federate type.

References federateTypePtr(), federateTypeSize(), rti1516e::insertBytes(), and setFederateTypeSize().

Referenced by DtJoinMsg(), and set().

void DtJoinMsg::setFederateTypeSize ( unsigned long  size) [protected, virtual]

Set/Get fed type size.

References DtNetJoinMsg::fedTypeSize, and netJoinMsg().

Referenced by setFederateType(), and setMinSizes().

void DtJoinMsg::setFedExNameSize ( unsigned long  size) [protected, virtual]

Set/Get fedEx name size.

References DtNetJoinMsg::fedExNameSize, and netJoinMsg().

Referenced by setMinSizes().

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

Set/Get flags.

References DtNetJoinMsg::flags, and netJoinMsg().

Referenced by DtJoinMsg(), and set().

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

Set/Get fomModules Names Size.

References DtNetJoinMsg::fomModuleNamesSize, and netJoinMsg().

Referenced by setFomModuleNames(), and setMinSizes().

void DtJoinMsg::setFullFedExName ( MAKRti::DtString const &  name) [virtual]

Set/Get full name of federation execution.

References fedExNamePtr(), DtNetJoinMsg::fedExNameSize, fedExNameSize(), rti1516e::insertBytes(), and netJoinMsg().

Referenced by DtJoinMsg(), and set().

void DtJoinMsg::setHlaVersion ( DtHlaVersionId  version) [virtual]

Set/Get the HLA version of the federate.

References DtNetJoinMsg::hlaVersion, and netJoinMsg().

Referenced by DtJoinMsg(), and set().

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

Set/Get federate IP address ( by default message will contain address of primary interface )

References DtNetJoinMsg::inetAddrFamily, netJoinMsg(), and DtNetJoinMsg::sourceIP.

Referenced by DtJoinMsg(), and DtRtiExecFederateMgr::sendJoinMsg().

int DtJoinMsg::setMinSizes ( MAKRti::DtString const &  federateType,
MAKRti::DtString const &  fedExName,
MAKRti::DtString const &  federateName,
MAKRti::DtString const &  federateHostName,
const std::vector< MAKRti::DtString > &  fomModuleNamesVal,
const std::vector< unsigned int > &  joinModulesCrcs 
) [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 DtJoinMsg(), setFederateHostNameSize(), setFederateNameSize(), setFederateTypeSize(), setFedExNameSize(), setfomModuleNameSize(), and setNumOfCrcs().

Referenced by DtJoinMsg(), and set().

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

Set/Get need partner indicator.

References DtNetJoinMsg::needPartner, and netJoinMsg().

Referenced by DtJoinMsg(), and set().

void DtJoinMsg::setNumOfCrcs ( unsigned int  value)
void DtJoinMsg::setRequestID ( unsigned short  requestIDValue) [virtual]

References netJoinMsg(), and DtNetJoinMsg::requestID.

Referenced by DtJoinMsg(), and set().

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

References netJoinMsg(), and DtNetJoinMsg::sourceID.

Referenced by DtJoinMsg(), and set().

void DtJoinMsg::setWebServerAddress ( const MAKRti::DtInetAddr &  ip) [virtual]
void DtJoinMsg::setWebServerPort ( int  port) [virtual]
unsigned long DtJoinMsg::sourceID ( ) const [virtual]

Set/Get federate destination ID 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).

References netJoinMsg(), and DtNetJoinMsg::sourceID.

Referenced by DtFedExec::handleJoinFailureCases(), DtFederateTrackingFilter::handleJoinMsg(), printData(), DtForwarderFaultManager::processJoin(), DtRtiExec::processJoin(), DtFedExec::processJoinMsg(), and DtFedExec::requestFedFileUpload().

MAKRti::DtInetAddr DtJoinMsg::webServerAddress ( ) const [virtual]

Set/Get the federate's web werver IP address.

References netJoinMsg().

Referenced by printData(), and DtFedExec::processJoinMsg().

int DtJoinMsg::webServerPort ( ) const [virtual]

Get/Set the federate's web server HTTP port.

References netJoinMsg(), and DtNetJoinMsg::webServerPort.

Referenced by printData(), and DtFedExec::processJoinMsg().


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)