Inheritance diagram for DtResignMsg:

Collaboration diagram for DtResignMsg:

Public Member Functions
	DtResignMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
	DtResignMsg (const char *fedExName, DtFederateHandle fedHandle, DtResignAction action, DtResignReason reason, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtResignMsg (const DtNetResignMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtResignMsg ()
	Destructor.
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual void	set (const char *fedExName, DtFederateHandle fedHandle, DtResignAction action, DtResignReason reason)
	Set all fields simultaneously.
virtual void	setResignAction (DtResignAction action)
	Set/Get resign action.
virtual DtResignAction	resignAction () const
virtual void	setResignReason (DtResignReason reason)
	Get/Set resign reason.
virtual DtResignReason	resignReason () const
virtual void	setTimeStamp (RTI::FedTime const &time)
	Get/Set last known time stamp.
virtual RTI::FedTime const *	timeStamp (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	setTimeStampSize (int size)
	Set/Get time stamp size.
virtual int	timeStampSize () 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, DtResignCb cb, void usr, bool isMomCallback=false)
	Callback management.
static void	removeCallback (DtConnectionMgr conn, DtResignCb cb, void usr, bool isMomCallback=false)
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 DtNetResignMsg *	netResignMsg ()
	The network representation.
virtual const DtNetResignMsg *	netResignMsg () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of an Resign Msg.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual int	timeStampFieldSize () const
	Returns size of time stamp field (including serial number)
virtual char *	timeStampPtr ()
	Returns pointer to the time stamp in the netMsg.
virtual DtResignMsg *	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
RTI::FedTime *	myTimeStamp
	use base rti message time
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
static const char *	theDefaultTag
Static Protected Attributes inherited from DtRtiMsg
static bool	theUse32BitsForValueSize
static bool	theSmartForwardingEnabled

Constructor & Destructor Documentation

DtResignMsg::DtResignMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

DtResignMsg::DtResignMsg	(	const char *	fedExName,
		DtFederateHandle	fedHandle,
		DtResignAction	action,
		DtResignReason	reason,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

DtResignMsg::DtResignMsg	(	const DtNetResignMsg *	netRepMsg,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`
	)

Constructor.

virtual DtResignMsg::~DtResignMsg ( )

virtual

Destructor.

Member Function Documentation

static void DtResignMsg::addCallback	(	DtConnectionMgr *	conn,
		DtResignCb	cb,
		void *	usr,
		bool	isMomCallback = `false`
	)

static

Callback management.

virtual DtRtiMsg* DtResignMsg::clone ( bool copy = true ) const

virtual

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

Implements DtRtiMsg.

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

static

Creator.

static DtRtiMsg* DtResignMsg::create ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

static

Creator.

virtual DtRtiMsgKind DtResignMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of an Resign Msg.

Implements DtRtiMsg.

virtual int DtResignMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetResignMsg* DtResignMsg::netResignMsg ( )

protectedvirtual

The network representation.

virtual const DtNetResignMsg* DtResignMsg::netResignMsg ( ) const

protectedvirtual

virtual void DtResignMsg::printData ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

Print the data section.

Reimplemented from DtRtiMsg.

static void DtResignMsg::removeCallback	(	DtConnectionMgr *	conn,
		DtResignCb	cb,
		void *	usr,
		bool	isMomCallback = `false`
	)

static

virtual DtResignAction DtResignMsg::resignAction ( ) const

virtual

virtual DtResignReason DtResignMsg::resignReason ( ) const

virtual

DtResignMsg * DtResignMsg::self ( ) const

inlineprotectedvirtual

Casts away const-ness.

virtual void DtResignMsg::set	(	const char *	fedExName,
		DtFederateHandle	fedHandle,
		DtResignAction	action,
		DtResignReason	reason
	)

virtual

Set all fields simultaneously.

virtual void DtResignMsg::setResignAction ( DtResignAction action )

virtual

Set/Get resign action.

virtual void DtResignMsg::setResignReason ( DtResignReason reason )

virtual

Get/Set resign reason.

virtual void DtResignMsg::setTimeStamp ( RTI::FedTime const & time )

virtual

Get/Set last known time stamp.

virtual void DtResignMsg::setTimeStampSize ( int size )

virtual

Set/Get time stamp size.

virtual RTI::FedTime const* DtResignMsg::timeStamp ( DtLogicalTimeFactory * logicalTimeFactory ) const

virtual

virtual int DtResignMsg::timeStampFieldSize ( ) const

protectedvirtual

Returns size of time stamp field (including serial number)

virtual char* DtResignMsg::timeStampPtr ( )

protectedvirtual

Returns pointer to the time stamp in the netMsg.

virtual int DtResignMsg::timeStampSize ( ) const

virtual

Member Data Documentation

RTI::FedTime* DtResignMsg::myTimeStamp

protected

use base rti message time

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

resignMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation