DtIntercomControlPdu Class Reference

Instances of DtIntercomControlPdu are used to communicate state information for simulated intercom devices. More...

Inheritance diagram for DtIntercomControlPdu:

Collaboration diagram for DtIntercomControlPdu:

List of all members.

Public Member Functions
	DtIntercomControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtIntercomControlPdu (const DtNetIntercomControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtIntercomControlPdu (const DtIntercomControlPdu &orig)
virtual	~DtIntercomControlPdu ()
	destructor
DtIntercomControlPdu &	operator= (const DtIntercomControlPdu &orig)
	Assignment operator.
virtual void	setControlType (DtIntercomCtlType controlType)
	Set/Get intercom control type.
virtual DtIntercomCtlType	controlType () const
virtual void	setCommClass (DtIntercomCommClass commClass)
	Set/Get intercom communications channel class.
virtual DtIntercomCommClass	commClass () const
virtual void	setCommType (DtIntercomCommType commType)
	Set/Get intercom communications channel type.
virtual DtIntercomCommType	commType () const
virtual void	setSourceEntityID (const DtEntityIdentifier &entity)
	Set/Get source entity identifier.
virtual const DtEntityIdentifier &	sourceEntityID () const
virtual void	setSourceDeviceID (DtU16 deviceID)
	Set/Get source communications device ID.
virtual DtU16	sourceDeviceID () const
virtual void	setSourceLineID (DtU8 lineID)
	Set/Get source line ID.
virtual DtU8	sourceLineID () const
virtual void	setTransmitPriority (DtU8 transmitPriority)
	Set/Get transmit priority.
virtual DtU8	transmitPriority () const
virtual void	setTransmitLineState (DtIntercomTransLineState lineState)
	Set/Get transmit line state.
virtual DtIntercomTransLineState	transmitLineState () const
virtual void	setCmdType (DtIntercomCmdType cmdType)
	Set/Get intercom command type.
virtual DtIntercomCmdType	cmdType () const
virtual void	setMasterEntityID (const DtEntityIdentifier &entity)
	Set/Get master entity identifier.
virtual const DtEntityIdentifier &	masterEntityID () const
virtual void	setMasterDeviceID (DtU16 deviceID)
	Set/Get master communications device ID.
virtual DtU16	masterDeviceID () const
virtual void	setMasterChannelID (DtU16 channelID)
	Set/Get master channel ID.
virtual DtU16	masterChannelID () const
virtual DtU32	parmRecordsLength () const
	Get the parameters length.
virtual bool	setNumParmRecords (int numRecords)
	Set/Get number of parameter records (this is not a PDU field).
virtual int	numParmRecords () const
virtual bool	getRecordType (int parmIndex, DtIntercomCtlRecType &recordType) const
	Get the record type for parameter record parmIndex.
virtual bool	setParmRecord (int parmIndex, const DtIntercomEntityDestRec &init)
	Set/Get the parameter record type and values of record parmIndex to values specified by the initializer in the second argument.
virtual bool	getParmRecord (int parmIndex, DtIntercomEntityDestRec &record) const
virtual bool	setParmRecord (int parmIndex, const DtIntercomGroupDestRec &init)
virtual bool	getParmRecord (int parmIndex, DtIntercomGroupDestRec &record) const
virtual bool	setParmRecord (int parmIndex, const DtIntercomGroupAsgmtRec &init)
virtual bool	getParmRecord (int parmIndex, DtIntercomGroupAsgmtRec &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 DtIntercomControlPdu.
static void	addCallback (DtExerciseConn *conn, DtIntercomControlPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtIntercomControlPduCb cb, void *usr)
Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetIntercomControlPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtIntercomControlPdu *	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	recordOffset (int recordIndex) const
	Returns the offset (in bytes) of the given parameter record.
virtual void	resizeRecord (DtNetIntercomParmRec *rec, int newSize)
	Resize a given parameter record to the size indicated.
Protected Attributes
int	myNumParmRecords
	Number of parameter records in this PDU.
DtEntityIdentifier	myEntityID
	Temporary object for reference returns.
Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero parameter records.

---

Detailed Description

Instances of DtIntercomControlPdu are used to communicate state information for simulated intercom devices.

---

Constructor & Destructor Documentation

DtIntercomControlPdu::DtIntercomControlPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtIntercomControlPdu::DtIntercomControlPdu	(	const DtNetIntercomControlPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtIntercomControlPdu::DtIntercomControlPdu

(

const DtIntercomControlPdu &

orig

)

virtual DtIntercomControlPdu::~DtIntercomControlPdu

(

)

[virtual]

destructor

---

Member Function Documentation

static void DtIntercomControlPdu::addCallback	(	DtExerciseConn *	conn,
		DtIntercomControlPduCb	cb,
		void *	usr
	)		[static]

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

virtual DtIntercomCmdType DtIntercomControlPdu::cmdType

(

)

const [virtual]

virtual DtIntercomCommClass DtIntercomControlPdu::commClass

(

)

const [virtual]

virtual DtIntercomCommType DtIntercomControlPdu::commType

(

)

const [virtual]

virtual DtIntercomCtlType DtIntercomControlPdu::controlType

(

)

const [virtual]

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

Create a DtIntercomControlPdu.

Caller is responsible for deletion.

virtual bool DtIntercomControlPdu::getParmRecord	(	int	parmIndex,
		DtIntercomEntityDestRec &	record
	)		const [virtual]

virtual bool DtIntercomControlPdu::getParmRecord	(	int	parmIndex,
		DtIntercomGroupDestRec &	record
	)		const [virtual]

virtual bool DtIntercomControlPdu::getParmRecord	(	int	parmIndex,
		DtIntercomGroupAsgmtRec &	record
	)		const [virtual]

virtual bool DtIntercomControlPdu::getRecordType	(	int	parmIndex,
		DtIntercomCtlRecType &	recordType
	)		const [virtual]

Get the record type for parameter record parmIndex.

If parmIndex is out of range or the parameter is invalid, then false is returned.

virtual DtPduKind DtIntercomControlPdu::internalGetPduKind

(

)

const [protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

virtual DtU16 DtIntercomControlPdu::masterChannelID

(

)

const [virtual]

virtual DtU16 DtIntercomControlPdu::masterDeviceID

(

)

const [virtual]

virtual const DtEntityIdentifier& DtIntercomControlPdu::masterEntityID

(

)

const [virtual]

virtual DtNetIntercomControlPdu* DtIntercomControlPdu::netPduStruct

(

)

const [protected, virtual]

Casts the netPdu element to our network struct.

virtual int DtIntercomControlPdu::numParmRecords

(

)

const [virtual]

DtIntercomControlPdu& DtIntercomControlPdu::operator=

(

const DtIntercomControlPdu &

orig

)

Assignment operator.

virtual DtU32 DtIntercomControlPdu::parmRecordsLength

(

)

const [virtual]

Get the parameters length.

This field is automatically changed by the functions: setNumParmRecords(), and setParmRecord()

virtual void DtIntercomControlPdu::printData

(

)

const [virtual]

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtIntercomControlPdu::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the data to a stream.

Reimplemented from DtPdu.

virtual int DtIntercomControlPdu::recordOffset

(

int

recordIndex

)

const [protected, virtual]

Returns the offset (in bytes) of the given parameter record.

static void DtIntercomControlPdu::removeCallback	(	DtExerciseConn *	conn,
		DtIntercomControlPduCb	cb,
		void *	usr
	)		[static]

virtual void DtIntercomControlPdu::resizeRecord	(	DtNetIntercomParmRec *	rec,
		int	newSize
	)		[protected, virtual]

Resize a given parameter record to the size indicated.

DtIntercomControlPdu* DtIntercomControlPdu::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 DtIntercomControlPdu::setCmdType

(

DtIntercomCmdType

cmdType

)

[virtual]

Set/Get intercom command type.

virtual void DtIntercomControlPdu::setCommClass

(

DtIntercomCommClass

commClass

)

[virtual]

Set/Get intercom communications channel class.

virtual void DtIntercomControlPdu::setCommType

(

DtIntercomCommType

commType

)

[virtual]

Set/Get intercom communications channel type.

virtual void DtIntercomControlPdu::setControlType

(

DtIntercomCtlType

controlType

)

[virtual]

Set/Get intercom control type.

virtual void DtIntercomControlPdu::setMasterChannelID

(

DtU16

channelID

)

[virtual]

Set/Get master channel ID.

virtual void DtIntercomControlPdu::setMasterDeviceID

(

DtU16

deviceID

)

[virtual]

Set/Get master communications device ID.

virtual void DtIntercomControlPdu::setMasterEntityID

(

const DtEntityIdentifier &

entity

)

[virtual]

Set/Get master entity identifier.

virtual bool DtIntercomControlPdu::setNumParmRecords

(

int

numRecords

)

[virtual]

Set/Get number of parameter records (this is not a PDU field).

If the required space would exceed the maximum space permitted for a PDU, then false may be returned.

virtual bool DtIntercomControlPdu::setParmRecord	(	int	parmIndex,
		const DtIntercomEntityDestRec &	init
	)		[virtual]

Set/Get the parameter record type and values of record parmIndex to values specified by the initializer in the second argument.

If parmIndex is out of bounds, or if the record type does not match the function (for a get), then false is returned. If the space would exceed the maximum space permitted for a PDU (for a set) then false may be returned.

virtual bool DtIntercomControlPdu::setParmRecord	(	int	parmIndex,
		const DtIntercomGroupDestRec &	init
	)		[virtual]

virtual bool DtIntercomControlPdu::setParmRecord	(	int	parmIndex,
		const DtIntercomGroupAsgmtRec &	init
	)		[virtual]

virtual void DtIntercomControlPdu::setSourceDeviceID

(

DtU16

deviceID

)

[virtual]

Set/Get source communications device ID.

virtual void DtIntercomControlPdu::setSourceEntityID

(

const DtEntityIdentifier &

entity

)

[virtual]

Set/Get source entity identifier.

virtual void DtIntercomControlPdu::setSourceLineID

(

DtU8

lineID

)

[virtual]

Set/Get source line ID.

virtual void DtIntercomControlPdu::setTransmitLineState

(

DtIntercomTransLineState

lineState

)

[virtual]

Set/Get transmit line state.

virtual void DtIntercomControlPdu::setTransmitPriority

(

DtU8

transmitPriority

)

[virtual]

Set/Get transmit priority.

virtual DtU16 DtIntercomControlPdu::sourceDeviceID

(

)

const [virtual]

virtual const DtEntityIdentifier& DtIntercomControlPdu::sourceEntityID

(

)

const [virtual]

virtual DtU8 DtIntercomControlPdu::sourceLineID

(

)

const [virtual]

virtual DtIntercomTransLineState DtIntercomControlPdu::transmitLineState

(

)

const [virtual]

virtual DtU8 DtIntercomControlPdu::transmitPriority

(

)

const [virtual]

virtual char* DtIntercomControlPdu::var

(

)

const [protected, virtual]

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

---

Member Data Documentation

DtEntityIdentifier DtIntercomControlPdu::myEntityID [protected]

Temporary object for reference returns.

int DtIntercomControlPdu::myNumParmRecords [protected]

Number of parameter records in this PDU.

const int DtIntercomControlPdu::theStaticSize [static, protected]

Size of PDU with zero parameter records.

---

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

• intercmCtlPdu.h