DtSaveMsg Class Reference

A base class for the various save/restore messages. More...

Inheritance diagram for DtSaveMsg:

Collaboration diagram for DtSaveMsg:

Public Member Functions
	DtSaveMsg ()
	Constructor.
virtual	~DtSaveMsg ()
	Destructor.
void	set (const char *theLabel)
	Set all fields.
virtual void	setLabel (const char *label)
	Set/Get tag.
virtual const char *	label () const
virtual void	setRequestID (unsigned long requestIDValue)
	Set/Get request ID.
virtual unsigned long	requestID () const
virtual void	setResult (unsigned char result)
	Set/Get result.
virtual unsigned char	result () const
virtual void	setTime (RTI::FedTime const &timeVal)
	Set/Get time.
virtual RTI::FedTime const *	time (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section.
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const =0
	Return a copy/empty object of the same type as this.
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 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).

Protected Member Functions
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of this message.
virtual char *	labelPtr ()
	Returns pointer to the label in the netMsg.
virtual char *	timePtr ()
	Returns pointer to the time in the netMsg.
virtual int	labelFieldSize () const
	Returns size of label field.
virtual int	timeFieldSize () const
	Returns size of timestamp field (including serial number)
virtual void	setLabelSize (int size)
	Set/Get tag size.
virtual int	labelSize () const
virtual void	setTimeSize (int size)
	Set/Get time size.
virtual int	timeSize () const
virtual DtNetSaveMsg *	netSaveMsg ()
	The network representation.
virtual const DtNetSaveMsg *	netSaveMsg () const
virtual int	minSize (char const *theLabel=NULL, RTI::FedTime const *theTime=NULL) const
	Returns minimum size of a message, including header.
virtual DtSaveMsg *	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 Member Functions inherited from DtRtiMsg
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 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 ()
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

Detailed Description

A base class for the various save/restore messages.

Constructor & Destructor Documentation

DtSaveMsg::DtSaveMsg

(

)

Constructor.

References DtRtiMsg::myAllowedDuringSave.

DtSaveMsg::~DtSaveMsg ( )

virtual

Destructor.

References myLabel, and NULL.

Member Function Documentation

DtRtiMsgKind DtSaveMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of this message.

Implements DtRtiMsg.

Reimplemented in DtSaveTimeMsg, DtRestoreEndMsg, DtSaveFinishedMsg, DtSaveCompleteMsg, DtSaveRequestMsg, DtRestoreCompleteMsg, DtRestoreRequestMsg, DtRestoreMsg, DtSaveInitiateConstrainedMsg, DtSaveInitiateMsg, DtSaveBegunMsg, and DtAbortSaveMsg.

References DtInvalidMsgKind.

const char * DtSaveMsg::label ( ) const

virtual

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

Referenced by DtSaveRequestMsg::printData(), DtSaveCompleteMsg::printData(), printData(), DtSaveTimeMsg::printData(), DtRtiExecFederateMgr::processRestore(), DtFedExec::processRestoreRequest(), DtRtiExecFederateMgr::processSaveInitiate(), and DtFedExec::processSaveRequest().

int DtSaveMsg::labelFieldSize ( ) const

protectedvirtual

Returns size of label field.

References labelSize().

Referenced by setLabel(), and timePtr().

char * DtSaveMsg::labelPtr ( )

protectedvirtual

Returns pointer to the label in the netMsg.

References labelSize(), and netSaveMsg().

Referenced by label(), setLabel(), and timePtr().

int DtSaveMsg::labelSize ( ) const

protectedvirtual

References DtNetSaveMsg::labelSize, and netSaveMsg().

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

int DtSaveMsg::minSize ( char const *  theLabel = NULL, RTI::FedTime const *  theTime = NULL  ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAbortSaveMsg::DtAbortSaveMsg(), DtRestoreEndMsg::DtRestoreEndMsg(), DtRestoreMsg::DtRestoreMsg(), DtRestoreRequestMsg::DtRestoreRequestMsg(), DtSaveBegunMsg::DtSaveBegunMsg(), DtSaveCompleteMsg::DtSaveCompleteMsg(), DtSaveFinishedMsg::DtSaveFinishedMsg(), DtSaveInitiateConstrainedMsg::DtSaveInitiateConstrainedMsg(), DtSaveInitiateMsg::DtSaveInitiateMsg(), DtSaveRequestMsg::DtSaveRequestMsg(), and DtSaveTimeMsg::DtSaveTimeMsg().

DtNetSaveMsg * DtSaveMsg::netSaveMsg ( )

protectedvirtual

The network representation.

Referenced by DtSaveBegunMsg::clone(), DtAbortSaveMsg::clone(), DtRestoreCompleteMsg::clone(), DtSaveInitiateConstrainedMsg::clone(), DtRestoreMsg::clone(), DtSaveInitiateMsg::clone(), DtSaveRequestMsg::clone(), DtSaveCompleteMsg::clone(), DtRestoreRequestMsg::clone(), DtRestoreEndMsg::clone(), DtSaveFinishedMsg::clone(), DtSaveTimeMsg::clone(), labelPtr(), labelSize(), requestID(), result(), setLabel(), setLabelSize(), setRequestID(), setResult(), setTimeSize(), and timeSize().

const DtNetSaveMsg * DtSaveMsg::netSaveMsg ( ) const

protectedvirtual

void DtSaveMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

Reimplemented in DtSaveTimeMsg, DtSaveCompleteMsg, DtSaveRequestMsg, DtSaveBegunMsg, and DtAbortSaveMsg.

References label().

unsigned long DtSaveMsg::requestID ( ) const

virtual

References netSaveMsg(), and DtNetSaveMsg::requestID.

Referenced by DtSaveRequestMsg::printData(), and DtFedExec::processSaveRequest().

unsigned char DtSaveMsg::result ( ) const

virtual

References netSaveMsg(), and DtNetSaveMsg::result.

Referenced by DtSaveFinishedMsg::DtSaveFinishedMsg(), DtRestoreEndMsg::endResult(), DtSaveFinishedMsg::finishedResult(), and DtSaveCompleteMsg::successIndicator().

DtSaveMsg * DtSaveMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

void DtSaveMsg::set

(

const char *

theLabel

)

Set all fields.

References setLabel().

Referenced by DtRtiExecFederateMgr::sendRestoreRequestMsg(), DtFedExec::sendSaveInitiateConstrainedMsg(), and DtFedExec::sendSaveInitiateMsg().

void DtSaveMsg::setLabel ( const char *  label )

virtual

Set/Get tag.

References rti1516e::insertBytes(), labelFieldSize(), labelPtr(), DtNetSaveMsg::labelSize, labelSize(), myLabel, netSaveMsg(), and NULL.

Referenced by set(), DtSaveRequestMsg::set(), DtSaveCompleteMsg::set(), DtSaveFinishedMsg::set(), and DtRestoreEndMsg::set().

void DtSaveMsg::setLabelSize ( int  size )

protectedvirtual

Set/Get tag size.

References DtNetSaveMsg::labelSize, and netSaveMsg().

void DtSaveMsg::setRequestID ( unsigned long  requestIDValue )

virtual

Set/Get request ID.

References netSaveMsg(), and DtNetSaveMsg::requestID.

Referenced by DtSaveRequestMsg::set().

void DtSaveMsg::setResult ( unsigned char  result )

virtual

Set/Get result.

References netSaveMsg(), and DtNetSaveMsg::result.

Referenced by DtRestoreEndMsg::setEndResult(), DtSaveFinishedMsg::setFinishedResult(), and DtSaveCompleteMsg::setSuccessIndicator().

void DtSaveMsg::setTime ( RTI::FedTime const &  timeVal )

virtual

Set/Get time.

Reimplemented from DtRtiMsg.

References RTI::FedTime::encode(), and RTI::FedTime::encodedLength().

void DtSaveMsg::setTimeSize ( int  size )

protectedvirtual

Set/Get time size.

References netSaveMsg(), and DtNetSaveMsg::timeSize.

RTI::FedTime const * DtSaveMsg::time ( DtLogicalTimeFactory *  logicalTimeFactory ) const

virtual

Reimplemented from DtRtiMsg.

References DtLogicalTimeFactory::decode(), DtLogicalTimeFactory::makeInitial(), DtRtiMsg::myFedTime, NULL, timePtr(), and timeSize().

Referenced by DtSaveTimeMsg::printData().

int DtSaveMsg::timeFieldSize ( ) const

protectedvirtual

Returns size of timestamp field (including serial number)

References timeSize().

char * DtSaveMsg::timePtr ( )

protectedvirtual

Returns pointer to the time in the netMsg.

References labelFieldSize(), and labelPtr().

Referenced by time().

int DtSaveMsg::timeSize ( ) const

protectedvirtual

References netSaveMsg(), and DtNetSaveMsg::timeSize.

Referenced by time(), and timeFieldSize().

Member Data Documentation

char* DtSaveMsg::myLabel

protected

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

---

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

• saveMsg.h
• saveMsg.cxx