DtLinearObjectStatePdu Class Reference

class DtLinearObjectStatePdu: More...

Inheritance diagram for DtLinearObjectStatePdu:

Collaboration diagram for DtLinearObjectStatePdu:

List of all members.

Public Member Functions
	DtLinearObjectStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtLinearObjectStatePdu (const DtNetLinearObjectStatePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtLinearObjectStatePdu (const DtLinearObjectStatePdu &orig)
virtual	~DtLinearObjectStatePdu ()
	destructor
DtLinearObjectStatePdu &	operator= (const DtLinearObjectStatePdu &orig)
	Assignment operator.
virtual void	setObjectID (const DtEntityIdentifier &id)
	Set/Get object ID.
virtual const DtEntityIdentifier &	objectID () const
virtual void	setReferencedObjectID (const DtEntityIdentifier &id)
	Set/Get referenced object ID.
virtual const DtEntityIdentifier &	referencedObjectID () const
virtual void	setUpdateNumber (DtU16 field)
	Set/Get update number.
virtual DtU16	updateNumber () const
virtual void	setForceID (DtForceType force)
	Set/Get the force ID.
virtual DtForceType	forceID () const
virtual bool	setNumSegments (DtU8 num)
	Set/Get the number of segments.
virtual DtU8	numSegments () const
virtual void	setRequesterID (const DtSimulationAddress &type)
	Set/Get the requester ID.
virtual const DtSimulationAddress &	requesterID () const
virtual void	setReceivingID (const DtSimulationAddress &type)
	Set/Get the receiving ID.
virtual const DtSimulationAddress &	receivingID () const
virtual void	setObjectType (const DtSyntheticEnvironmentObjectType &type)
	Set/Get the object type.
virtual const DtSyntheticEnvironmentObjectType &	objectType () const
virtual bool	setLinearSegmentParameter (int index, const DtLinearSegmentParameter &init)
	Set/Get a linear segment parameter record.
virtual bool	getLinearSegmentParameter (int index, DtLinearSegmentParameter &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 DtLinearObjectStatePdu.
static void	addCallback (DtExerciseConn *conn, DtLinearObjectStatePduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtLinearObjectStatePduCb cb, void *usr)
Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetLinearObjectStatePdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtLinearObjectStatePdu *	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.
Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtSyntheticEnvironmentObjectType	myObjectType
DtSimulationAddress	mySimulationAddress
Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero parameter records.

---

Detailed Description

class DtLinearObjectStatePdu:

Instances of DtLinearObjectStatePdu are used to communicate information about the addition/modification of a synthetic object which is geometrically anchored to the terrain with one point.

---

Constructor & Destructor Documentation

DtLinearObjectStatePdu::DtLinearObjectStatePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtLinearObjectStatePdu::DtLinearObjectStatePdu	(	const DtNetLinearObjectStatePdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtLinearObjectStatePdu::DtLinearObjectStatePdu

(

const DtLinearObjectStatePdu &

orig

)

virtual DtLinearObjectStatePdu::~DtLinearObjectStatePdu

(

)

[virtual]

destructor

---

Member Function Documentation

static void DtLinearObjectStatePdu::addCallback	(	DtExerciseConn *	conn,
		DtLinearObjectStatePduCb	cb,
		void *	usr
	)		[static]

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

static DtPdu* DtLinearObjectStatePdu::create	(	const DtNetPacket *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Create a DtLinearObjectStatePdu.

Caller is responsible for deletion.

virtual DtForceType DtLinearObjectStatePdu::forceID

(

)

const [virtual]

virtual bool DtLinearObjectStatePdu::getLinearSegmentParameter	(	int	index,
		DtLinearSegmentParameter &	record
	)		const [virtual]

virtual DtPduKind DtLinearObjectStatePdu::internalGetPduKind

(

)

const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetLinearObjectStatePdu* DtLinearObjectStatePdu::netPduStruct

(

)

const [protected, virtual]

Casts the netPdu element to our network struct.

virtual DtU8 DtLinearObjectStatePdu::numSegments

(

)

const [virtual]

virtual const DtEntityIdentifier& DtLinearObjectStatePdu::objectID

(

)

const [virtual]

virtual const DtSyntheticEnvironmentObjectType& DtLinearObjectStatePdu::objectType

(

)

const [virtual]

DtLinearObjectStatePdu& DtLinearObjectStatePdu::operator=

(

const DtLinearObjectStatePdu &

orig

)

Assignment operator.

virtual void DtLinearObjectStatePdu::printData

(

)

const [virtual]

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtLinearObjectStatePdu::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the data to a stream.

Reimplemented from DtPdu.

virtual const DtSimulationAddress& DtLinearObjectStatePdu::receivingID

(

)

const [virtual]

virtual const DtEntityIdentifier& DtLinearObjectStatePdu::referencedObjectID

(

)

const [virtual]

static void DtLinearObjectStatePdu::removeCallback	(	DtExerciseConn *	conn,
		DtLinearObjectStatePduCb	cb,
		void *	usr
	)		[static]

virtual const DtSimulationAddress& DtLinearObjectStatePdu::requesterID

(

)

const [virtual]

DtLinearObjectStatePdu* DtLinearObjectStatePdu::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 DtLinearObjectStatePdu::setForceID

(

DtForceType

force

)

[virtual]

Set/Get the force ID.

virtual bool DtLinearObjectStatePdu::setLinearSegmentParameter	(	int	index,
		const DtLinearSegmentParameter &	init
	)		[virtual]

Set/Get a linear segment parameter record.

Returns false if the index is out of range.

virtual bool DtLinearObjectStatePdu::setNumSegments

(

DtU8

num

)

[virtual]

Set/Get the number of segments.

virtual void DtLinearObjectStatePdu::setObjectID

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get object ID.

virtual void DtLinearObjectStatePdu::setObjectType

(

const DtSyntheticEnvironmentObjectType &

type

)

[virtual]

Set/Get the object type.

virtual void DtLinearObjectStatePdu::setReceivingID

(

const DtSimulationAddress &

type

)

[virtual]

Set/Get the receiving ID.

virtual void DtLinearObjectStatePdu::setReferencedObjectID

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get referenced object ID.

virtual void DtLinearObjectStatePdu::setRequesterID

(

const DtSimulationAddress &

type

)

[virtual]

Set/Get the requester ID.

virtual void DtLinearObjectStatePdu::setUpdateNumber

(

DtU16

field

)

[virtual]

Set/Get update number.

virtual DtU16 DtLinearObjectStatePdu::updateNumber

(

)

const [virtual]

virtual char* DtLinearObjectStatePdu::var

(

)

const [protected, virtual]

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

---

Member Data Documentation

DtEntityIdentifier DtLinearObjectStatePdu::myEntityID [protected]

Temporary objects for reference returns.

DtSyntheticEnvironmentObjectType DtLinearObjectStatePdu::myObjectType [protected]

DtSimulationAddress DtLinearObjectStatePdu::mySimulationAddress [protected]

const int DtLinearObjectStatePdu::theStaticSize [static, protected]

Size of PDU with zero parameter records.

---

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

• linObjStPdu.h