DtAttributePdu Class Reference

Instances of DtAttributePdu are used to represent the arbitrary attributes added to PDUs. More...

Inheritance diagram for DtAttributePdu:

Collaboration diagram for DtAttributePdu:

Public Member Functions
	DtAttributePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtAttributePdu (const DtNetAttributePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
virtual	~DtAttributePdu ()
	destructor
virtual void	setOriginatingSimulationAddress (const DtSimulationAddress &address)
	Set the Originating Simulation Address.
virtual const DtSimulationAddress &	originatingSimulationAddress () const
	Return the Originating Simulation Address.
virtual void	setAttributeRecordPduType (DtPduKind pduType)
	Set the Attribute Record PDU Type.
virtual DtPduKind	attributeRecordPduType () const
	Return the Attribute Record PDU Type.
virtual void	setAttributeRecordProtocolVersion (DtProtocolFamily protocolFamily)
	Set Attribute Record Protocol Version.
virtual DtProtocolFamily	attributeRecordProtocolVersion () const
	Return the Attribute Record Protocol Version.
virtual void	setMasterAttributeRecordType (DtDatumParam recordType)
	Set the Master Attribute Record Type.
virtual unsigned int	masterAttributeRecordType () const
	Return the Master Attribute Record Type.
virtual void	setActionCode (DtAttributeActionCode actionCode)
	Set the Action Code.
virtual DtAttributeActionCode	actionCode () const
	Return the Action Code.
virtual int	numberOfAttributeRecordSets () const
	Return the Number of Attribute Record Sets.
virtual void	printData () const
	Print the PDU's data (not including header).
virtual void	printDataToStream (std::ostream &stream) const
virtual void	printDataToString (DtString &str) const
Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor
virtual	~DtInteraction ()
	destructor
	DtInteraction (const DtInteraction &orig)
	copy constructor
DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator
Public Member Functions inherited from DtPduWithAttributeRecordSets
	DtPduWithAttributeRecordSets ()
	Constructor.
	DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig)
	Constructor.
DtPduWithAttributeRecordSets &	operator= (const DtPduWithAttributeRecordSets &other)
	Assignment operator.
virtual	~DtPduWithAttributeRecordSets ()
	Destructor.
virtual void	printToStream (std::ostream &stream) const
	Print the contents of the PDU. This will call DtPdu's printToStream and also call printRecordSets()
virtual void	printRecordSets (bool printEntityObjectId=false) const
	Prints the Record Sets to DtInfo.
virtual void	printRecordSetsToStream (std::ostream &stream, bool printEntityObjectId=false) const
	Prints the Record Sets to the specified stream.
virtual void	addRecord (std::auto_ptr< DtStandardVariableRecord > record, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	Adds a Record.
virtual void	removeRecord (unsigned int index, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	Removes a Record.
virtual void	clearRecordSet (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	Removes all Records and deletes the recordSet for the given Entity/Object Identifier.
virtual void	clearAllRecordSets ()
	Removes all RecordSets.
virtual std::vector < DtEntityIdentifier >	recordSetIdentifiers () const
	Returns a vector of Entity/Object Identifiers. These are the Identifiers for the Record Sets.
virtual void	getRecordSetIdentifiers (std::vector< DtEntityIdentifier > &entityIdVector) const
	Returns by reference the vector of Entity/Object Identifiers.
virtual const std::vector < DtStandardVariableRecord * > &	records (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
	This will return the Records for a given Entity/Object Identifier.
virtual const DtAttributeRecordSet &	recordSet (const DtEntityIdentifier &id) const
	This will return the Record Set for a given Entity/Object Identifier.
virtual const std::vector < DtStandardVariableRecord * >	allRecords () const
	This will return the Records of all Record Sets.
virtual unsigned int	numberOfRecords () const
	Returns the number of records for all Record Sets.
virtual unsigned int	numberOfRecords (const DtEntityIdentifier &id) const
	Returns the number of records in the Record Set for the given Entity/Object Identifier.
virtual bool	containsStandardRecordSets () const
	Returns if this PDU contains Standard Record Sets. (This is only applicable to DIS 7 and higher).
virtual const DtSimulationAddress &	attributePduSimulationAddress () const
	Returns the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists.
virtual void	setAttributePduSimulationAddress (const DtSimulationAddress &addr)
	Sets the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists.
virtual void	encode ()
	Encode method.
virtual void	decode (DtPduFactory *pduFactory=0)
	Decode method.
virtual unsigned int	attributeRecordSetsNetSize () const
	Network Size of the all Attribute Record Sets.
virtual unsigned int	recordSetsNetSize () const
	Network Size of the all Record Sets.
virtual void	setStandardVariableRecordFactory (DtStandardVariableRecordFactory *factory)
	Sets/gets the Standard Variable Record Factory used for decoding.
virtual DtStandardVariableRecordFactory *	standardVariableRecordFactory () const
virtual unsigned int	numberOfRecordSets () const
	Gets the number of Attribute Record Sets.
virtual const DtAttributeRecordSetMap &	attributeRecordSetMap () const
	Get the AttributeRecordSet Map.
virtual int	computeMasterAttributeRecordType () const
	Get the Master Attribute Record Type (if applicable, this will return MULTIPLES_PRESENT if not)
virtual void	setAttributeStrategy (DtAttributePduStrategy strat)
virtual DtAttributePduStrategy	attributePduStrategy () const
virtual bool	shouldAttributePduBeCoupled () const
Public Member Functions inherited from DtPdu
virtual	~DtPdu ()
	Destructor.
	DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtPdu &	operator= (const DtPdu &pdu)
	Assignment operator.
virtual void *	packet () const
	Older function that returns a pointer to the network representation.
virtual int	status () const
	Get PDU status.
virtual void	setVersion (int vers)
	Set/Get protocol version from PDU header.
virtual int	protocolVersion () const
virtual void	setExerciseId (int id)
	Set/Get exerciseID in PDU header.
virtual int	exerciseId () const
virtual DtPduKind	kind () const
	Returns PDU kind from PDU header.
virtual DtProtocolFamily	protocolFamily () const
	Returns protocol family from PDU header.
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the PDU header's time stamp to reflect time and type.
virtual DtTime	timeStamp () const
	Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp, as indicated in PDU header.
virtual void	setReceivedTime (DtTime t)
	absRealTime when PDU was received into buffer.
virtual DtTime	receivedTime () const
virtual void	setPduLength (unsigned int length)
	Set the PDU header's length.
virtual unsigned int	pduLength () const
	Return the length of the PDU, as indicated in the PDU header.
virtual void	setPduStatus (int)
	Set the PDU Status in the PDU header.
virtual int	pduStatus () const
	Returns the PDU Status from the PDU header.
virtual void	setTransferredEntityIndicator (bool difference)
	Set the Transferred Entity Indicator in the PDU header False is No Difference True is Difference.
virtual bool	transferredEntityIndicator () const
	Returns the Transferred Entity Indicator from the PDU header False is No Difference True is Difference.
virtual void	setLvcIndicator (DtPduStatusLVCIndicator lvcIndicator)
	Set the LVC Indicator in the PDU header.
virtual DtPduStatusLVCIndicator	lvcIndicator () const
	Returns the LVC Indicator from the PDU header.
virtual void	setCoupledExtensionIndicator (bool coupled)
	Set the Coupled Extension Indicator in the PDU Header False is Not Coupled True is Coupled.
virtual bool	coupledExtensionIndicator () const
	Returns the Coupled Extension Indicator from the PDU Header False is Not Coupled True is Coupled.
virtual void	setFireTypeIndicator (DtPduStatusFireTypeIndicator fireTypeIndicator)
	Set the Fire Type Indicator in the PDU header.
virtual DtPduStatusFireTypeIndicator	fireTypeIndicator () const
	Returns the Fire Type Indicator from the PDU header.
virtual void	setDetonationTypeIndicator (DtPduStatusDetonationTypeIndicator detonationTypeIndicator)
	Set the Detonation Type Indicator in the PDU header.
virtual DtPduStatusDetonationTypeIndicator	detonationTypeIndicator () const
	Returns the Detonation Type Indicator from the PDU header.
virtual void	setRadioAttachedIndicator (DtPduStatusRadioAttachedIndicator radioAttachedIndicator)
	Set the Radio Attached Indicator in the PDU header.
virtual DtPduStatusRadioAttachedIndicator	radioAttachedIndicator () const
	Returns the Radio Attached Indicator from the PDU header.
virtual void	setIntercomAttachedIndicator (DtPduStatusIntercomAttachedIndicator intercomAttachedIndicator)
	Set the Intercom Attached Indicator in the PDU header.
virtual DtPduStatusIntercomAttachedIndicator	intercomAttachedIndicator () const
	Returns the Intercom Attached Indicator from the PDU header.
virtual void	setIffSimulationMode (bool interactive)
	Set the IFF Simulation Mode in the PDU header.
virtual bool	iffSimulationMode () const
	Returns the IFF Simulation Mode from the PDU header.
virtual void	setActiveInterrogationIndicator (bool active)
	Set the Active Interrogation Indicator in the PDU header.
virtual bool	activeInterrogationIndicator () const
	Returns the Active Interrogation Indicator from the PDU header.
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual DtNetPduHeader *	netHeader () const
	Returns a pointer to the PDU's header.
virtual void	print () const
	Print the contents of the PDU by calling printToStream(DtInfo).
virtual void	printHeader () const
	Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the PDU's header to a stream.
virtual void	printPduInHexToStream (std::ostream &stream, unsigned int numberOfColumns) const
	Prints the entire PDU's internal buffer to the stream in Hex.
virtual bool	isTransientPdu () const
	This method returns true if transient, false if state.
Public Member Functions inherited from DtBaseMsg
virtual	~DtBaseMsg ()
	Destructor.
	DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtBaseMsg &	operator= (const DtBaseMsg &msg)
	Assignment.
virtual const char *	netRep () const
	Get network representation.
virtual int	length () const
	Get size of message.
	DtBaseMsg ()
	Constructor Object is not fully constructed until initMsg is called.
void	initMsg (int size, DtBufferPtr bufferPtr)
void	initMsg (const void *initial, int size, DtBufferPtr bufferPtr)
virtual void	changeSize (int size)
	Changes the size of the message.
virtual void	changeBufferSize (int size)
	Changes the size of the message buffer, but not the message itself.
virtual void	insertBytes (int offset, int numBytes)
	Inserts numBytes zeroed-out bytes at the indicated offset into the net rep.
virtual void	insertBytes (void *address, int numBytes)
	Inserts numBytes zeroed-out bytes at the indicated address.
virtual void	deleteBytes (int offset, int numBytes)
	Deletes numBytes bytes at the indicated offset in the net rep.
virtual void	deleteBytes (void *address, int numBytes)
	Deletes numBytes bytes starting at the indicated address.
virtual void	clearAll ()
	Zeros out all bytes in the network representation.
virtual void *	newInternalBuffer (int size)
	Sets myInternalBuff to point to a malloc'ed buffer of size bytes.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
static void	addCallback (DtExerciseConn *conn, DtAttributeInteractionCb cb, void *usr)
static void	removeCallback (DtExerciseConn *conn, DtAttributeInteractionCb cb, void *usr)
static DtAttributePdu *	createFromDtPdu (const DtPduWithAttributeRecordSets *pdu, void *usrData=0)

Protected Member Functions
DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetAttributePdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtAttributePdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.

Protected Attributes
DtSimulationAddress	mySimulationAddress
DtPduKind	myAttributeRecordPduType
DtProtocolFamily	myAttributeRecordProtocolVersion
unsigned int	myMasterAttributeRecordType
DtAttributeActionCode	myActionCode

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero records.

Detailed Description

Instances of DtAttributePdu are used to represent the arbitrary attributes added to PDUs.

Constructor & Destructor Documentation

DtAttributePdu::DtAttributePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

DtAttributePdu::DtAttributePdu	(	const DtNetAttributePdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		DtPduFactory *	pduFactory = 0
	)

virtual DtAttributePdu::~DtAttributePdu ( )

virtual

destructor

Member Function Documentation

virtual DtAttributeActionCode DtAttributePdu::actionCode ( ) const

virtual

Return the Action Code.

static void DtAttributePdu::addCallback ( DtExerciseConn *  conn, DtAttributeInteractionCb  cb, void *  usr  )

static

virtual DtPduKind DtAttributePdu::attributeRecordPduType ( ) const

virtual

Return the Attribute Record PDU Type.

virtual DtProtocolFamily DtAttributePdu::attributeRecordProtocolVersion ( ) const

virtual

Return the Attribute Record Protocol Version.

static DtPdu* DtAttributePdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory *  pduFactory = 0  )

static

static DtAttributePdu* DtAttributePdu::createFromDtPdu ( const DtPduWithAttributeRecordSets *  pdu, void *  usrData = 0  )

static

DtPduKind DtAttributePdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtAttributePduKind.

virtual unsigned int DtAttributePdu::masterAttributeRecordType ( ) const

virtual

Return the Master Attribute Record Type.

virtual DtNetAttributePdu* DtAttributePdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual int DtAttributePdu::numberOfAttributeRecordSets ( ) const

virtual

Return the Number of Attribute Record Sets.

virtual const DtSimulationAddress& DtAttributePdu::originatingSimulationAddress ( ) const

virtual

Return the Originating Simulation Address.

virtual void DtAttributePdu::printData ( ) const

virtual

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented from DtPdu.

virtual void DtAttributePdu::printDataToStream ( std::ostream &  stream ) const

virtual

Reimplemented from DtPdu.

virtual void DtAttributePdu::printDataToString ( DtString &  str ) const

virtual

Reimplemented from DtPdu.

static void DtAttributePdu::removeCallback ( DtExerciseConn *  conn, DtAttributeInteractionCb  cb, void *  usr  )

static

DtAttributePdu* DtAttributePdu::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

Non-virtual since you can't override based on return type.

virtual void DtAttributePdu::setActionCode ( DtAttributeActionCode  actionCode )

virtual

Set the Action Code.

virtual void DtAttributePdu::setAttributeRecordPduType ( DtPduKind  pduType )

virtual

Set the Attribute Record PDU Type.

virtual void DtAttributePdu::setAttributeRecordProtocolVersion ( DtProtocolFamily  protocolFamily )

virtual

Set Attribute Record Protocol Version.

virtual void DtAttributePdu::setMasterAttributeRecordType ( DtDatumParam  recordType )

virtual

Set the Master Attribute Record Type.

virtual void DtAttributePdu::setOriginatingSimulationAddress ( const DtSimulationAddress &  address )

virtual

Set the Originating Simulation Address.

Member Data Documentation

DtAttributeActionCode DtAttributePdu::myActionCode

protected

DtPduKind DtAttributePdu::myAttributeRecordPduType

protected

DtProtocolFamily DtAttributePdu::myAttributeRecordProtocolVersion

protected

unsigned int DtAttributePdu::myMasterAttributeRecordType

protected

DtSimulationAddress DtAttributePdu::mySimulationAddress

protected

const int DtAttributePdu::theStaticSize

staticprotected

Size of PDU with zero records.

---

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

• attributePdu.h