Instances of DtIsGroupOfPdu are used to communicate information about a particular group of entities (grouped together for the purposes of network bandwidth reduction). More...

Inheritance diagram for DtIsGroupOfPdu:

Collaboration diagram for DtIsGroupOfPdu:

Public Member Functions
	DtIsGroupOfPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtIsGroupOfPdu (const DtNetIsGroupOfPdu initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory pduFactory=0)
	DtIsGroupOfPdu (const DtIsGroupOfPdu &orig)
virtual	~DtIsGroupOfPdu ()
	destructor
DtIsGroupOfPdu &	operator= (const DtIsGroupOfPdu &orig)
	Assignment operator.
virtual void	setGroupEntityID (const DtEntityIdentifier &id)
	Set/Get group entity ID.
virtual const DtEntityIdentifier &	groupEntityID () const
virtual void	setCategory (DtGroupedEntityCategory value)
	Set/Get the grouped entity category.
virtual DtGroupedEntityCategory	category () const
virtual bool	setNumEntities (DtU8 num)
	Set/Get the number of entities.
virtual DtU8	numEntities () const
virtual void	setLattitude (DtFloat64 value)
	Set/Get the reference lattitude.
virtual DtFloat64	lattitude () const
virtual void	setLongitude (DtFloat64 value)
	Set/Get the reference longitude.
virtual DtFloat64	longitude () const
virtual bool	setBasicFixedWingAircraftRecord (int index, const DtBasicFixedWingAircraftRecord &init)
	Set/Get a BasicFixedWingAircraftRecord.
virtual bool	getBasicFixedWingAircraftRecord (int index, DtBasicFixedWingAircraftRecord &record) const
virtual bool	setEnhancedFixedWingAircraftRecord (int index, const DtEnhancedFixedWingAircraftRecord &init)
	Set/Get an EnhancedFixedWingAircraftRecord.
virtual bool	getEnhancedFixedWingAircraftRecord (int index, DtEnhancedFixedWingAircraftRecord &record) const
virtual bool	setBasicRotorWingAircraftRecord (int index, const DtBasicRotorWingAircraftRecord &init)
	Set/Get a BasicRotorWingAircraftRecord.
virtual bool	getBasicRotorWingAircraftRecord (int index, DtBasicRotorWingAircraftRecord &record) const
virtual bool	setEnhancedRotorWingAircraftRecord (int index, const DtEnhancedRotorWingAircraftRecord &init)
	Set/Get an EnhancedRotorWingAircraftRecord.
virtual bool	getEnhancedRotorWingAircraftRecord (int index, DtEnhancedRotorWingAircraftRecord &record) const
virtual bool	setBasicGroundCombatSoldierRecord (int index, const DtBasicGroundCombatSoldierRecord &init)
	Set/Get a BasicGroundCombatSoldierRecord.
virtual bool	getBasicGroundCombatSoldierRecord (int index, DtBasicGroundCombatSoldierRecord &record) const
virtual bool	setEnhancedGroundCombatSoldierRecord (int index, const DtEnhancedGroundCombatSoldierRecord &init)
	Set/Get an EnhancedGroundCombatSoldierRecord.
virtual bool	getEnhancedGroundCombatSoldierRecord (int index, DtEnhancedGroundCombatSoldierRecord &record) const
virtual bool	setBasicGroundCombatVehicleRecord (int index, const DtBasicGroundCombatVehicleRecord &init)
	Set/Get a BasicGroundCombatVehicleRecord.
virtual bool	getBasicGroundCombatVehicleRecord (int index, DtBasicGroundCombatVehicleRecord &record) const
virtual bool	setEnhancedGroundCombatVehicleRecord (int index, const DtEnhancedGroundCombatVehicleRecord &init)
	Set/Get an EnhancedGroundCombatVehicleRecord.
virtual bool	getEnhancedGroundCombatVehicleRecord (int index, DtEnhancedGroundCombatVehicleRecord &record) const
virtual bool	setGroundLogisticsVehicleRecord (int index, const DtGroundLogisticsVehicleRecord &init)
	Set/Get a GroundLogisticsVehicleRecord.
virtual bool	getGroundLogisticsVehicleRecord (int index, DtGroundLogisticsVehicleRecord &record) const
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data 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	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	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 DtIsGroupOfPdu.
static void	addCallback (DtExerciseConn conn, DtIsGroupOfPduCb cb, void usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn conn, DtIsGroupOfPduCb cb, void usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetIsGroupOfPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtIsGroupOfPdu *	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 int	recordSize () const
	Returns the record size for the grouped entity category.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.

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

Detailed Description

Instances of DtIsGroupOfPdu are used to communicate information about a particular group of entities (grouped together for the purposes of network bandwidth reduction).

Constructor & Destructor Documentation

DtIsGroupOfPdu::DtIsGroupOfPdu ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructors.

DtIsGroupOfPdu::DtIsGroupOfPdu	(	const DtNetIsGroupOfPdu *	initial,
		DtBufferPtr	buffer = `DtUSE_INTERNAL_BUFFER`,
		DtPduFactory *	pduFactory = `0`
	)

DtIsGroupOfPdu::DtIsGroupOfPdu ( const DtIsGroupOfPdu & orig )

virtual DtIsGroupOfPdu::~DtIsGroupOfPdu ( )

virtual

destructor

Member Function Documentation

static void DtIsGroupOfPdu::addCallback	(	DtExerciseConn *	conn,
		DtIsGroupOfPduCb	cb,
		void *	usr
	)

static

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

virtual DtGroupedEntityCategory DtIsGroupOfPdu::category ( ) const

virtual

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

static

Create a DtIsGroupOfPdu.

Caller is responsible for deletion.

virtual bool DtIsGroupOfPdu::getBasicFixedWingAircraftRecord	(	int	index,
		DtBasicFixedWingAircraftRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getBasicGroundCombatSoldierRecord	(	int	index,
		DtBasicGroundCombatSoldierRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getBasicGroundCombatVehicleRecord	(	int	index,
		DtBasicGroundCombatVehicleRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getBasicRotorWingAircraftRecord	(	int	index,
		DtBasicRotorWingAircraftRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getEnhancedFixedWingAircraftRecord	(	int	index,
		DtEnhancedFixedWingAircraftRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getEnhancedGroundCombatSoldierRecord	(	int	index,
		DtEnhancedGroundCombatSoldierRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getEnhancedGroundCombatVehicleRecord	(	int	index,
		DtEnhancedGroundCombatVehicleRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getEnhancedRotorWingAircraftRecord	(	int	index,
		DtEnhancedRotorWingAircraftRecord &	record
	)		const

virtual

virtual bool DtIsGroupOfPdu::getGroundLogisticsVehicleRecord	(	int	index,
		DtGroundLogisticsVehicleRecord &	record
	)		const

virtual

virtual const DtEntityIdentifier& DtIsGroupOfPdu::groupEntityID ( ) const

virtual

virtual DtPduKind DtIsGroupOfPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual DtFloat64 DtIsGroupOfPdu::lattitude ( ) const

virtual

virtual DtFloat64 DtIsGroupOfPdu::longitude ( ) const

virtual

virtual DtNetIsGroupOfPdu* DtIsGroupOfPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU8 DtIsGroupOfPdu::numEntities ( ) const

virtual

DtIsGroupOfPdu& DtIsGroupOfPdu::operator= ( const DtIsGroupOfPdu & orig )

Assignment operator.

virtual void DtIsGroupOfPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

virtual int DtIsGroupOfPdu::recordSize ( ) const

protectedvirtual

Returns the record size for the grouped entity category.

static void DtIsGroupOfPdu::removeCallback	(	DtExerciseConn *	conn,
		DtIsGroupOfPduCb	cb,
		void *	usr
	)

static

DtIsGroupOfPdu* DtIsGroupOfPdu::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 bool DtIsGroupOfPdu::setBasicFixedWingAircraftRecord	(	int	index,
		const DtBasicFixedWingAircraftRecord &	init
	)

virtual

Set/Get a BasicFixedWingAircraftRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual bool DtIsGroupOfPdu::setBasicGroundCombatSoldierRecord	(	int	index,
		const DtBasicGroundCombatSoldierRecord &	init
	)

virtual

Set/Get a BasicGroundCombatSoldierRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual bool DtIsGroupOfPdu::setBasicGroundCombatVehicleRecord	(	int	index,
		const DtBasicGroundCombatVehicleRecord &	init
	)

virtual

Set/Get a BasicGroundCombatVehicleRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual bool DtIsGroupOfPdu::setBasicRotorWingAircraftRecord	(	int	index,
		const DtBasicRotorWingAircraftRecord &	init
	)

virtual

Set/Get a BasicRotorWingAircraftRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual void DtIsGroupOfPdu::setCategory ( DtGroupedEntityCategory value )

virtual

Set/Get the grouped entity category.

(setCategory will also set the number of entities to zero).

virtual bool DtIsGroupOfPdu::setEnhancedFixedWingAircraftRecord	(	int	index,
		const DtEnhancedFixedWingAircraftRecord &	init
	)

virtual

Set/Get an EnhancedFixedWingAircraftRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual bool DtIsGroupOfPdu::setEnhancedGroundCombatSoldierRecord	(	int	index,
		const DtEnhancedGroundCombatSoldierRecord &	init
	)

virtual

Set/Get an EnhancedGroundCombatSoldierRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual bool DtIsGroupOfPdu::setEnhancedGroundCombatVehicleRecord	(	int	index,
		const DtEnhancedGroundCombatVehicleRecord &	init
	)

virtual

Set/Get an EnhancedGroundCombatVehicleRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual bool DtIsGroupOfPdu::setEnhancedRotorWingAircraftRecord	(	int	index,
		const DtEnhancedRotorWingAircraftRecord &	init
	)

virtual

Set/Get an EnhancedRotorWingAircraftRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual bool DtIsGroupOfPdu::setGroundLogisticsVehicleRecord	(	int	index,
		const DtGroundLogisticsVehicleRecord &	init
	)

virtual

Set/Get a GroundLogisticsVehicleRecord.

Returns false if the index is out of range, or if the entity category does not match.

virtual void DtIsGroupOfPdu::setGroupEntityID ( const DtEntityIdentifier & id )

virtual

Set/Get group entity ID.

virtual void DtIsGroupOfPdu::setLattitude ( DtFloat64 value )

virtual

Set/Get the reference lattitude.

virtual void DtIsGroupOfPdu::setLongitude ( DtFloat64 value )

virtual

Set/Get the reference longitude.

virtual bool DtIsGroupOfPdu::setNumEntities ( DtU8 num )

virtual

Set/Get the number of entities.

virtual char* DtIsGroupOfPdu::var ( ) const

protectedvirtual

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

Member Data Documentation

DtEntityIdentifier DtIsGroupOfPdu::myEntityID

protected

Temporary objects for reference returns.

const int DtIsGroupOfPdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

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

isGroupOfPdu.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation