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

List of all members.

Public Member Functions

 DtRestoreBegunMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtRestoreBegunMsg (DtFederateHandle requestingFederateVal, const char *labelVal, DtResponseFlag flag, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtRestoreBegunMsg (const DtNetSaveResponseMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtRestoreBegunMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (DtFederateHandle requestingFederateVal, const char *theLabel, DtResponseFlag flag)
 Set all parameters simultaneously.
void setRequestingFederate (DtFederateHandle requestingFederateVal)
 Set/Get requesting federate.
DtFederateHandle requestingFederate () const
virtual void setLabel (const char *label)
 Set/Get tag.
virtual const char * label () const
void setResponseFlag (DtResponseFlag flag)
 Set/Get response flag.
DtResponseFlag responseFlag () 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, DtRestoreBegunCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtRestoreBegunCb cb, void *usr)

Protected Member Functions

virtual DtNetSaveResponseMsgnetRestoreBegunMsg ()
 The network representation.
virtual const
DtNetSaveResponseMsg
netRestoreBegunMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an RestoreBegun Msg.
virtual char * labelPtr ()
 Returns pointer to the label in the netMsg.
virtual int labelFieldSize () const
 Returns size of label field.
virtual void setLabelSize (int size)
 Set/Get tag size.
virtual int labelSize () const
virtual int minSize (const char *theLabel=NULL) const
 Returns minimum size of a message, including header.
virtual DtRestoreBegunMsgself () const
 Casts away const-ness.

Protected Attributes

char * myLabel

Constructor & Destructor Documentation

DtRestoreBegunMsg::DtRestoreBegunMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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

Referenced by clone(), and create().

DtRestoreBegunMsg::DtRestoreBegunMsg ( DtFederateHandle  requestingFederateVal,
const char *  labelVal,
DtResponseFlag  flag,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtRestoreBegunMsg::DtRestoreBegunMsg ( const DtNetSaveResponseMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

void DtRestoreBegunMsg::addCallback ( DtConnectionMgr conn,
DtRestoreBegunCb  cb,
void *  usr 
) [static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtRestoreBegunMsgKind.

Referenced by DtFedExec::DtFedExec().

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

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

Implements DtRtiMsg.

References DtRestoreBegunMsg(), and netRestoreBegunMsg().

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

Creator.

References DtRestoreBegunMsg().

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

Creator.

References DtRestoreBegunMsg().

Returns the kind of an RestoreBegun Msg.

Implements DtRtiMsg.

References DtRestoreBegunMsgKind.

Referenced by DtRestoreBegunMsg().

const char * DtRestoreBegunMsg::label ( ) const [virtual]
int DtRestoreBegunMsg::labelFieldSize ( ) const [protected, virtual]

Returns size of label field.

References DtNetSaveResponseMsg::labelSize, labelSize(), and netRestoreBegunMsg().

Referenced by setLabel().

char * DtRestoreBegunMsg::labelPtr ( ) [protected, virtual]

Returns pointer to the label in the netMsg.

References labelSize(), and netRestoreBegunMsg().

Referenced by label(), and setLabel().

int DtRestoreBegunMsg::labelSize ( ) const [protected, virtual]
int DtRestoreBegunMsg::minSize ( const char *  theLabel = NULL) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtRestoreBegunMsg().

const DtNetSaveResponseMsg * DtRestoreBegunMsg::netRestoreBegunMsg ( ) const [protected, virtual]
void DtRestoreBegunMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References requestingFederate(), and responseFlag().

void DtRestoreBegunMsg::removeCallback ( DtConnectionMgr conn,
DtRestoreBegunCb  cb,
void *  usr 
) [static]

References netRestoreBegunMsg().

Referenced by printData().

DtRestoreBegunMsg * DtRestoreBegunMsg::self ( ) const [inline, protected, virtual]

Casts away const-ness.

void DtRestoreBegunMsg::set ( DtFederateHandle  requestingFederateVal,
const char *  theLabel,
DtResponseFlag  flag 
) [virtual]

Set all parameters simultaneously.

References setLabel(), setRequestingFederate(), and setResponseFlag().

Referenced by DtRtiExecFederateMgr::sendRestoreBegunMsg().

void DtRestoreBegunMsg::setLabel ( const char *  label) [virtual]
void DtRestoreBegunMsg::setLabelSize ( int  size) [protected, virtual]

Set/Get tag size.

References DtNetSaveResponseMsg::labelSize, and netRestoreBegunMsg().

Set/Get requesting federate.

References netRestoreBegunMsg(), and DtNetSaveResponseMsg::requestingFederate.

Referenced by DtRestoreBegunMsg(), and set().

Set/Get response flag.

References netRestoreBegunMsg(), and DtNetSaveResponseMsg::respFlag.

Referenced by DtRestoreBegunMsg(), and set().


Member Data Documentation

char* DtRestoreBegunMsg::myLabel [protected]

Referenced by label(), and setLabel().


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)