DtTransferControlRequestPdu Class Reference

Instances of DtTransferControlRequestPdu are used to initiate the dynamic allocation and control of simulated entities. More...

Inheritance diagram for DtTransferControlRequestPdu:

Collaboration diagram for DtTransferControlRequestPdu:

List of all members.

Public Member Functions
	DtTransferControlRequestPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtTransferControlRequestPdu (const DtNetTransferControlRequestPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtTransferControlRequestPdu (const DtTransferControlRequestPdu &orig)
virtual	~DtTransferControlRequestPdu ()
	destructor
DtTransferControlRequestPdu &	operator= (const DtTransferControlRequestPdu &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	setRequestID (DtU32 id)
	Set/Get request ID.
virtual DtU32	requestID () const
virtual void	setReqRelService (enum DtRequiredReliabilityService service)
	Set/Get required reliability service.
virtual DtRequiredReliabilityService	reqRelService () const
virtual void	setTransferType (DtTransferType type)
	Set/Get transfer type.
virtual DtTransferType	transferType () const
virtual void	setTransferredEntityID (const DtEntityIdentifier &entity)
	Set/Get transferred entity identifier.
virtual const DtEntityIdentifier &	transferredEntityID () 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 DtTransferControlRequestPdu.
static void	addCallback (DtExerciseConn *conn, DtTransferControlRequestPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtTransferControlRequestPduCb cb, void *usr)
Protected Member Functions
virtual DtNetRecordSetPdu *	netRecordSetPduStruct () const
	Returns a pointer to the beginning of the record set data struct.
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetTransferControlRequestPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtTransferControlRequestPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero data bytes.

---

Detailed Description

Instances of DtTransferControlRequestPdu are used to initiate the dynamic allocation and control of simulated entities.

---

Constructor & Destructor Documentation

DtTransferControlRequestPdu::DtTransferControlRequestPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtTransferControlRequestPdu::DtTransferControlRequestPdu	(	const DtNetTransferControlRequestPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtTransferControlRequestPdu::DtTransferControlRequestPdu

(

const DtTransferControlRequestPdu &

orig

)

virtual DtTransferControlRequestPdu::~DtTransferControlRequestPdu

(

)

[virtual]

destructor

---

Member Function Documentation

static void DtTransferControlRequestPdu::addCallback	(	DtExerciseConn *	conn,
		DtTransferControlRequestPduCb	cb,
		void *	usr
	)		[static]

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

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

Create a DtTransferControlRequestPdu.

Caller is responsible for deletion.

virtual DtPduKind DtTransferControlRequestPdu::internalGetPduKind

(

)

const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetTransferControlRequestPdu* DtTransferControlRequestPdu::netPduStruct

(

)

const [protected, virtual]

Casts the netPdu element to our network struct.

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

virtual DtNetRecordSetPdu* DtTransferControlRequestPdu::netRecordSetPduStruct

(

)

const [protected, virtual]

Returns a pointer to the beginning of the record set data struct.

Implements DtRecordSetPdu.

DtTransferControlRequestPdu& DtTransferControlRequestPdu::operator=

(

const DtTransferControlRequestPdu &

orig

)

Assignment operator.

virtual const DtEntityIdentifier& DtTransferControlRequestPdu::originatingEntityID

(

)

const [virtual]

virtual void DtTransferControlRequestPdu::printData

(

)

const [virtual]

Print the data contained by this PDU.

Reimplemented from DtRecordSetPdu.

virtual void DtTransferControlRequestPdu::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the data to a stream.

Reimplemented from DtRecordSetPdu.

virtual const DtEntityIdentifier& DtTransferControlRequestPdu::receivingEntityID

(

)

const [virtual]

static void DtTransferControlRequestPdu::removeCallback	(	DtExerciseConn *	conn,
		DtTransferControlRequestPduCb	cb,
		void *	usr
	)		[static]

virtual DtRequiredReliabilityService DtTransferControlRequestPdu::reqRelService

(

)

const [virtual]

virtual DtU32 DtTransferControlRequestPdu::requestID

(

)

const [virtual]

DtTransferControlRequestPdu* DtTransferControlRequestPdu::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.

Reimplemented from DtRecordSetPdu.

virtual void DtTransferControlRequestPdu::setOriginatingEntityID

(

const DtEntityIdentifier &

entity

)

[virtual]

Set/Get originating entity identifier.

virtual void DtTransferControlRequestPdu::setReceivingEntityID

(

const DtEntityIdentifier &

entity

)

[virtual]

Set/Get receiving entity identifier.

virtual void DtTransferControlRequestPdu::setReqRelService

(

enum DtRequiredReliabilityService

service

)

[virtual]

Set/Get required reliability service.

virtual void DtTransferControlRequestPdu::setRequestID

(

DtU32

id

)

[virtual]

Set/Get request ID.

virtual void DtTransferControlRequestPdu::setTransferredEntityID

(

const DtEntityIdentifier &

entity

)

[virtual]

Set/Get transferred entity identifier.

virtual void DtTransferControlRequestPdu::setTransferType

(

DtTransferType

type

)

[virtual]

Set/Get transfer type.

virtual const DtEntityIdentifier& DtTransferControlRequestPdu::transferredEntityID

(

)

const [virtual]

virtual DtTransferType DtTransferControlRequestPdu::transferType

(

)

const [virtual]

---

Member Data Documentation

DtEntityIdentifier DtTransferControlRequestPdu::myEntityID [protected]

Temporary objects for reference returns.

const int DtTransferControlRequestPdu::theStaticSize [static, protected]

Size of PDU with zero data bytes.

---

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

• transCtlPdu.h