DtRestoreBegunMsg Class Reference

Inheritance diagram for DtRestoreBegunMsg:

Collaboration diagram for DtRestoreBegunMsg:

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 DtRtiMsg *	clone (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.
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor.
virtual DtRtiMsg *	cloneWithTransport (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.
virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation.
virtual int	version () const
	Return the message version.
virtual bool	isValidVersion () const
	Returns bool: message version is valid?
virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to.
virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle.
virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise.
virtual DtRtiMsgKind	msgKind () const
	Get the message kind.
virtual const char *	kindString () const
	Returns the message kind string name.
virtual bool	isConstrained () const
	Return boolean: message type can be time constrained?
virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save?
virtual void	setTime (const RTI::FedTime &time)
	Set/Get time Used in timestamped messages.
virtual RTI::FedTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool	hasTime () const
	Returns true if time field is valid.
virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages.
virtual unsigned long	serialNumber () const
virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type.
virtual DtTransportHandle	transportType () const
virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order.
virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object.
virtual bool	addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata.
virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed.
bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types.
bool	isUpdateMsgType () const
virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions.
virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printTime (const char *label, RTI::FedTime const *timeValue) const
	Print the given time.
virtual void	printInterval (const char *label, RTI::FedTime const *intervalValue) const
	Print the interval.
virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.
virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec().
virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.
virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle.
virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle.
virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number.
virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number.
virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number.
virtual unsigned long	serviceCallNumber () const
	Set/Get service call number.
virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).
virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

Static Public Member Functions
static DtRtiMsg *	create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creator.
static DtRtiMsg *	create (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)
Static Public Member Functions inherited from DtRtiMsg
static const DtNetMsgHeader *	netHeader (const void *buffer)
	Extracts the header network representation from the buffer.
static const char *	kindToString (DtRtiMsgKind kind)
	Returns the name of the message, by kind enumeration.
static const char *	kindString (const void *buffer)
	Extracts the message kind from the given buffer and returns its string name.
static const DtRtiMsgKind	msgKind (const void *buffer)
	Extracts the message kind from the given buffer.
static unsigned int	version (const void *buffer)
	Extracts the message version form the given buffer.
static unsigned int	fedExHandle (const void *buffer)
	Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name)
static DtFederateHandle	federateHandle (const void *buffer)
	Extracts the message federate handle form the given buffer.
static unsigned long	sequenceNumber (const void *buffer)
	Extracts the message sequence number form the given buffer.
static void	setDefaultRegionSet (unsigned long defaultRegionSet)
	Set the default region set handle.
static void	setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
	Set/Get flag to enable use of 32 bit size field for attribute/parameter values.
static bool	use32BitsForValueSize ()
static void	setSmartForwardingEnabled (bool enabled)
	Set/Get is SmartForwarding enabled?
static bool	smartForwardingEnabled ()

Protected Member Functions
virtual DtNetSaveResponseMsg *	netRestoreBegunMsg ()
	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 DtRestoreBegunMsg *	self () const
	Casts away const-ness.
Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor.
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes.
void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual.
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.
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres.

Protected Attributes
char *	myLabel
Protected Attributes inherited from DtRtiMsg
DtTransportHandle	myTransportType
DtOrderHandle	myOrderType
RTI::FedTime *	myFedTime
bool	myTimeIsValid
bool	myConstrained
bool	myAllowedDuringSave
unsigned long	mySerialNumber
unsigned long	myServiceCallNumber
unsigned long	myTriggerMessage

Additional Inherited Members
Static Public Attributes inherited from DtRtiMsg
static unsigned long	theDefaultRegionSetHandle = 0
static const char *	theDefaultTag = NULL
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize = false
static bool	theSmartForwardingEnabled = false

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
	)

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), minSize(), setLabel(), setRequestingFederate(), and setResponseFlag().

DtRestoreBegunMsg::DtRestoreBegunMsg	(	const DtNetSaveResponseMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

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

DtRestoreBegunMsg::~DtRestoreBegunMsg ( )

virtual

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().

DtRtiMsgKind DtRestoreBegunMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an RestoreBegun Msg.

Implements DtRtiMsg.

References DtRestoreBegunMsgKind.

Referenced by DtRestoreBegunMsg().

const char * DtRestoreBegunMsg::label ( ) const

virtual

References labelPtr(), labelSize(), myLabel, netRestoreBegunMsg(), and NULL.

int DtRestoreBegunMsg::labelFieldSize ( ) const

protectedvirtual

Returns size of label field.

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

Referenced by setLabel().

char * DtRestoreBegunMsg::labelPtr ( )

protectedvirtual

Returns pointer to the label in the netMsg.

References labelSize(), and netRestoreBegunMsg().

Referenced by label(), and setLabel().

int DtRestoreBegunMsg::labelSize ( ) const

protectedvirtual

References DtNetSaveResponseMsg::labelSize, and netRestoreBegunMsg().

Referenced by label(), labelFieldSize(), labelPtr(), and setLabel().

int DtRestoreBegunMsg::minSize ( const char *  theLabel = NULL ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtRestoreBegunMsg().

DtNetSaveResponseMsg * DtRestoreBegunMsg::netRestoreBegunMsg ( )

protectedvirtual

The network representation.

Referenced by clone(), label(), labelFieldSize(), labelPtr(), labelSize(), requestingFederate(), responseFlag(), setLabel(), setLabelSize(), setRequestingFederate(), and setResponseFlag().

const DtNetSaveResponseMsg * DtRestoreBegunMsg::netRestoreBegunMsg ( ) const

protectedvirtual

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 DtRestoreBegunMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtFedExec::~DtFedExec().

DtFederateHandle DtRestoreBegunMsg::requestingFederate

(

)

const

References netRestoreBegunMsg().

Referenced by printData().

DtResponseFlag DtRestoreBegunMsg::responseFlag

(

)

const

References netRestoreBegunMsg().

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

DtRestoreBegunMsg * DtRestoreBegunMsg::self ( ) const

inlineprotectedvirtual

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

Set/Get tag.

References rti1516e::insertBytes(), labelFieldSize(), labelPtr(), DtNetSaveResponseMsg::labelSize, labelSize(), myLabel, and netRestoreBegunMsg().

Referenced by DtRestoreBegunMsg(), and set().

void DtRestoreBegunMsg::setLabelSize ( int  size )

protectedvirtual

Set/Get tag size.

References DtNetSaveResponseMsg::labelSize, and netRestoreBegunMsg().

void DtRestoreBegunMsg::setRequestingFederate

(

DtFederateHandle

requestingFederateVal

)

Set/Get requesting federate.

References netRestoreBegunMsg(), and DtNetSaveResponseMsg::requestingFederate.

Referenced by DtRestoreBegunMsg(), and set().

void DtRestoreBegunMsg::setResponseFlag

(

DtResponseFlag

flag

)

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:

• resBegMsg.h
• resBegMsg.cxx