MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtFomModuleRequestMsg Class Reference

Sent by Federates to request fed file from RtiExec. More...

+ Inheritance diagram for DtFomModuleRequestMsg:
+ Collaboration diagram for DtFomModuleRequestMsg:

List of all members.

Public Member Functions

 DtFomModuleRequestMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Default / Send constructor.
 DtFomModuleRequestMsg (unsigned long ID, unsigned long destID, const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &moduleNames, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtFomModuleRequestMsg (const DtNetFomModuleReqMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Recv Constructor (from incoming message)
virtual ~DtFomModuleRequestMsg ()
 Destructor.
DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (unsigned long ID, unsigned long destID, const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &fomModuleName)
void setSourceID (unsigned long ID)
 Set/Get Source ID.
unsigned long sourceID () const
void setDestinationID (unsigned long ID)
 Set/Get Destination Federate ID.
unsigned long destinationID () const
virtual void setFullFedExName (const MAKRti::DtString &fedExNameVal)
 Set/Get Federation Name.
virtual MAKRti::DtString fullFedExName () const
virtual void setFomModuleNames (std::vector< MAKRti::DtString > const &fomModuleName)
 Set/Get Fom Module Name.
virtual void getFomModuleNames (std::vector< MAKRti::DtString > &modules) 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 for receiving.
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator for sending.
static void addCallback (DtConnectionMgr *conn, DtFomModuleReqCb cb, void *usr)
 Add / Remove Callbacks.
static void removeCallback (DtConnectionMgr *conn, DtFomModuleReqCb cb, void *usr)

Protected Member Functions

virtual const
DtNetFomModuleReqMsg
netFomModuleReqMsg () const
 The network representation.
virtual DtNetFomModuleReqMsgnetFomModuleReqMsg ()
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Create Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual int setMinSizes (const MAKRti::DtString &fedExNameVal, std::vector< MAKRti::DtString > const &fomModulesNamesVal)
 Sets the field sizes for the variant components and returns the minimum size needed for the message, including header DOES NOT allocate memory for the components.
virtual void setFedExNameSize (unsigned long size)
 Set/Get fedExNameSize.
virtual unsigned int fedExNameSize () const
virtual void setFomModuleNameSize (unsigned long size)
 Set/Get fed fomModuleName size.
virtual unsigned int fomModuleNameSize () const
virtual char * fedExNamePtr ()
 Return pointer to component location in message.
virtual char * fomModuleNamesPtr ()
virtual const char * fedExNamePtr () const
 Const version: Return pointer to component location in message.
virtual const char * fomModuleNamesPtr () const
virtual DtFomModuleRequestMsgself () const

Detailed Description

Sent by Federates to request fed file from RtiExec.


Constructor & Destructor Documentation

DtFomModuleRequestMsg::DtFomModuleRequestMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Default / Send constructor.

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

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

DtFomModuleRequestMsg::DtFomModuleRequestMsg ( unsigned long  ID,
unsigned long  destID,
const MAKRti::DtString &  fedExNameVal,
std::vector< MAKRti::DtString > const &  moduleNames,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtFomModuleRequestMsg::DtFomModuleRequestMsg ( const DtNetFomModuleReqMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Recv Constructor (from incoming message)

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

Destructor.


Member Function Documentation

void DtFomModuleRequestMsg::addCallback ( DtConnectionMgr conn,
DtFomModuleReqCb  cb,
void *  usr 
) [static]
DtRtiMsg * DtFomModuleRequestMsg::clone ( bool  copy = true) const [virtual]

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

Implements DtRtiMsg.

References DtFomModuleRequestMsg(), and netFomModuleReqMsg().

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

Creator for receiving.

References DtFomModuleRequestMsg().

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

Creator for sending.

References DtFomModuleRequestMsg().

unsigned long DtFomModuleRequestMsg::destinationID ( ) const
char * DtFomModuleRequestMsg::fedExNamePtr ( ) [protected, virtual]

Return pointer to component location in message.

References netFomModuleReqMsg().

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

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

Const version: Return pointer to component location in message.

References netFomModuleReqMsg().

unsigned int DtFomModuleRequestMsg::fedExNameSize ( ) const [protected, virtual]
unsigned int DtFomModuleRequestMsg::fomModuleNameSize ( ) const [protected, virtual]
char * DtFomModuleRequestMsg::fomModuleNamesPtr ( ) [protected, virtual]
const char * DtFomModuleRequestMsg::fomModuleNamesPtr ( ) const [protected, virtual]

References fedExNamePtr(), and fedExNameSize().

MAKRti::DtString DtFomModuleRequestMsg::fullFedExName ( ) const [virtual]
void DtFomModuleRequestMsg::getFomModuleNames ( std::vector< MAKRti::DtString > &  modules) const [virtual]

Returns the kind of an Create Msg.

Implements DtRtiMsg.

References DtFomModuleRequestMsgKind.

Referenced by DtFomModuleRequestMsg().

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

Returns minimum size of a message, including header.

References DtFomModuleRequestMsg().

Referenced by DtFomModuleRequestMsg(), and set().

const DtNetFomModuleReqMsg * DtFomModuleRequestMsg::netFomModuleReqMsg ( ) const [protected, virtual]
void DtFomModuleRequestMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References destinationID(), fullFedExName(), getFomModuleNames(), netFomModuleReqMsg(), and sourceID().

void DtFomModuleRequestMsg::removeCallback ( DtConnectionMgr conn,
DtFomModuleReqCb  cb,
void *  usr 
) [static]
DtFomModuleRequestMsg * DtFomModuleRequestMsg::self ( ) const [inline, protected, virtual]
void DtFomModuleRequestMsg::set ( unsigned long  ID,
unsigned long  destID,
const MAKRti::DtString &  fedExNameVal,
std::vector< MAKRti::DtString > const &  fomModuleName 
) [virtual]
void DtFomModuleRequestMsg::setDestinationID ( unsigned long  ID)

Set/Get Destination Federate ID.

References DtNetFomModuleReqMsg::destinationID, and netFomModuleReqMsg().

Referenced by DtFomModuleRequestMsg(), and set().

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

Set/Get fedExNameSize.

References DtNetFomModuleReqMsg::fedExNameSize, and netFomModuleReqMsg().

Referenced by setMinSizes().

void DtFomModuleRequestMsg::setFomModuleNames ( std::vector< MAKRti::DtString > const &  fomModuleName) [virtual]
void DtFomModuleRequestMsg::setFomModuleNameSize ( unsigned long  size) [protected, virtual]

Set/Get fed fomModuleName size.

References DtNetFomModuleReqMsg::fomModuleNameSize, and netFomModuleReqMsg().

Referenced by setMinSizes().

void DtFomModuleRequestMsg::setFullFedExName ( const MAKRti::DtString &  fedExNameVal) [virtual]
int DtFomModuleRequestMsg::setMinSizes ( const MAKRti::DtString &  fedExNameVal,
std::vector< MAKRti::DtString > const &  fomModulesNamesVal 
) [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 DtFomModuleRequestMsg(), setFedExNameSize(), and setFomModuleNameSize().

Referenced by DtFomModuleRequestMsg(), and set().

void DtFomModuleRequestMsg::setSourceID ( unsigned long  ID)

Set/Get Source ID.

References netFomModuleReqMsg(), and DtNetFomModuleReqMsg::sourceID.

Referenced by DtFomModuleRequestMsg(), and set().

unsigned long DtFomModuleRequestMsg::sourceID ( ) const

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)