DtIntercomSignalPdu Class Reference

Instances of DtIntercomSignalPdu are used to send simulated intercom signal data. More...

Inheritance diagram for DtIntercomSignalPdu:

Collaboration diagram for DtIntercomSignalPdu:

Public Member Functions
	DtIntercomSignalPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtIntercomSignalPdu (const DtNetIntercomSignalPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtIntercomSignalPdu (const DtIntercomSignalPdu &orig)
virtual	~DtIntercomSignalPdu ()
	destructor
DtIntercomSignalPdu &	operator= (const DtIntercomSignalPdu &orig)
	Assignment operator.
virtual void	setTransEntityID (const DtEntityIdentifier &entity)
	Set/get transmitting entity identifier.
virtual const DtEntityIdentifier &	transEntityID () const
virtual void	setDeviceID (DtU16 intercomID)
	Set/get intercom ID.
virtual DtU16	deviceID () const
virtual void	setEncodingClass (DtEncodingClass encClass)
	Set/get intercom encoding class.
virtual DtEncodingClass	encodingClass () const
virtual void	setEncodingType (DtU16 encType)
	Set/get intercom encoding type.
virtual DtU16	encodingType () const
virtual void	setTDL_Type (DtU16 TDL_Type)
	Set/get intercom TDL type.
virtual DtU16	TDL_Type () const
virtual void	setSampleRate (DtU32 rate)
	Set/get sample rate.
virtual DtU32	sampleRate () const
virtual void	setNumDataBits (DtU16 lengthInBits)
	Set/get data length in bits.
virtual DtU16	numDataBits () const
virtual void	setNumDataBytes (DtU16 lengthInBytes)
	Set/get data length in bytes.
virtual DtU16	numDataBytes () const
virtual void	setNumSamples (DtU16 samples)
	Set/get number of samples.
virtual DtU16	numSamples () const
virtual void	setDataByte (int byteNum, DtU8 data)
	Set/get a data byte.
virtual DtU8	dataByte (int byteNum) const
virtual void	setData (const DtU8 *data, int numBytes)
	Set/get multiple data bytes.
virtual void	getData (DtU8 *buff) 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 DtIntercomSignalPdu.
static void	addCallback (DtExerciseConn *conn, DtIntercomSignalPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtIntercomSignalPduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetIntercomSignalPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtIntercomSignalPdu *	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.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary object for reference returns.

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero data bytes.

Detailed Description

Instances of DtIntercomSignalPdu are used to send simulated intercom signal data.

Constructor & Destructor Documentation

DtIntercomSignalPdu::DtIntercomSignalPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtIntercomSignalPdu::DtIntercomSignalPdu	(	const DtNetIntercomSignalPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtIntercomSignalPdu::DtIntercomSignalPdu

(

const DtIntercomSignalPdu &

orig

)

virtual DtIntercomSignalPdu::~DtIntercomSignalPdu ( )

virtual

destructor

Member Function Documentation

static void DtIntercomSignalPdu::addCallback ( DtExerciseConn *  conn, DtIntercomSignalPduCb  cb, void *  usr  )

static

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

static DtPdu* DtIntercomSignalPdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Create a DtIntercomSignalPdu.

Caller is responsible for deletion.

virtual DtU8 DtIntercomSignalPdu::dataByte ( int  byteNum ) const

virtual

virtual DtU16 DtIntercomSignalPdu::deviceID ( ) const

virtual

virtual DtEncodingClass DtIntercomSignalPdu::encodingClass ( ) const

virtual

virtual DtU16 DtIntercomSignalPdu::encodingType ( ) const

virtual

virtual void DtIntercomSignalPdu::getData ( DtU8 *  buff ) const

virtual

virtual DtPduKind DtIntercomSignalPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual DtNetIntercomSignalPdu* DtIntercomSignalPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU16 DtIntercomSignalPdu::numDataBits ( ) const

virtual

virtual DtU16 DtIntercomSignalPdu::numDataBytes ( ) const

virtual

virtual DtU16 DtIntercomSignalPdu::numSamples ( ) const

virtual

DtIntercomSignalPdu& DtIntercomSignalPdu::operator=

(

const DtIntercomSignalPdu &

orig

)

Assignment operator.

virtual void DtIntercomSignalPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

virtual void DtIntercomSignalPdu::printDataToStream ( std::ostream &  stream ) const

virtual

Print the data to a stream.

Reimplemented from DtPdu.

static void DtIntercomSignalPdu::removeCallback ( DtExerciseConn *  conn, DtIntercomSignalPduCb  cb, void *  usr  )

static

virtual DtU32 DtIntercomSignalPdu::sampleRate ( ) const

virtual

DtIntercomSignalPdu* DtIntercomSignalPdu::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 DtIntercomSignalPdu::setData ( const DtU8 *  data, int  numBytes  )

virtual

Set/get multiple data bytes.

Provide a pointer and data is copied to and from that memory. Check numDataBytes() to make sure that you provide enough room in the buffer.

virtual void DtIntercomSignalPdu::setDataByte ( int  byteNum, DtU8  data  )

virtual

Set/get a data byte.

virtual void DtIntercomSignalPdu::setDeviceID ( DtU16  intercomID )

virtual

Set/get intercom ID.

virtual void DtIntercomSignalPdu::setEncodingClass ( DtEncodingClass  encClass )

virtual

Set/get intercom encoding class.

virtual void DtIntercomSignalPdu::setEncodingType ( DtU16  encType )

virtual

Set/get intercom encoding type.

virtual void DtIntercomSignalPdu::setNumDataBits ( DtU16  lengthInBits )

virtual

Set/get data length in bits.

virtual void DtIntercomSignalPdu::setNumDataBytes ( DtU16  lengthInBytes )

virtual

Set/get data length in bytes.

virtual void DtIntercomSignalPdu::setNumSamples ( DtU16  samples )

virtual

Set/get number of samples.

virtual void DtIntercomSignalPdu::setSampleRate ( DtU32  rate )

virtual

Set/get sample rate.

virtual void DtIntercomSignalPdu::setTDL_Type ( DtU16  TDL_Type )

virtual

Set/get intercom TDL type.

virtual void DtIntercomSignalPdu::setTransEntityID ( const DtEntityIdentifier &  entity )

virtual

Set/get transmitting entity identifier.

virtual DtU16 DtIntercomSignalPdu::TDL_Type ( ) const

virtual

virtual const DtEntityIdentifier& DtIntercomSignalPdu::transEntityID ( ) const

virtual

virtual char* DtIntercomSignalPdu::var ( ) const

protectedvirtual

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

Member Data Documentation

DtEntityIdentifier DtIntercomSignalPdu::myEntityID

protected

Temporary object for reference returns.

const int DtIntercomSignalPdu::theStaticSize

staticprotected

Size of PDU with zero data bytes.

---

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

• intercmSigPdu.h