DtLeTspiPdu Class Reference

Instances of DtLeTspiPdu are used to send state information for live entities. More...

Inheritance diagram for DtLeTspiPdu:

Collaboration diagram for DtLeTspiPdu:

Public Member Functions
	DtLeTspiPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtLeTspiPdu (const DtNetLeTspiPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	DtLeTspiPdu (const DtLeTspiPdu &orig)
virtual	~DtLeTspiPdu ()
	destructor
DtLeTspiPdu &	operator= (const DtLeTspiPdu &orig)
	Assignment operator.
virtual void	setSubProtocol (DtSubProtocol value)
	Set/Get the sub-protocol number.
virtual DtSubProtocol	subProtocol () const
virtual void	setEntityID (const DtLeEntityID &id)
	Set/Get entity ID.
virtual const DtLeEntityID &	entityID () const
virtual DtU8	tspiField () const
	Get TSPI Flag field (this field is automatically maintained by the PDU as other PDU fields are set).
virtual bool	tspiFlag (DtLE_TSPI_FieldFlag flag) const
	Get the value for a specific TSPI flag from the flag field.
virtual void	setLocation (const DtLeEntityLocationWorldCoordinates &value)
	Set/Get entity location.
virtual const DtLeEntityLocationWorldCoordinates &	location () const
virtual void	setVelocity (const DtLeEntityLinearVelocity &value)
	The following accessor functions refer to records which are optional.
virtual bool	getVelocity (DtLeEntityLinearVelocity &value) const
virtual void	setOrientation (const DtLeEntityOrientation &value)
	Set/Get entity orientation.
virtual bool	getOrientation (DtLeEntityOrientation &value) const
virtual void	setPositionError (const DtLePositionError &value)
	Set/Get position error.
virtual bool	getPositionError (DtLePositionError &value) const
virtual void	setOrientationError (const DtLeOrientationError &value)
	Set/Get orientation error.
virtual bool	getOrientationError (DtLeOrientationError &value) const
virtual void	setDeadReckoningParameters (const DtLeDeadReckoningParameters &value)
	Set/Get dead reckoning parameters.
virtual bool	getDeadReckoningParameters (DtLeDeadReckoningParameters &value) const
virtual void	setMeasuredSpeed (DtU16 value)
	Set/Get measured speed.
virtual bool	getMeasuredSpeed (DtU16 &value) const
virtual bool	setSystemSpecificDataLength (DtU8 value)
	Set/Get the system specific data length.
virtual DtU8	systemSpecificDataLength () const
virtual bool	setSystemSpecificData (DtU8 *dataPtr)
	Set/Get the system specific data (will copy systemSpecificDataLength() bytes on set/get).
virtual bool	getSystemSpecificData (DtU8 *dataPtr)
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data to a stream.
virtual void	printHeader () const
	Print the header (override to include the new sub-protocol field).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the header to a stream.
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)
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	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	printDataToString (DtString &str) const
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, bool skipSizeChanged=false)
	Changes the size of the message.
virtual void	insertBytes (int offset, int numBytes, bool skipSizeChanged=false)
	Inserts numBytes zeroed-out bytes at the indicated offset into the net rep.
virtual void	insertBytes (void *address, int numBytes, bool skipSizeChanged=false)
	Inserts numBytes zeroed-out bytes at the indicated address.
virtual void	deleteBytes (int offset, int numBytes, bool skipSizeChanged=false)
	Deletes numBytes bytes at the indicated offset in the net rep.
virtual void	deleteBytes (void *address, int numBytes, bool skipSizeChanged=false)
	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)
	Create a DtLeTspiPdu.
static void	addCallback (DtExerciseConn *conn, DtLeTspiPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtLeTspiPduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetLeTspiPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtLeTspiPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.
virtual void	setTspiField (DtU8 value)
	Set TSPI Flags.
virtual void	setTspiFlag (DtLE_TSPI_FieldFlag flag)
	Set a flag of the TSPI field.
virtual void	clearTspiFlags (DtLE_TSPI_FieldFlag flag)
	Clear the flag and all following flags in the TSPI field.
virtual int	tspiFlagOffset () const
	Returns the offset (in bytes) of a field from variable data region.
virtual int	locationOffset () const
virtual int	velocityOffset () const
virtual int	orientationOffset () const
virtual int	positionErrorOffset () const
virtual int	orientationErrorOffset () const
virtual int	deadReckoningParametersOffset () const
virtual int	measuredSpeedOffset () const
virtual int	systemSpecificOffset () const

Protected Attributes
DtLeEntityID	myEntityID
	Temporary objects for reference returns.
DtLeEntityLocationWorldCoordinates	myLocation

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

Detailed Description

Instances of DtLeTspiPdu are used to send state information for live entities.

Constructor & Destructor Documentation

DtLeTspiPdu::DtLeTspiPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtLeTspiPdu::DtLeTspiPdu	(	const DtNetLeTspiPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		DtPduFactory *	pduFactory = 0
	)

DtLeTspiPdu::DtLeTspiPdu

(

const DtLeTspiPdu &

orig

)

virtual DtLeTspiPdu::~DtLeTspiPdu ( )

virtual

destructor

Member Function Documentation

static void DtLeTspiPdu::addCallback ( DtExerciseConn *  conn, DtLeTspiPduCb  cb, void *  usr  )

static

Add (register)/Remove (deregister) function to be called when pdu is received.

virtual void DtLeTspiPdu::clearTspiFlags ( DtLE_TSPI_FieldFlag  flag )

protectedvirtual

Clear the flag and all following flags in the TSPI field.

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

static

Create a DtLeTspiPdu.

Caller is responsible for deletion.

virtual int DtLeTspiPdu::deadReckoningParametersOffset ( ) const

protectedvirtual

virtual const DtLeEntityID& DtLeTspiPdu::entityID ( ) const

virtual

virtual bool DtLeTspiPdu::getDeadReckoningParameters ( DtLeDeadReckoningParameters &  value ) const

virtual

virtual bool DtLeTspiPdu::getMeasuredSpeed ( DtU16 &  value ) const

virtual

virtual bool DtLeTspiPdu::getOrientation ( DtLeEntityOrientation &  value ) const

virtual

virtual bool DtLeTspiPdu::getOrientationError ( DtLeOrientationError &  value ) const

virtual

virtual bool DtLeTspiPdu::getPositionError ( DtLePositionError &  value ) const

virtual

virtual bool DtLeTspiPdu::getSystemSpecificData ( DtU8 *  dataPtr )

virtual

virtual bool DtLeTspiPdu::getVelocity ( DtLeEntityLinearVelocity &  value ) const

virtual

virtual DtPduKind DtLeTspiPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual const DtLeEntityLocationWorldCoordinates& DtLeTspiPdu::location ( ) const

virtual

virtual int DtLeTspiPdu::locationOffset ( ) const

protectedvirtual

virtual int DtLeTspiPdu::measuredSpeedOffset ( ) const

protectedvirtual

virtual DtNetLeTspiPdu* DtLeTspiPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

DtLeTspiPdu& DtLeTspiPdu::operator=

(

const DtLeTspiPdu &

orig

)

Assignment operator.

virtual int DtLeTspiPdu::orientationErrorOffset ( ) const

protectedvirtual

virtual int DtLeTspiPdu::orientationOffset ( ) const

protectedvirtual

virtual int DtLeTspiPdu::positionErrorOffset ( ) const

protectedvirtual

virtual void DtLeTspiPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

virtual void DtLeTspiPdu::printHeader ( ) const

virtual

Print the header (override to include the new sub-protocol field).

Reimplemented from DtPdu.

virtual void DtLeTspiPdu::printHeaderToStream ( std::ostream &  stream ) const

virtual

Print the header to a stream.

Reimplemented from DtPdu.

static void DtLeTspiPdu::removeCallback ( DtExerciseConn *  conn, DtLeTspiPduCb  cb, void *  usr  )

static

DtLeTspiPdu* DtLeTspiPdu::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 DtLeTspiPdu::setDeadReckoningParameters ( const DtLeDeadReckoningParameters &  value )

virtual

Set/Get dead reckoning parameters.

virtual void DtLeTspiPdu::setEntityID ( const DtLeEntityID &  id )

virtual

Set/Get entity ID.

virtual void DtLeTspiPdu::setLocation ( const DtLeEntityLocationWorldCoordinates &  value )

virtual

Set/Get entity location.

virtual void DtLeTspiPdu::setMeasuredSpeed ( DtU16  value )

virtual

Set/Get measured speed.

virtual void DtLeTspiPdu::setOrientation ( const DtLeEntityOrientation &  value )

virtual

Set/Get entity orientation.

virtual void DtLeTspiPdu::setOrientationError ( const DtLeOrientationError &  value )

virtual

Set/Get orientation error.

virtual void DtLeTspiPdu::setPositionError ( const DtLePositionError &  value )

virtual

Set/Get position error.

virtual void DtLeTspiPdu::setSubProtocol ( DtSubProtocol  value )

virtual

Set/Get the sub-protocol number.

virtual bool DtLeTspiPdu::setSystemSpecificData ( DtU8 *  dataPtr )

virtual

Set/Get the system specific data (will copy systemSpecificDataLength() bytes on set/get).

Returns false if the length is zero.

virtual bool DtLeTspiPdu::setSystemSpecificDataLength ( DtU8  value )

virtual

Set/Get the system specific data length.

virtual void DtLeTspiPdu::setTspiField ( DtU8  value )

protectedvirtual

Set TSPI Flags.

virtual void DtLeTspiPdu::setTspiFlag ( DtLE_TSPI_FieldFlag  flag )

protectedvirtual

Set a flag of the TSPI field.

virtual void DtLeTspiPdu::setVelocity ( const DtLeEntityLinearVelocity &  value )

virtual

The following accessor functions refer to records which are optional.

The set methods create the record in the PDU if it does not already exist. The get methods return false if the record does not exist. Set/Get entity linear velocity.

virtual DtSubProtocol DtLeTspiPdu::subProtocol ( ) const

virtual

virtual DtU8 DtLeTspiPdu::systemSpecificDataLength ( ) const

virtual

virtual int DtLeTspiPdu::systemSpecificOffset ( ) const

protectedvirtual

virtual DtU8 DtLeTspiPdu::tspiField ( ) const

virtual

Get TSPI Flag field (this field is automatically maintained by the PDU as other PDU fields are set).

virtual bool DtLeTspiPdu::tspiFlag ( DtLE_TSPI_FieldFlag  flag ) const

virtual

Get the value for a specific TSPI flag from the flag field.

virtual int DtLeTspiPdu::tspiFlagOffset ( ) const

protectedvirtual

Returns the offset (in bytes) of a field from variable data region.

virtual char* DtLeTspiPdu::var ( ) const

protectedvirtual

Returns a pointer to the first byte of variable length data.

virtual int DtLeTspiPdu::velocityOffset ( ) const

protectedvirtual

Member Data Documentation

DtLeEntityID DtLeTspiPdu::myEntityID

protected

Temporary objects for reference returns.

DtLeEntityLocationWorldCoordinates DtLeTspiPdu::myLocation

protected

const int DtLeTspiPdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

---

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

• leTspiPdu.h