Inheritance diagram for DtRestoreReplyMsg:

Collaboration diagram for DtRestoreReplyMsg:

Public Types
enum	replyCodes { DT_RESTORE_OK = 0, DT_RESTORE_NO_LABEL = 1, DT_RESTORE_WRONG_CONFIG = 2, DT_RESTORE_IN_PROCESS = 3 }

Public Member Functions
	DtRestoreReplyMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtRestoreReplyMsg (const char *theLabel, const replyCodes response, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtRestoreReplyMsg (const DtNetRestoreReplyMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtRestoreReplyMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	setLabel (const char *label)
	Set/Get label.
virtual const char *	label () const
virtual void	setReply (const replyCodes value)
	Set/Get successIndicator.
virtual replyCodes	reply () const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
virtual unsigned long	destinationID () const
	Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.
virtual void	setDestinationID (unsigned long destinationIDValue)
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, DtRestoreReplyCb cb, void usr)
	Callback management.
static void	removeCallback (DtConnectionMgr conn, DtRestoreReplyCb 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 char *	labelPtr ()
	Returns pointer to the label in the netMsg.
virtual int	labelFieldSize () const
	Returns size of label field.
virtual DtNetRestoreReplyMsg *	netRestoreReplyMsg ()
	The network representation.
virtual const DtNetRestoreReplyMsg *	netRestoreReplyMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Restore Reply Msg.
virtual int	minSize (const char *theLabel=NULL) const
	Returns minimum size of a message, including header.
virtual void	setLabelSize (int size)
	Set/Get tag size.
virtual int	labelSize () const
virtual DtRestoreReplyMsg *	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

Member Enumeration Documentation

enum DtRestoreReplyMsg::replyCodes

Enumerator:

DT_RESTORE_OK
DT_RESTORE_NO_LABEL
DT_RESTORE_WRONG_CONFIG
DT_RESTORE_IN_PROCESS

Constructor & Destructor Documentation

DtRestoreReplyMsg::DtRestoreReplyMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

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

Referenced by clone(), and create().

DtRestoreReplyMsg::DtRestoreReplyMsg	(	const char *	theLabel,
		const replyCodes	response,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Constructor.

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

DtRestoreReplyMsg::DtRestoreReplyMsg	(	const DtNetRestoreReplyMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Constructor.

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

DtRestoreReplyMsg::~DtRestoreReplyMsg ( )

virtual

Destructor.

References myLabel, and NULL.

Member Function Documentation

void DtRestoreReplyMsg::addCallback	(	DtConnectionMgr *	conn,
		DtRestoreReplyCb	cb,
		void *	usr
	)

static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtRestoreReplyMsgKind.

Referenced by DtFederateMgr::postJoinInit().

DtRtiMsg * DtRestoreReplyMsg::clone ( bool copy = true ) const

virtual

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

Implements DtRtiMsg.

References DtRestoreReplyMsg(), and netRestoreReplyMsg().

DtRtiMsg * DtRestoreReplyMsg::create	(	const DtNetMsgHeader *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

static

Creator.

References DtRestoreReplyMsg().

DtRtiMsg * DtRestoreReplyMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

Creator.

References DtRestoreReplyMsg().

unsigned long DtRestoreReplyMsg::destinationID ( ) const

virtual

Set/Get federate destination ID The federate name is not enough to uniquely identify it among other federates.

This destination ID was the unique source ID that the federate supplied for join.

References DtNetRestoreReplyMsg::destinationID, and netRestoreReplyMsg().

Referenced by DtRtiExecFederateMgr::processRestoreReply().

DtRtiMsgKind DtRestoreReplyMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Restore Reply Msg.

Implements DtRtiMsg.

References DtRestoreReplyMsgKind.

Referenced by DtRestoreReplyMsg().

const char * DtRestoreReplyMsg::label ( ) const

virtual

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

Referenced by printData(), and DtRtiExecFederateMgr::processRestoreReply().

int DtRestoreReplyMsg::labelFieldSize ( ) const

protectedvirtual

Returns size of label field.

References DtNetRestoreReplyMsg::labelSize, labelSize(), and netRestoreReplyMsg().

Referenced by setLabel().

char * DtRestoreReplyMsg::labelPtr ( )

protectedvirtual

Returns pointer to the label in the netMsg.

References labelSize(), and netRestoreReplyMsg().

Referenced by label(), and setLabel().

int DtRestoreReplyMsg::labelSize ( ) const

protectedvirtual

References DtNetRestoreReplyMsg::labelSize, and netRestoreReplyMsg().

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

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

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtRestoreReplyMsg().

DtNetRestoreReplyMsg * DtRestoreReplyMsg::netRestoreReplyMsg ( )

protectedvirtual

The network representation.

Referenced by clone(), destinationID(), label(), labelFieldSize(), labelPtr(), labelSize(), reply(), setDestinationID(), setLabel(), setLabelSize(), and setReply().

const DtNetRestoreReplyMsg * DtRestoreReplyMsg::netRestoreReplyMsg ( ) const

protectedvirtual

void DtRestoreReplyMsg::printData ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

References DT_RESTORE_IN_PROCESS, DT_RESTORE_NO_LABEL, DT_RESTORE_OK, DT_RESTORE_WRONG_CONFIG, label(), and reply().

void DtRestoreReplyMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtRestoreReplyCb	cb,
		void *	usr
	)

static

References DtRestoreReplyMsgKind, and DtConnectionMgr::removeMsgCallback().

Referenced by DtFederateMgr::resignFederationExecution(), and DtFederateMgr::~DtFederateMgr().

DtRestoreReplyMsg::replyCodes DtRestoreReplyMsg::reply ( ) const

virtual

References netRestoreReplyMsg(), and DtNetRestoreReplyMsg::response.

Referenced by printData(), DtRtiExecFederateMgr::processRestoreReply(), and setReply().

DtRestoreReplyMsg * DtRestoreReplyMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtRestoreReplyMsg::setDestinationID ( unsigned long destinationIDValue )

virtual

References DtNetRestoreReplyMsg::destinationID, and netRestoreReplyMsg().

Referenced by DtFedExec::processRestoreRequest().

void DtRestoreReplyMsg::setLabel ( const char * label )

virtual

Set/Get label.

References rti1516e::insertBytes(), labelFieldSize(), labelPtr(), DtNetRestoreReplyMsg::labelSize, labelSize(), myLabel, and netRestoreReplyMsg().

Referenced by DtRestoreReplyMsg().

void DtRestoreReplyMsg::setLabelSize ( int size )

protectedvirtual

Set/Get tag size.

References DtNetRestoreReplyMsg::labelSize, and netRestoreReplyMsg().

void DtRestoreReplyMsg::setReply ( const replyCodes value )

virtual

Set/Get successIndicator.

References netRestoreReplyMsg(), reply(), and DtNetRestoreReplyMsg::response.

Referenced by DtRestoreReplyMsg().

Member Data Documentation

char* DtRestoreReplyMsg::myLabel

protected

Referenced by label(), setLabel(), and ~DtRestoreReplyMsg().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation