DtSaveMsg Class Reference

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

Inheritance diagram for DtSaveMsg:

Collaboration diagram for DtSaveMsg:

List of all members.

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.
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 Attributes
char *	myLabel

---

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

(

)

[protected, virtual]

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 [protected, virtual]

Returns size of label field.

References labelSize().

Referenced by setLabel(), and timePtr().

char * DtSaveMsg::labelPtr

(

)

[protected, virtual]

Returns pointer to the label in the netMsg.

References labelSize(), and netSaveMsg().

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

int DtSaveMsg::labelSize

(

)

const [protected, virtual]

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 [protected, virtual]

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

(

)

[protected, virtual]

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 [protected, virtual]

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 [inline, protected, virtual]

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

)

[protected, virtual]

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

)

[protected, virtual]

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 [protected, virtual]

Returns size of timestamp field (including serial number)

References timeSize().

char * DtSaveMsg::timePtr

(

)

[protected, virtual]

Returns pointer to the time in the netMsg.

References labelFieldSize(), and labelPtr().

Referenced by time().

int DtSaveMsg::timeSize

(

)

const [protected, virtual]

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