DtIsPartOfPdu Class Reference

Instances of DtIsPartOfPdu are used to join two simulation entities to form a single entity. More...

Inheritance diagram for DtIsPartOfPdu:

Collaboration diagram for DtIsPartOfPdu:

List of all members.

Public Member Functions
	DtIsPartOfPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtIsPartOfPdu (const DtNetIsPartOfPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtIsPartOfPdu (const DtIsPartOfPdu &orig)
virtual	~DtIsPartOfPdu ()
	destructor
DtIsPartOfPdu &	operator= (const DtIsPartOfPdu &orig)
	Assignment operator.
virtual void	setOriginatingEntityID (const DtEntityIdentifier &entity)
	Set/Get originating entity identifier.
virtual const DtEntityIdentifier &	originatingEntityID () const
virtual void	setReceivingEntityID (const DtEntityIdentifier &entity)
	Set/Get receiving entity identifier.
virtual const DtEntityIdentifier &	receivingEntityID () const
virtual void	setNature (DtNature value)
	Set/Get nature.
virtual DtNature	nature () const
virtual void	setConstituentPartPosition (DtPosition value)
	Set/Get position.
virtual DtPosition	constituentPartPosition () const
virtual void	setPartLocation (const DtVector &coords)
	Set/Get part location.
virtual const DtVector &	partLocation () const
virtual void	setStationName (DtStationName value)
	Set/Get station name.
virtual DtStationName	stationName () const
virtual void	setStationNumber (DtU16 value)
	Set/Get Station number.
virtual DtU16	stationNumber () const
virtual void	setEntityType (const DtEntityType &type)
	Set/Get Part Entity Type.
virtual const DtEntityType &	entityType () 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 DtIsPartOfPdu.
static void	addCallback (DtExerciseConn *conn, DtIsPartOfPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtIsPartOfPduCb cb, void *usr)
Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetIsPartOfPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtIsPartOfPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtVector	myVector
DtEntityType	myEntityType
Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero data bytes.

---

Detailed Description

Instances of DtIsPartOfPdu are used to join two simulation entities to form a single entity.

---

Constructor & Destructor Documentation

DtIsPartOfPdu::DtIsPartOfPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtIsPartOfPdu::DtIsPartOfPdu	(	const DtNetIsPartOfPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtIsPartOfPdu::DtIsPartOfPdu

(

const DtIsPartOfPdu &

orig

)

virtual DtIsPartOfPdu::~DtIsPartOfPdu

(

)

[virtual]

destructor

---

Member Function Documentation

static void DtIsPartOfPdu::addCallback	(	DtExerciseConn *	conn,
		DtIsPartOfPduCb	cb,
		void *	usr
	)		[static]

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

virtual DtPosition DtIsPartOfPdu::constituentPartPosition

(

)

const [virtual]

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

Create a DtIsPartOfPdu.

Caller is responsible for deletion.

virtual const DtEntityType& DtIsPartOfPdu::entityType

(

)

const [virtual]

virtual DtPduKind DtIsPartOfPdu::internalGetPduKind

(

)

const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNature DtIsPartOfPdu::nature

(

)

const [virtual]

virtual DtNetIsPartOfPdu* DtIsPartOfPdu::netPduStruct

(

)

const [protected, virtual]

Casts the netPdu element to our network struct.

Non-virtual, since you can't override based on return type.

DtIsPartOfPdu& DtIsPartOfPdu::operator=

(

const DtIsPartOfPdu &

orig

)

Assignment operator.

virtual const DtEntityIdentifier& DtIsPartOfPdu::originatingEntityID

(

)

const [virtual]

virtual const DtVector& DtIsPartOfPdu::partLocation

(

)

const [virtual]

virtual void DtIsPartOfPdu::printData

(

)

const [virtual]

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtIsPartOfPdu::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the data to a stream.

Reimplemented from DtPdu.

virtual const DtEntityIdentifier& DtIsPartOfPdu::receivingEntityID

(

)

const [virtual]

static void DtIsPartOfPdu::removeCallback	(	DtExerciseConn *	conn,
		DtIsPartOfPduCb	cb,
		void *	usr
	)		[static]

DtIsPartOfPdu* DtIsPartOfPdu::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 DtIsPartOfPdu::setConstituentPartPosition

(

DtPosition

value

)

[virtual]

Set/Get position.

virtual void DtIsPartOfPdu::setEntityType

(

const DtEntityType &

type

)

[virtual]

Set/Get Part Entity Type.

virtual void DtIsPartOfPdu::setNature

(

DtNature

value

)

[virtual]

Set/Get nature.

virtual void DtIsPartOfPdu::setOriginatingEntityID

(

const DtEntityIdentifier &

entity

)

[virtual]

Set/Get originating entity identifier.

virtual void DtIsPartOfPdu::setPartLocation

(

const DtVector &

coords

)

[virtual]

Set/Get part location.

virtual void DtIsPartOfPdu::setReceivingEntityID

(

const DtEntityIdentifier &

entity

)

[virtual]

Set/Get receiving entity identifier.

virtual void DtIsPartOfPdu::setStationName

(

DtStationName

value

)

[virtual]

Set/Get station name.

virtual void DtIsPartOfPdu::setStationNumber

(

DtU16

value

)

[virtual]

Set/Get Station number.

virtual DtStationName DtIsPartOfPdu::stationName

(

)

const [virtual]

virtual DtU16 DtIsPartOfPdu::stationNumber

(

)

const [virtual]

---

Member Data Documentation

DtEntityIdentifier DtIsPartOfPdu::myEntityID [protected]

Temporary objects for reference returns.

DtEntityType DtIsPartOfPdu::myEntityType [protected]

DtVector DtIsPartOfPdu::myVector [protected]

const int DtIsPartOfPdu::theStaticSize [static, protected]

Size of PDU with zero data bytes.

---

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

• isPartOfPdu.h