DtIsGroupOfPdu Class Reference

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:

List of all members.

Public Member Functions
	DtIsGroupOfPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtIsGroupOfPdu (const DtNetIsGroupOfPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	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.
Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	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
	)

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
	)		[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 [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual DtFloat64 DtIsGroupOfPdu::lattitude

(

)

const [virtual]

virtual DtFloat64 DtIsGroupOfPdu::longitude

(

)

const [virtual]

virtual DtNetIsGroupOfPdu* DtIsGroupOfPdu::netPduStruct

(

)

const [protected, virtual]

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 [protected, virtual]

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 [protected, virtual]

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 [static, protected]

Size of PDU with zero parameter records.

---

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

• isGroupOfPdu.h