Instances of DtSignalInteraction are used to represent RadioSignal RPR FOM Interactions. More...

Inheritance diagram for DtSignalInteraction:

Collaboration diagram for DtSignalInteraction:

Public Member Functions
	DtSignalInteraction ()
	Default constructor.
virtual	~DtSignalInteraction ()
	Destructor.
	DtSignalInteraction (const DtSignalInteraction &orig)
	Copy constructor.
DtSignalInteraction &	operator= (const DtSignalInteraction &orig)
	Assignment operator.
virtual void	printData () const
	Print the interaction's data.
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to a stream.
virtual void	setNumSamples (DtU32 count)
	Set/Get sample count.
virtual DtU32	numSamples () const
virtual void	setTdlType (DtTacticalDataLinkType link)
	Set/Get tactical data link.
virtual DtTacticalDataLinkType	tdlType () const
virtual unsigned long	streamTag (DtLongWordPortion upperLower=DtLowerWord) const
	Get either the upper or lower word of the 64 bit StreamTag.
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.)

virtual void	setRadioId (const DtGlobalObjectDesignator &id)
	Set/Get Host radio id.
virtual const DtGlobalObjectDesignator &	radioId () const
	Set/Get Host radio id.

virtual void	setSampleRate (DtU32 rate)
	Set/Get sample rate.
virtual DtU32	sampleRate () const
	Set/Get sample rate.

virtual void	setNumDataBytes (DtU16 len)
	Set/Get signal data length in bytes.
virtual DtU16	numDataBytes () const
	Set/Get signal data length in bytes.

virtual void	setNumDataBits (DtU16 len)
	Set/Get signal data length in bits.
virtual DtU16	numDataBits () const
	Set/Get signal data length in bits.

virtual void	setData (const void *data, int numBytes)
	Set/Get signal data.
virtual const void *	data () const
	Set/Get signal data.

virtual DtU8	dataByte (int byteNum) const
	Set/Get the byteNum'th data byte.
virtual void	setDataByte (int byteNum, DtU8 data)
	Set/Get the byteNum'th data byte.

virtual void	setEncodingType (DtEncodingType encoding)
	Set/Get encoding type.
virtual DtEncodingType	encodingType () const
	Set/Get encoding type.

virtual DtEncodingClass	encodingClass () const
	Set/Get encoding class.
virtual void	setEncodingClass (DtEncodingClass encodingClass)
	Set/Get encoding class.

virtual void	setTdlMessageCount (DtU16 count)
	Set/Get TDL message count.
virtual DtU16	tdlMessageCount () const
	Set/Get TDL message count.

virtual void	setProtocolId (DtUserProtocol id)
	Set/Get user protocol id.
virtual DtUserProtocol	protocolId () const
	Set/Get user protocol id.

virtual void	setDatabaseIndex (DtU32 index)
	Set/Get database index.
virtual DtU32	databaseIndex () const
	Set/Get database index.

virtual void	setDuration (DtU32 duration)
	Set/Get duration.
virtual DtU32	duration () const
	Set/Get duration.

virtual void	setStartOffset (DtU32 offset)
	Set/Get start offset.
virtual DtU32	startOffset () const
	Set/Get start offset.

virtual void	setStreamTag (unsigned long upper, unsigned long lower)
	Set the Stream Tag, either as upper and lower word, or as full 64 bit integer.
virtual void	setStreamTag (unsigned long st)
	Set the Stream Tag, either as upper and lower word, or as full 64 bit integer.
Static Public Member Functions
static DtInteraction *	create ()
	Create a DtSignalInteraction.
static void	addCallback (DtExerciseConn conn, DtSignalInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn conn, DtSignalInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())
Protected Attributes
DtGlobalObjectDesignator	myHostRadioId
DtU16	mySignalDataLength
DtU8 *	mySignalData
	bits
DtTacticalDataLinkType	myTacticalDataLink
DtU16	myTDLMessageCount
DtUserProtocol	myUserProtocolId
DtU32	myDatabaseIndex
DtU32	myDuration
DtU32	myStartOffset
DtEncodingType	myEncodingType
DtEncodingClass	myEncodingClass
DtU32	mySampleRate
DtU32	mySampleCount
DtU32	myStreamTagHi
	Stream tag unsigned long long.
DtU32	myStreamTagLo

Detailed Description

Instances of DtSignalInteraction are used to represent RadioSignal RPR FOM Interactions.

The particular type of Signal interaction that is sent (Application Specific, Database Index, Encoded Audio, or Raw Binary) is determined by the encoding class.

Constructor & Destructor Documentation

DtSignalInteraction::DtSignalInteraction ( )

Default constructor.

virtual DtSignalInteraction::~DtSignalInteraction ( ) [virtual]

Destructor.

DtSignalInteraction::DtSignalInteraction ( const DtSignalInteraction & orig )

Copy constructor.

Member Function Documentation

static void DtSignalInteraction::addCallback	(	DtExerciseConn *	conn,
		DtSignalInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)		`[static]`

Add (register)/Remove (deregister) function to be called when interaction occurs.

static DtInteraction* DtSignalInteraction::create ( ) [static]

Create a DtSignalInteraction.

Caller is responsible for deletion.

Reimplemented in DtJtidsLetRadioSignalInteraction, DtJtidsMessageRadioSignalInteraction, DtJtidsVoiceCvsdRadioSignalInteraction, DtJtidsVoiceLpc10RadioSignalInteraction, DtJtidsVoiceLpc12RadioSignalInteraction, DtL16RadioSignalInteraction, DtRttReplyRadioSignalInteraction, DtVmfRadioSignalInteraction, and DtRttabRadioSignalInteraction.

virtual const void* DtSignalInteraction::data ( ) const [virtual]

Set/Get signal data.

virtual DtU32 DtSignalInteraction::databaseIndex ( ) const [virtual]

Set/Get database index.

This is only applicable to Database Index radio signals. In DIS, this value is packed into data bytes 0-3 of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual DtU8 DtSignalInteraction::dataByte ( int byteNum ) const [virtual]

Set/Get the byteNum'th data byte.

virtual DtU32 DtSignalInteraction::duration ( ) const [virtual]

Set/Get duration.

This is only applicable to Database Index radio signals. In DIS, this value is packed into data bytes 8-11 of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual DtEncodingClass DtSignalInteraction::encodingClass ( ) const [virtual]

Set/Get encoding class.

This determines the particular type of RPR FOM radio signal sent, if using the default RPR FOM Mapper.

virtual DtEncodingType DtSignalInteraction::encodingType ( ) const [virtual]

Set/Get encoding type.

virtual const char* DtSignalInteraction::name ( ) const [virtual]

Name of the interaction. (Not necessarily the ClassName from the FOM.)

Implements DtInteraction.

Reimplemented in DtJtidsLetRadioSignalInteraction, DtJtidsMessageRadioSignalInteraction, DtJtidsVoiceCvsdRadioSignalInteraction, DtJtidsVoiceLpc10RadioSignalInteraction, DtJtidsVoiceLpc12RadioSignalInteraction, DtL16RadioSignalInteraction, DtRttReplyRadioSignalInteraction, DtVmfRadioSignalInteraction, and DtRttabRadioSignalInteraction.

virtual DtU16 DtSignalInteraction::numDataBits ( ) const [virtual]

Set/Get signal data length in bits.

virtual DtU16 DtSignalInteraction::numDataBytes ( ) const [virtual]

Set/Get signal data length in bytes.

virtual DtU32 DtSignalInteraction::numSamples ( ) const [virtual]

DtSignalInteraction& DtSignalInteraction::operator= ( const DtSignalInteraction & orig )

Assignment operator.

virtual void DtSignalInteraction::printData ( ) const [virtual]

Print the interaction's data.

Reimplemented from DtInteraction.

virtual void DtSignalInteraction::printDataToStream ( std::ostream & stream ) const [virtual]

Print the interaction's data to a stream.

Reimplemented from DtInteraction.

Reimplemented in DtJtidsLetRadioSignalInteraction, DtJtidsMessageRadioSignalInteraction, DtJtidsVoiceCvsdRadioSignalInteraction, DtJtidsVoiceLpc10RadioSignalInteraction, DtJtidsVoiceLpc12RadioSignalInteraction, DtL16RadioSignalInteraction, DtRttReplyRadioSignalInteraction, DtVmfRadioSignalInteraction, and DtRttabRadioSignalInteraction.

virtual DtUserProtocol DtSignalInteraction::protocolId ( ) const [virtual]

Set/Get user protocol id.

This is only applicable to Application Specific radio signals. In DIS, this value is contained in the first 32 bits of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual const DtGlobalObjectDesignator& DtSignalInteraction::radioId ( ) const [virtual]

Set/Get Host radio id.

It should be noted that this is not protocol independent. In DIS, the radio a signal is associated with is determined through the entity ID and radio ID (which is an integer in DIS), as opposed to a string in HLA.

static void DtSignalInteraction::removeCallback	(	DtExerciseConn *	conn,
		DtSignalInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)		`[static]`

virtual DtU32 DtSignalInteraction::sampleRate ( ) const [virtual]

Set/Get sample rate.

virtual void DtSignalInteraction::setData	(	const void *	data,
		int	numBytes
	)		`[virtual]`

Set/Get signal data.

virtual void DtSignalInteraction::setDatabaseIndex ( DtU32 index ) [virtual]

Set/Get database index.

This is only applicable to Database Index radio signals. In DIS, this value is packed into data bytes 0-3 of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual void DtSignalInteraction::setDataByte	(	int	byteNum,
		DtU8	data
	)		`[virtual]`

Set/Get the byteNum'th data byte.

virtual void DtSignalInteraction::setDuration ( DtU32 duration ) [virtual]

Set/Get duration.

This is only applicable to Database Index radio signals. In DIS, this value is packed into data bytes 8-11 of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual void DtSignalInteraction::setEncodingClass ( DtEncodingClass encodingClass ) [virtual]

Set/Get encoding class.

This determines the particular type of RPR FOM radio signal sent, if using the default RPR FOM Mapper.

virtual void DtSignalInteraction::setEncodingType ( DtEncodingType encoding ) [virtual]

Set/Get encoding type.

virtual void DtSignalInteraction::setNumDataBits ( DtU16 len ) [virtual]

Set/Get signal data length in bits.

virtual void DtSignalInteraction::setNumDataBytes ( DtU16 len ) [virtual]

Set/Get signal data length in bytes.

virtual void DtSignalInteraction::setNumSamples ( DtU32 count ) [virtual]

Set/Get sample count.

virtual void DtSignalInteraction::setProtocolId ( DtUserProtocol id ) [virtual]

Set/Get user protocol id.

This is only applicable to Application Specific radio signals. In DIS, this value is contained in the first 32 bits of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual void DtSignalInteraction::setRadioId ( const DtGlobalObjectDesignator & id ) [virtual]

Set/Get Host radio id.

It should be noted that this is not protocol independent. In DIS, the radio a signal is associated with is determined through the entity ID and radio ID (which is an integer in DIS), as opposed to a string in HLA.

virtual void DtSignalInteraction::setSampleRate ( DtU32 rate ) [virtual]

Set/Get sample rate.

virtual void DtSignalInteraction::setStartOffset ( DtU32 offset ) [virtual]

Set/Get start offset.

This is only applicable to Database Index radio signals. In DIS, this value is packed into data bytes 4-7 of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual void DtSignalInteraction::setStreamTag	(	unsigned long	upper,
		unsigned long	lower
	)		`[virtual]`

Set the Stream Tag, either as upper and lower word, or as full 64 bit integer.

This is used in the RPR 2 draft 17 encoding of the AudioData attribute of EncodedAudio radio signals.

virtual void DtSignalInteraction::setStreamTag ( unsigned long st ) [virtual]

Set the Stream Tag, either as upper and lower word, or as full 64 bit integer.

This is used in the RPR 2 draft 17 encoding of the AudioData attribute of EncodedAudio radio signals.

virtual void DtSignalInteraction::setTdlMessageCount ( DtU16 count ) [virtual]

Set/Get TDL message count.

This is applicable to DatabaseIndex radio signals in HLA, and is contained in the Encoding Type of DIS radio signals.

virtual void DtSignalInteraction::setTdlType ( DtTacticalDataLinkType link ) [virtual]

Set/Get tactical data link.

virtual DtU32 DtSignalInteraction::startOffset ( ) const [virtual]

Set/Get start offset.

This is only applicable to Database Index radio signals. In DIS, this value is packed into data bytes 4-7 of the signal data. These methods are not protocol-independent: they only exist in HLA, as this is set in the data portion of a DIS radio signal PDU.

virtual unsigned long DtSignalInteraction::streamTag ( DtLongWordPortion upperLower = DtLowerWord ) const [virtual]