DtSyncPointMsg Class Reference

Inheritance diagram for DtSyncPointMsg:

Collaboration diagram for DtSyncPointMsg:

Public Member Functions
	DtSyncPointMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor. More...
	DtSyncPointMsg (DtSyncMsgType kind, DtFederateHandle id, DtSyncPointStatus statusValue, char const *name, char const *tag, const DtFederateHandleSet *set=NULL, const DtFederateHandleSet *unsuccessfulSet=NULL, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtSyncPointMsg (const DtNetSyncMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor. More...
virtual	~DtSyncPointMsg ()
	Deconstructor. More...
virtual DtRtiMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this. More...
virtual void	set (DtSyncMsgType kind, DtFederateHandle id, DtSyncPointStatus statusValue, char const *name, char const *tag, DtFederateHandleSet const *set=NULL, DtFederateHandleSet const *unsuccessfulSet=NULL)
	Set all fields simultaneously. More...
virtual void	setSyncMsgKind (DtSyncMsgType kind)
	Set/Get synchronization message kind. More...
virtual DtSyncMsgType	syncMsgKind () const
virtual void	setFederateId (DtFederateHandle id)
	Set/Get federate id. More...
virtual DtFederateHandle	federateId () const
virtual void	setSyncPointStatus (DtSyncPointStatus statusValue)
	Set/Get sync point status. More...
virtual DtSyncPointStatus	syncPointStatus () const
virtual void	setSyncPointName (char const *name)
	Set/Get synchronization point name. More...
virtual char const *	syncPointName () const
virtual void	setTag (char const *tag)
	Set/Get tag. More...
virtual char const *	tag () const
virtual void	setFederates (const DtFederateHandleSet *set)
	Set the set of federate handles to be encoded in the message. More...
virtual DtFederateHandleSet const *	federates () const
	Returns the set of federates encoded in the message. More...
virtual void	getFederates (DtFederateHandleSet *set) const
	Alternate way to get the set of federates contained in the message. More...
virtual int	numFederates () const
	Get number of federates. More...
virtual void	getUnsuccessfulFederates (DtFederateHandleSet *set) const
	Alternate way to get the set of federates contained in the message. More...
virtual void	setUnsuccessfulFederates (const DtFederateHandleSet *set)
	Set the set of unsuccessfully synched federate handles to be encoded in the message. More...
virtual DtFederateHandleSet const *	unsuccessfulFederates () const
	Returns the set of unsuccessfully synched federates encoded in the message. More...
virtual int	numUnsuccessfulFederates () const
	Get number of unsuccessfully synched federates. More...
virtual void	printData (DtLogicalTimeFactory *logicalTimeFactory) const
	Print the data section. More...
Public Member Functions inherited from DtRtiMsg
virtual	~DtRtiMsg ()
	Destructor. More...
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. More...
virtual DtNetMsgHeader *	netHeader () const
	Get header of network representation. More...
virtual int	version () const
	Return the message version. More...
virtual bool	isValidVersion () const
	Returns bool: message version is valid? More...
virtual void	setFedEx (const MAKRti::DtString &name)
	All RTI messages contain information to identify which federation execution the message applies to. More...
virtual void	setFedEx (int handle)
	Set federation execution identifier as a handle. More...
virtual bool	isForExec (const MAKRti::DtString &execName, int execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise. More...
virtual DtRtiMsgKind	msgKind () const
	Get the message kind. More...
virtual const char *	kindString () const
	Returns the message kind string name. More...
virtual bool	isConstrained () const
	Return boolean: message type can be time constrained? More...
virtual bool	isAllowedDuringSave () const
	Return boolean: message type can be processed during save? More...
virtual void	setTime (const RTI::FedTime &time)
	Set/Get time Used in timestamped messages. More...
virtual RTI::FedTime const *	time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool	hasTime () const
	Returns true if time field is valid. More...
virtual void	setSerialNumber (unsigned long serialNumberValue)
	Set/Get event retraction serial number Used in timestamped messages. More...
virtual unsigned long	serialNumber () const
virtual void	setTransportType (DtTransportHandle type)
	Set/Get transport type. More...
virtual DtTransportHandle	transportType () const
virtual DtOrderHandle	orderType () const
	This base implementation always returns recieve order. More...
virtual bool	isMetadataPresent () const
	Test if metadata has been added to a DtRtiMsg object. More...
virtual bool	addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
	Allocate space for next block of metadata. More...
virtual void	removeMetadata (unsigned int size)
	Update the size of the message when metadata has been removed. More...
bool	isInteractionMsgType () const
	Utility functions, check the message type against known interaciton/update message types. More...
bool	isUpdateMsgType () const
virtual void	print (DtLogicalTimeFactory *logicalTimeFactory) const
	Printing functions. More...
virtual void	printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void	printTime (const char *label, RTI::FedTime const *timeValue) const
	Print the given time. More...
virtual void	printInterval (const char *label, RTI::FedTime const *intervalValue) const
	Print the interval. More...
virtual int	status () const
	Returns MSG_STATUS_OK if OK, a reason enumeration otherwise. More...
virtual const MAKRti::DtString	fedExName () const
	These two functions should be avoided in favor of isForExec(). More...
virtual int	fedExHandle () const
	Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name. More...
virtual void	setFederateHandle (DtFederateHandle handle)
	Set/Get federate handle. More...
virtual DtFederateHandle	federateHandle () const
	Set/Get federate handle. More...
virtual void	setSequenceNumber (unsigned long value)
	Set/Get message sequence number. More...
virtual unsigned long	sequenceNumber () const
	Set/Get message sequence number. More...
virtual void	setServiceCallNumber (unsigned long value)
	Set/Get service call number. More...
virtual unsigned long	serviceCallNumber () const
	Set/Get service call number. More...
virtual void	setTriggerMessageNumber (unsigned long value)
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...
virtual unsigned long	triggerMessageNumber () const
	Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). More...

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

Protected Member Functions
virtual DtNetSyncMsg *	netSyncMsg ()
	The network representation. More...
virtual const DtNetSyncMsg *	netSyncMsg () const
virtual DtNetU32 *	handleArray ()
	Pointers to various fields of the net message. More...
virtual DtNetU32 *	unsuccessfulHandleArray ()
virtual char *	tagPtr ()
virtual char *	namePtr ()
virtual int	handleArraySize () const
	Sizes of various fields of the net message. More...
virtual int	unsuccessfulHandleArraySize () const
virtual int	tagFieldSize () const
virtual int	nameFieldSize () const
virtual DtRtiMsgKind	internalDtRtiMsgKind ()
	Returns the kind of a synchronization msg. More...
virtual int	minSize () const
	Returns the minimum size of a message, including the header. More...
DtSyncPointMsg *	self () const
	Casts away constness. Use with caution. More...
Protected Member Functions inherited from DtRtiMsg
	DtRtiMsg ()
	Constructor. More...
virtual void	sizeChanged (int size)
	Called whenever size is changed using changeSize, or insert/deleteBytes. More...
void	initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
	Called by ctor, so not virtual. More...
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. More...
virtual void	adjustBytes (void *address, int numBytes)
	Adjust the numBytes starting at the indicated addres. More...

Protected Attributes
char *	myTag
MAKRti::DtString	myName
DtFederateHandleSet *	mySet
DtFederateHandleSet *	myUnsuccessfulSet
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

DtSyncPointMsg::DtSyncPointMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

DtSyncPointMsg::DtSyncPointMsg	(	DtSyncMsgType	kind,
		DtFederateHandle	id,
		DtSyncPointStatus	statusValue,
		char const *	name,
		char const *	tag,
		const DtFederateHandleSet *	set = NULL,
		const DtFederateHandleSet *	unsuccessfulSet = NULL,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtSyncPointMsg::DtSyncPointMsg	(	const DtNetSyncMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Constructor.

virtual DtSyncPointMsg::~DtSyncPointMsg ( )

virtual

Deconstructor.

Member Function Documentation

static void DtSyncPointMsg::addCallback ( DtConnectionMgr *  conn, DtSyncPointCb  cb, void *  usr  )

static

Callback management.

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

virtual

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

Implements DtRtiMsg.

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

static

Creator.

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

static

Creator.

virtual DtFederateHandle DtSyncPointMsg::federateId ( ) const

virtual

virtual DtFederateHandleSet const* DtSyncPointMsg::federates ( ) const

virtual

Returns the set of federates encoded in the message.

The object returned is a reference to internal memory, and is only valid until the next time federates() is called.

virtual void DtSyncPointMsg::getFederates ( DtFederateHandleSet *  set ) const

virtual

Alternate way to get the set of federates contained in the message.

After this call, set will contain the appropriate federate set. Make sure that set is large enough to hold numFederates() handles.

virtual void DtSyncPointMsg::getUnsuccessfulFederates ( DtFederateHandleSet *  set ) const

virtual

Alternate way to get the set of federates contained in the message.

After this call, set will contain the appropriate federate set. Make sure that set is large enough to hold numFederates() handles.

virtual DtNetU32* DtSyncPointMsg::handleArray ( )

protectedvirtual

Pointers to various fields of the net message.

virtual int DtSyncPointMsg::handleArraySize ( ) const

protectedvirtual

Sizes of various fields of the net message.

virtual DtRtiMsgKind DtSyncPointMsg::internalDtRtiMsgKind ( )

protectedvirtual

Returns the kind of a synchronization msg.

Implements DtRtiMsg.

virtual int DtSyncPointMsg::minSize ( ) const

protectedvirtual

Returns the minimum size of a message, including the header.

virtual int DtSyncPointMsg::nameFieldSize ( ) const

protectedvirtual

virtual char* DtSyncPointMsg::namePtr ( )

protectedvirtual

virtual DtNetSyncMsg* DtSyncPointMsg::netSyncMsg ( )

protectedvirtual

The network representation.

virtual const DtNetSyncMsg* DtSyncPointMsg::netSyncMsg ( ) const

protectedvirtual

virtual int DtSyncPointMsg::numFederates ( ) const

virtual

Get number of federates.

virtual int DtSyncPointMsg::numUnsuccessfulFederates ( ) const

virtual

Get number of unsuccessfully synched federates.

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

virtual

Print the data section.

Reimplemented from DtRtiMsg.

static void DtSyncPointMsg::removeCallback ( DtConnectionMgr *  conn, DtSyncPointCb  cb, void *  usr  )

static

DtSyncPointMsg * DtSyncPointMsg::self ( ) const

inlineprotected

Casts away constness. Use with caution.

virtual void DtSyncPointMsg::set ( DtSyncMsgType  kind, DtFederateHandle  id, DtSyncPointStatus  statusValue, char const *  name, char const *  tag, DtFederateHandleSet const *  set = NULL, DtFederateHandleSet const *  unsuccessfulSet = NULL  )

virtual

Set all fields simultaneously.

virtual void DtSyncPointMsg::setFederateId ( DtFederateHandle  id )

virtual

Set/Get federate id.

virtual void DtSyncPointMsg::setFederates ( const DtFederateHandleSet *  set )

virtual

Set the set of federate handles to be encoded in the message.

virtual void DtSyncPointMsg::setSyncMsgKind ( DtSyncMsgType  kind )

virtual

Set/Get synchronization message kind.

virtual void DtSyncPointMsg::setSyncPointName ( char const *  name )

virtual

Set/Get synchronization point name.

virtual void DtSyncPointMsg::setSyncPointStatus ( DtSyncPointStatus  statusValue )

virtual

Set/Get sync point status.

virtual void DtSyncPointMsg::setTag ( char const *  tag )

virtual

Set/Get tag.

virtual void DtSyncPointMsg::setUnsuccessfulFederates ( const DtFederateHandleSet *  set )

virtual

Set the set of unsuccessfully synched federate handles to be encoded in the message.

virtual DtSyncMsgType DtSyncPointMsg::syncMsgKind ( ) const

virtual

virtual char const* DtSyncPointMsg::syncPointName ( ) const

virtual

virtual DtSyncPointStatus DtSyncPointMsg::syncPointStatus ( ) const

virtual

virtual char const* DtSyncPointMsg::tag ( ) const

virtual

virtual int DtSyncPointMsg::tagFieldSize ( ) const

protectedvirtual

virtual char* DtSyncPointMsg::tagPtr ( )

protectedvirtual

virtual DtFederateHandleSet const* DtSyncPointMsg::unsuccessfulFederates ( ) const

virtual

Returns the set of unsuccessfully synched federates encoded in the message.

The object returned is a reference to internal memory, and is only valid until the next time federates() is called.

virtual DtNetU32* DtSyncPointMsg::unsuccessfulHandleArray ( )

protectedvirtual

virtual int DtSyncPointMsg::unsuccessfulHandleArraySize ( ) const

protectedvirtual

Member Data Documentation

MAKRti::DtString DtSyncPointMsg::myName

protected

DtFederateHandleSet* DtSyncPointMsg::mySet

protected

char* DtSyncPointMsg::myTag

protected

DtFederateHandleSet* DtSyncPointMsg::myUnsuccessfulSet

protected

---

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

• syncPointMsg.h