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

List of all members.

Public Member Functions

 DtReportFederationsMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtReportFederationsMsg (unsigned long ID, const std::vector< MAKRti::DtString > &federationNames, const std::vector< MAKRti::DtString > &timeImplNames, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtReportFederationsMsg (const DtNetReportFederationsMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtReportFederationsMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (unsigned long ID, const std::vector< MAKRti::DtString > &federationNames, const std::vector< MAKRti::DtString > &timeImplNames)
 Set all fields simultaneously.
void setDestinationID (unsigned long ID)
 Set/Get Destination Federate ID.
const unsigned long destinationID () const
virtual void setFederationNames (const std::vector< MAKRti::DtString > &names)
 Set/Get federation names.
virtual void getFederationNames (std::vector< MAKRti::DtString > &names) const
virtual void setTimeImplementationNames (const std::vector< MAKRti::DtString > &names)
 Set/Get federation logical time implementation names.
virtual void getTimeImplementationNames (std::vector< MAKRti::DtString > &names) 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, DtReportFederationsCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtReportFederationsCb cb, void *usr)

Protected Member Functions

virtual DtNetReportFederationsMsgnetReportFederationsMsg ()
 The network representation.
virtual const
DtNetReportFederationsMsg
netReportFederationsMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of a report federations msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual int setMinSizes (const std::vector< MAKRti::DtString > &federationNames, const std::vector< MAKRti::DtString > &timeImplNames)
 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 setFederationNamesSize (unsigned long size)
 Set/Get federation names size.
virtual unsigned long federationNamesSize () const
virtual void setTimeImplementationNamesSize (unsigned long size)
 Set/Get time implemenatation names size.
virtual unsigned long timeImplementationNamesSize () const
virtual const char * federationNamesPtr () const
 Return pointer to component location in message.
virtual const char * timeImplementationNamesPtr () const
virtual char * federationNamesPtr ()
virtual char * timeImplementationNamesPtr ()
virtual DtReportFederationsMsgself () const
 Casts away const-ness.

Constructor & Destructor Documentation

DtReportFederationsMsg::DtReportFederationsMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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

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

DtReportFederationsMsg::DtReportFederationsMsg ( unsigned long  ID,
const std::vector< MAKRti::DtString > &  federationNames,
const std::vector< MAKRti::DtString > &  timeImplNames,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtReportFederationsMsg::DtReportFederationsMsg ( const DtNetReportFederationsMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

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

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

Implements DtRtiMsg.

References DtReportFederationsMsg(), and netReportFederationsMsg().

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

Creator.

References DtReportFederationsMsg().

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

Creator.

References DtReportFederationsMsg().

const unsigned long DtReportFederationsMsg::destinationID ( ) const
const char * DtReportFederationsMsg::federationNamesPtr ( ) const [protected, virtual]

Return pointer to component location in message.

References netReportFederationsMsg().

Referenced by getFederationNames(), setFederationNames(), and timeImplementationNamesPtr().

char * DtReportFederationsMsg::federationNamesPtr ( ) [protected, virtual]
unsigned long DtReportFederationsMsg::federationNamesSize ( ) const [protected, virtual]
void DtReportFederationsMsg::getFederationNames ( std::vector< MAKRti::DtString > &  names) const [virtual]
void DtReportFederationsMsg::getTimeImplementationNames ( std::vector< MAKRti::DtString > &  names) const [virtual]

Returns the kind of a report federations msg.

Implements DtRtiMsg.

References DtReportFederationsMsgKind.

Referenced by DtReportFederationsMsg().

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

Returns minimum size of a message, including header.

Referenced by DtReportFederationsMsg(), and set().

void DtReportFederationsMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References getFederationNames(), and getTimeImplementationNames().

void DtReportFederationsMsg::removeCallback ( DtConnectionMgr conn,
DtReportFederationsCb  cb,
void *  usr 
) [static]
DtReportFederationsMsg * DtReportFederationsMsg::self ( ) const [inline, protected, virtual]

Casts away const-ness.

void DtReportFederationsMsg::set ( unsigned long  ID,
const std::vector< MAKRti::DtString > &  federationNames,
const std::vector< MAKRti::DtString > &  timeImplNames 
) [virtual]
void DtReportFederationsMsg::setDestinationID ( unsigned long  ID)

Set/Get Destination Federate ID.

References DtNetReportFederationsMsg::destinationID, and netReportFederationsMsg().

Referenced by DtReportFederationsMsg(), and set().

void DtReportFederationsMsg::setFederationNames ( const std::vector< MAKRti::DtString > &  names) [virtual]
void DtReportFederationsMsg::setFederationNamesSize ( unsigned long  size) [protected, virtual]

Set/Get federation names size.

References DtNetReportFederationsMsg::federationNamesSize, and netReportFederationsMsg().

Referenced by setFederationNames(), and setMinSizes().

int DtReportFederationsMsg::setMinSizes ( const std::vector< MAKRti::DtString > &  federationNames,
const std::vector< MAKRti::DtString > &  timeImplNames 
) [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 DtReportFederationsMsg(), setFederationNamesSize(), and setTimeImplementationNamesSize().

Referenced by DtReportFederationsMsg(), and set().

void DtReportFederationsMsg::setTimeImplementationNames ( const std::vector< MAKRti::DtString > &  names) [virtual]
void DtReportFederationsMsg::setTimeImplementationNamesSize ( unsigned long  size) [protected, virtual]

Set/Get time implemenatation names size.

References netReportFederationsMsg(), and DtNetReportFederationsMsg::timeImplNamesSize.

Referenced by setMinSizes(), and setTimeImplementationNames().

const char * DtReportFederationsMsg::timeImplementationNamesPtr ( ) const [protected, virtual]
char * DtReportFederationsMsg::timeImplementationNamesPtr ( ) [protected, virtual]
unsigned long DtReportFederationsMsg::timeImplementationNamesSize ( ) const [protected, virtual]

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)