DtLeArticulatedPartsPdu Class Reference

class DtLeArticulatedPartsPdu: More...

Inheritance diagram for DtLeArticulatedPartsPdu:

Collaboration diagram for DtLeArticulatedPartsPdu:

List of all members.

Public Member Functions
	DtLeArticulatedPartsPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtLeArticulatedPartsPdu (const DtNetLeArticulatedPartsPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtLeArticulatedPartsPdu (const DtLeArticulatedPartsPdu &orig)
virtual	~DtLeArticulatedPartsPdu ()
	destructor
DtLeArticulatedPartsPdu &	operator= (const DtLeArticulatedPartsPdu &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	numRecords () const
	Get the number of articulation parameter records (this field is automatically set by the PDU when the articulated part list or attached part list is set).
virtual bool	setArtPartParameters (const DtArticulatedPartCollection &partList)
	The articulated parts and attached parts information are both optional.
virtual bool	getArtPartParameters (DtArticulatedPartCollection &partList) const
virtual bool	setAttPartParameters (const DtAttachedPartCollection &partList)
	Set/Get attached parts parameters.
virtual bool	getAttPartParameters (DtAttachedPartCollection &partList) 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.
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.
Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtLeArticulatedPartsPdu.
static void	addCallback (DtExerciseConn *conn, DtLeArticulatedPartsPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtLeArticulatedPartsPduCb cb, void *usr)
Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetLeArticulatedPartsPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtLeArticulatedPartsPdu *	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	setNumRecords (DtU8 value)
	Set number of records.
virtual int	numRecordsOffset () const
	Returns the offset (in bytes) of a field in the variable data region.
virtual int	artParmOffset () const
virtual int	attParmOffset () const
virtual void	fillAttPartNetParams (const DtAttachedPartCollection &partList, DtNetAttachedPart *tempCpy)
virtual void	fillAttPartCollection (DtAttachedPartCollection &partList, const DtNetAttachedPart *tempCpy) const
Protected Attributes
int	myNumArtPartParams
	Number of articulated part parameters for this PDU.
int	myNumAttPartParams
	Number of attached part parameters for this PDU.
DtLeEntityID	myEntityID
	Temporary objects for reference returns.
Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero parameter records.

---

Detailed Description

class DtLeArticulatedPartsPdu:

Instances of DtLeArticulatedPartsPdu are used to send information about articulated and attached parts for live entities.

---

Constructor & Destructor Documentation

DtLeArticulatedPartsPdu::DtLeArticulatedPartsPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtLeArticulatedPartsPdu::DtLeArticulatedPartsPdu	(	const DtNetLeArticulatedPartsPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtLeArticulatedPartsPdu::DtLeArticulatedPartsPdu

(

const DtLeArticulatedPartsPdu &

orig

)

virtual DtLeArticulatedPartsPdu::~DtLeArticulatedPartsPdu

(

)

[virtual]

destructor

---

Member Function Documentation

static void DtLeArticulatedPartsPdu::addCallback	(	DtExerciseConn *	conn,
		DtLeArticulatedPartsPduCb	cb,
		void *	usr
	)		[static]

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

virtual int DtLeArticulatedPartsPdu::artParmOffset

(

)

const [protected, virtual]

virtual int DtLeArticulatedPartsPdu::attParmOffset

(

)

const [protected, virtual]

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

Create a DtLeArticulatedPartsPdu.

Caller is responsible for deletion.

virtual const DtLeEntityID& DtLeArticulatedPartsPdu::entityID

(

)

const [virtual]

virtual void DtLeArticulatedPartsPdu::fillAttPartCollection	(	DtAttachedPartCollection &	partList,
		const DtNetAttachedPart *	tempCpy
	)		const [protected, virtual]

virtual void DtLeArticulatedPartsPdu::fillAttPartNetParams	(	const DtAttachedPartCollection &	partList,
		DtNetAttachedPart *	tempCpy
	)		[protected, virtual]

virtual bool DtLeArticulatedPartsPdu::getArtPartParameters

(

DtArticulatedPartCollection &

partList

)

const [virtual]

virtual bool DtLeArticulatedPartsPdu::getAttPartParameters

(

DtAttachedPartCollection &

partList

)

const [virtual]

virtual DtPduKind DtLeArticulatedPartsPdu::internalGetPduKind

(

)

const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetLeArticulatedPartsPdu* DtLeArticulatedPartsPdu::netPduStruct

(

)

const [protected, virtual]

Casts the netPdu element to our network struct.

virtual DtU8 DtLeArticulatedPartsPdu::numRecords

(

)

const [virtual]

Get the number of articulation parameter records (this field is automatically set by the PDU when the articulated part list or attached part list is set).

virtual int DtLeArticulatedPartsPdu::numRecordsOffset

(

)

const [protected, virtual]

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

DtLeArticulatedPartsPdu& DtLeArticulatedPartsPdu::operator=

(

const DtLeArticulatedPartsPdu &

orig

)

Assignment operator.

virtual void DtLeArticulatedPartsPdu::printData

(

)

const [virtual]

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtLeArticulatedPartsPdu::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the data to a stream.

Reimplemented from DtPdu.

virtual void DtLeArticulatedPartsPdu::printHeader

(

)

const [virtual]

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

Reimplemented from DtPdu.

virtual void DtLeArticulatedPartsPdu::printHeaderToStream

(

std::ostream &

stream

)

const [virtual]

Print the header to a stream.

Reimplemented from DtPdu.

static void DtLeArticulatedPartsPdu::removeCallback	(	DtExerciseConn *	conn,
		DtLeArticulatedPartsPduCb	cb,
		void *	usr
	)		[static]

DtLeArticulatedPartsPdu* DtLeArticulatedPartsPdu::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 DtLeArticulatedPartsPdu::setArtPartParameters

(

const DtArticulatedPartCollection &

partList

)

[virtual]

The articulated parts and attached parts information are both optional.

Either or both can be set. Set/Get articulated parts parameters. Parameters are passed in the form of an articulated parts list. Returns false if the operation could not be performed.

virtual bool DtLeArticulatedPartsPdu::setAttPartParameters

(

const DtAttachedPartCollection &

partList

)

[virtual]

Set/Get attached parts parameters.

Parameters are passed in the form of an attached parts list. Returns false if the operation could not be performed.

virtual void DtLeArticulatedPartsPdu::setEntityID

(

const DtLeEntityID &

id

)

[virtual]

Set/Get entity ID.

virtual void DtLeArticulatedPartsPdu::setNumRecords

(

DtU8

value

)

[protected, virtual]

Set number of records.

virtual void DtLeArticulatedPartsPdu::setSubProtocol

(

DtSubProtocol

value

)

[virtual]

Set/Get the sub-protocol number.

virtual DtSubProtocol DtLeArticulatedPartsPdu::subProtocol

(

)

const [virtual]

virtual char* DtLeArticulatedPartsPdu::var

(

)

const [protected, virtual]

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

---

Member Data Documentation

DtLeEntityID DtLeArticulatedPartsPdu::myEntityID [protected]

Temporary objects for reference returns.

int DtLeArticulatedPartsPdu::myNumArtPartParams [protected]

Number of articulated part parameters for this PDU.

int DtLeArticulatedPartsPdu::myNumAttPartParams [protected]

Number of attached part parameters for this PDU.

const int DtLeArticulatedPartsPdu::theStaticSize [static, protected]

Size of PDU with zero parameter records.

---

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

• leArtPartsPdu.h