DtRtiMtdDestinationList Class Reference

Inheritance diagram for DtRtiMtdDestinationList:

Collaboration diagram for DtRtiMtdDestinationList:

Public Member Functions
	DtRtiMtdDestinationList (caddr_t msg)
	Constructor. More...
	DtRtiMtdDestinationList (DtRtiMsg *msg)
virtual	~DtRtiMtdDestinationList ()
	Destructor. More...
virtual int	get (DtBitMask &mask) const
	Find the first destination list within the message metadata. More...
virtual bool	set (DtBitMask &destinations, unsigned int maskSize=0)
	Reserves space in RTI message buffer (if necessary) for destination bitmask metadata, encodes (serializes) bitmask, and copies into message buffer. More...
virtual bool	addDestination (DtFederateHandle handle)
	Add destination for routing. Returns true on success, false otherwise. More...
virtual bool	removeDestination (DtFederateHandle handle)
	Remove destination for routing. Returns true on success, false otherwise. More...
virtual void	print (MAKRti::DtOutputStream &stream=MAKRti::DtDebug)
	Print this Metadata List. More...
Public Member Functions inherited from DtRtiMetadata
	DtRtiMetadata (caddr_t msg, DtMetadataType type)
	Constructor. More...
	DtRtiMetadata (DtRtiMsg *msg, DtMetadataType type)
virtual	~DtRtiMetadata ()
	Destructor. More...
virtual bool	locate (void **mdVal, unsigned int &size) const
	Traverse metadata headers of attached message to find this instance's metadata type. More...
virtual bool	nullify ()
	Find specified type and change type field in header to DtMetadataTypeNull but don't remove from message buffer. More...
virtual unsigned int	remove ()
	Find specified type and remove from buffer, relocating metadata that remains and adjusting reported size of buffer. More...
virtual unsigned int	purge ()
	Traverse metadata headers to find all nullified blocks and remove them from buffer, relocating metadata that remains and adjusting reported size of buffer. More...
virtual bool	isCopyEnabled ()
	Set/Get the 'copy' bit in the specified metadata header. More...
virtual void	setCopyEnable (bool copyEnable)
virtual bool	setLengthAsValue (unsigned int value)
	Set an integer value to be transmitted without using an actual payload. More...
virtual bool	getLengthAsValue (unsigned int &value) const
	Get an integer payload value from the payload length. More...
virtual DtNetMsgHeader *	netMessageHeader ()
	Get the net header of the message. More...

Static Public Member Functions
static void	setMaxDestinations (unsigned int maxDestinations)
	Set/Get the max number of destinations allowed for message. More...
static unsigned int	getMaxDestinations ()
static unsigned long	destinationIndex (unsigned long federateID)
	Return the destination index for the given federate ID. More...
static void	setBit (DtBitMask &bitMask, DtFederateHandle federateHandle, bool isOn=true)
	Set the bit in the given bit mask associated with the given federate handle. More...
Static Public Member Functions inherited from DtRtiMetadata
static unsigned int	metadataMaxSize ()
	Report maximum size of metadata buffer. More...

Protected Attributes
const unsigned int	myPayloadAlignment
Protected Attributes inherited from DtRtiMetadata
DtRtiMsg *	myMsg
caddr_t	myMsgAddr
unsigned int	myMsgLen
char *	myStartAddr
unsigned int	mySize
	address returned by DtRtiMsg::addMetadata() More...
bool	myCopyEnabled
const DtMetadataType	myMetaDataType

Static Protected Attributes
static unsigned int	theMaxDestinations
Static Protected Attributes inherited from DtRtiMetadata
static unsigned int	theMaxMetadataBufferSize

Private Member Functions
	DtRtiMtdDestinationList (const DtRtiMtdDestinationList &)
	Copy CTOR Not Implemented – Copy Not Allowed! More...
DtRtiMtdDestinationList &	operator= (const DtRtiMtdDestinationList &)
	Assignment Operator Not Implemented – Assignment Not Allowed! More...

Additional Inherited Members
Protected Types inherited from DtRtiMetadata
typedef std::list < DtMetadataNetHeader * >	DtMetadataHeaderList
Protected Member Functions inherited from DtRtiMetadata
virtual DtMetadataNetHeader *	getFirstHeader () const
virtual DtMetadataNetHeader *	getHeaderByType () const
virtual DtU16	compactMetadata (char *dst, DtMetadataHeaderList &retentionPool, bool newFinal)
Static Protected Member Functions inherited from DtRtiMetadata
static bool	locate (char const *msg, DtMetadataType type, void **mdVal, unsigned int &size)
	Traverse metadata headers of the given message to find the given metadata type. More...
static bool	typeIsPresent (char const *msg, DtMetadataType type)
	Determines whether metadata type is present in msg. More...
static DtMetadataNetHeader *	getFirstHeader (char const *msg)
static DtMetadataNetHeader *	getNextHeader (DtMetadataNetHeader *hdr)
static DtMetadataNetHeader *	getHeaderByType (char const *msg, DtMetadataType type)
static void	transmogrifyHeader (DtMetadataNetHeader &src, DtMetadataNetHeader &dest)
	Transform from network to host format. More...
static void	reverseTransmogrifyHeader (DtMetadataNetHeader &src, DtMetadataNetHeader &dest)
	Transform from host format to network format. More...
static unsigned int	metadataSize (DtMetadataNetHeader &hdr)
static unsigned int	metadataPayloadSize (DtMetadataNetHeader &hdr)

Constructor & Destructor Documentation

DtRtiMtdDestinationList::DtRtiMtdDestinationList

(

caddr_t

msg

)

Constructor.

DtRtiMtdDestinationList::DtRtiMtdDestinationList

(

DtRtiMsg *

msg

)

virtual DtRtiMtdDestinationList::~DtRtiMtdDestinationList ( )

virtual

Destructor.

DtRtiMtdDestinationList::DtRtiMtdDestinationList ( const DtRtiMtdDestinationList &  )

private

Copy CTOR Not Implemented – Copy Not Allowed!

Member Function Documentation

virtual bool DtRtiMtdDestinationList::addDestination ( DtFederateHandle  handle )

virtual

Add destination for routing. Returns true on success, false otherwise.

static unsigned long DtRtiMtdDestinationList::destinationIndex ( unsigned long  federateID )

static

Return the destination index for the given federate ID.

virtual int DtRtiMtdDestinationList::get ( DtBitMask &  mask ) const

virtual

Find the first destination list within the message metadata.

If none found returns 0. If found copies decoded metatdata to bit mask object supplied (mask) and returns the size of the mask (in bytes). Resizes 'mask' if original supplied is not large enough to accommodate metadata destination list.

static unsigned int DtRtiMtdDestinationList::getMaxDestinations ( )

static

DtRtiMtdDestinationList& DtRtiMtdDestinationList::operator= ( const DtRtiMtdDestinationList &  )

private

Assignment Operator Not Implemented – Assignment Not Allowed!

virtual void DtRtiMtdDestinationList::print ( MAKRti::DtOutputStream &  stream = MAKRti::DtDebug )

virtual

Print this Metadata List.

Reimplemented from DtRtiMetadata.

virtual bool DtRtiMtdDestinationList::removeDestination ( DtFederateHandle  handle )

virtual

Remove destination for routing. Returns true on success, false otherwise.

virtual bool DtRtiMtdDestinationList::set ( DtBitMask &  destinations, unsigned int  maskSize = 0  )

virtual

Reserves space in RTI message buffer (if necessary) for destination bitmask metadata, encodes (serializes) bitmask, and copies into message buffer.

Returns true if successful, false otherwise.

static void DtRtiMtdDestinationList::setBit ( DtBitMask &  bitMask, DtFederateHandle  federateHandle, bool  isOn = true  )

static

Set the bit in the given bit mask associated with the given federate handle.

static void DtRtiMtdDestinationList::setMaxDestinations ( unsigned int  maxDestinations )

static

Set/Get the max number of destinations allowed for message.

Member Data Documentation

const unsigned int DtRtiMtdDestinationList::myPayloadAlignment

protected

unsigned int DtRtiMtdDestinationList::theMaxDestinations

staticprotected

---

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

• metadataDestList.h