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

Inheritance diagram for DtIntercomControlPdu:

Collaboration diagram for DtIntercomControlPdu:

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.
Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor
virtual	~DtInteraction ()
	destructor
	DtInteraction (const DtInteraction &orig)
	copy constructor
DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator
Public Member Functions inherited from DtPdu
virtual	~DtPdu ()
	Destructor.
	DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtPdu &	operator= (const DtPdu &pdu)
	Assignment operator.
virtual void *	packet () const
	Older function that returns a pointer to the network representation.
virtual int	status () const
	Get PDU status.
virtual void	setVersion (int vers)
	Set/Get protocol version from PDU header.
virtual int	protocolVersion () const
virtual void	setExerciseId (int id)
	Set/Get exerciseID in PDU header.
virtual int	exerciseId () const
virtual DtPduKind	kind () const
	Returns PDU kind from PDU header.
virtual DtProtocolFamily	protocolFamily () const
	Returns protocol family from PDU header.
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the PDU header's time stamp to reflect time and type.
virtual DtTime	timeStamp () const
	Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp, as indicated in PDU header.
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual DtNetPduHeader *	netHeader () const
	Returns a pointer to the PDU's header.
virtual void	print () const
	Print the contents of the PDU by calling printToStream(DtInfo).
virtual void	printToStream (std::ostream &stream) const
	Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
virtual void	printHeader () const
	Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the PDU's header to a stream.
virtual void	printDataToString (DtString &str) const
Public Member Functions inherited from DtBaseMsg
virtual	~DtBaseMsg ()
	Destructor.
	DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtBaseMsg &	operator= (const DtBaseMsg &msg)
	Assignment.
virtual const char *	netRep () const
	Get network representation.
virtual int	length () const
	Get size of message.

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

protectedvirtual

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

protectedvirtual

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

protectedvirtual

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
	)

protectedvirtual

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

protectedvirtual

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

staticprotected

Size of PDU with zero parameter records.

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

intercmCtlPdu.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation