DtRttabRadioSignalInteraction Class Reference

Inheritance diagram for DtRttabRadioSignalInteraction:

Collaboration diagram for DtRttabRadioSignalInteraction:

Public Member Functions
	DtRttabRadioSignalInteraction ()
	Default constructor.
virtual	~DtRttabRadioSignalInteraction ()
	Destructor.
	DtRttabRadioSignalInteraction (const DtRttabRadioSignalInteraction &orig)
	Copy constructor.
DtRttabRadioSignalInteraction &	operator= (const DtRttabRadioSignalInteraction &orig)
	Assignment operator.
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.)
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to a stream.
virtual const DtRttabStruct &	rttabData () const
	Set/Get the RTT A/B data.
virtual void	setRttabData (const DtRttabStruct &data)
	Set/Get the RTT A/B data.
Public Member Functions inherited from DtL16RadioSignalInteraction
	DtL16RadioSignalInteraction ()
	Default constructor.
virtual	~DtL16RadioSignalInteraction ()
	Destructor.
	DtL16RadioSignalInteraction (const DtL16RadioSignalInteraction &orig)
	Copy constructor.
DtL16RadioSignalInteraction &	operator= (const DtL16RadioSignalInteraction &orig)
	Assignment operator.
virtual void	setPerceivedTransmitTimeFraction (DtU32 val)
	Set/Get the perceived transmit time (integer portion).
virtual DtU32	perceivedTransmitTimeFraction () const
virtual void	setNpgNumber (DtU16 npg)
	Set/Get the NPG Number.
virtual DtU16	npgNumber () const
	Set/Get the NPG Number.
virtual void	setNetNumber (DtU8 net)
	Set/Get the Net Number.
virtual DtU8	netNumber () const
	Set/Get the Net Number.
virtual void	setTsecCvll (DtU8 val)
	Set/Get the TSEC CVLL.
virtual DtU8	tsecCvll () const
	Set/Get the TSEC CVLL.
virtual void	setMsecCvll (DtU8 val)
	Set/Get the MSEC CVLL.
virtual DtU8	msecCvll () const
	Set/Get the MSEC CVLL.
virtual void	setLink16MessageType (DtLink16MessageTypeEnum val)
	Set/Get the Message Type.
virtual DtLink16MessageTypeEnum	link16MessageType () const
	Set/Get the Message Type.
virtual void	setTimeIdSlotNumber (DtU32 val)
	Set/Get the Time Slot ID Slot Number.
virtual DtU32	timeIdSlotNumber () const
	Set/Get the Time Slot ID Slot Number.
virtual void	setTimeIdEpochNumber (DtU8 val)
	Set/Get the Time Slot ID Epoch Number.
virtual DtU8	timeIdEpochNumber () const
	Set/Get the Time Slot ID Epoch Number.
virtual void	setPerceivedTransmitTimeInteger (DtU32 val)
	Set/Get the perceived transmit time (integer portion).
virtual DtU32	perceivedTransmitTimeInteger () const
	Set/Get the perceived transmit time (integer portion).
Public Member Functions inherited from DtSignalInteraction
	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	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 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.
Public Member Functions inherited from DtInteractionWithEncDec
	DtInteractionWithEncDec ()
	default constructor
virtual	~DtInteractionWithEncDec ()
	destructor
	DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
	copy constructor
DtInteractionWithEncDec &	operator= (const DtInteractionWithEncDec &orig)
	assignment operator
virtual void	setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc=NULL)
	Sets the interaction's ExerciseConn and class descriptor.
virtual const RTI::ParameterHandleValuePairSet &	phvps () const
	Get the parameter handle value pair set for the interaction.
virtual void	setFromPhvps (const RTI::ParameterHandleValuePairSet &pvList)
	Set contents from a parameter handle value pair set.
virtual void	useThese (DtInteractionEncoder *enc, DtInteractionDecoder *dec, DtInteractionRep *data)
	Specify an encoder, decoder, and interaction data repository to use in encoding and decoding.
virtual DtInteractionEncoder *	encoder () const
	Return the encoder we are using.
virtual DtInteractionDecoder *	decoder () const
	Return the decoder we are using.
virtual void	setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size)
	Set the Parameter with the given handle.
virtual const char *	getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given handle.
virtual void	setParameterByName (const DtString &name, const char *attrValue, unsigned size)
	Set the Parameter with the given name.
virtual const char *	getParameterByName (const DtString &name, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given name.
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
virtual RTI::InteractionClassHandle	interactionClassHandle () const
	Get the interaction class handle. Returns 0 if no classDesc.
virtual char *	interactionClassName () const
	Get the interaction class name. Returns NULL if no classDesc.
virtual int	numParameters () const
	Get the number of parameters. Returns 0 if no classDesc.
virtual bool	neededByFederation () const
	Returns true if the interaction class is needed by the federation false otherwise.
virtual void	print () const
	Print the interaction's host rep data, including header.
virtual void	printToStream (std::ostream &stream) const
	Print the interaction to a stream.
virtual void	printHeader () const
	Print the header info.
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the header info to a stream.
virtual void	printDataToString (DtString &buff) const
	Print the interaction's data to the string provided.
virtual void	printParams (bool withHex) const
	Print the header followed by the interaction's parameters.
virtual void	printParamsToStream (std::ostream &stream, bool withHex) const
	Print the header followed by the interaction's parameters to a stream.
virtual DtExerciseConn *	exerciseConn () const
	Get the current exercise connection.
virtual DtInterClassDesc *	classDesc () const
	Get the current class descriptor we're using for this interaction.
virtual bool	customTagSet () const
	Get whether a custom tag has been set on the interaction or not.
virtual void	setCustomTag (const DtString &a_tag)
	Set the user-defined tag.
virtual void	setTag (const DtString &tag)
	Set the user-defined tag.
virtual const DtString &	tag () const
	Get the user-defined tag.
virtual const RTI::Region *	conveyedRegion () const
	Get & Set the conveyed region of the reflected state message.
virtual void	setConveyedRegion (const RTI::Region *region)
virtual void	setProducingFederateHandle (RTI::FederateHandle federateHandle)
	HLA Evolved added an argument that provides the FederateHandle of the federate that produced the interaction being received.
virtual RTI::FederateHandle	producingFederateHandle () const
	The producing federate handle. Invalid if not enabled (or could be from MOM).
virtual const DtString &	producingFederateName () const
	The producing federate handle is used to get the federate name (cached after first access).
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the time of validity of the message, and whether this represents relative or absolute time.
virtual DtTime	timeStamp () const
	Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp.
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 void	setFedTime (const RTI::FedTime &ft)
	This is used for TSO interactions.
virtual const RTI::FedTime *	fedTime () const
	When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set.
virtual void	setEventRetractionHandle (const RTI::EventRetractionHandle &handle)
	Get/Set the EventRetractionHandle.
virtual RTI::EventRetractionHandle	eventRetractionHandle () const
	Get the event retraction handle. For more info see setEventRetractionHandle.

Static Public Member Functions
static DtInteraction *	create ()
	Create a DtSignalInteraction.
static void	addCallback (DtExerciseConn *conn, DtRttabRadioSignalInteractionCb cb, void *usr)
static void	removeCallback (DtExerciseConn *conn, DtRttabRadioSignalInteractionCb cb, void *usr)
Static Public Member Functions inherited from DtL16RadioSignalInteraction
static void	addCallback (DtExerciseConn *conn, DtL16RadioSignalInteractionCb cb, void *usr)
static void	removeCallback (DtExerciseConn *conn, DtL16RadioSignalInteractionCb cb, void *usr)
Static Public Member Functions inherited from 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 Member Functions
virtual char *	interactionClassToUse (DtExerciseConn *exConn) const
	Virtual function override.
virtual DtInteractionDecoder *	createDecoder (DtExerciseConn *exConn) const
	Virtual function override.
virtual DtInteractionEncoder *	createEncoder (DtExerciseConn *exConn) const
	Virtual function override.

Protected Attributes
DtRttabStruct	myRttabData
	The RTT A/B data.
Protected Attributes inherited from DtL16RadioSignalInteraction
DtU16	myNpgNumber
DtU8	myNetNumber
DtU8	myTsecCvll
DtU8	myMsecCvll
DtLink16MessageTypeEnum	myMessageType
DtU32	myTimeIdSlotNum
DtU8	myTimeIdEpochNum
DtU32	myTimeInteger
DtU32	myTimeFraction
Protected Attributes inherited from DtSignalInteraction
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
Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
std::map< RTI::ParameterHandle, DtGenericParameterInfo * >	myParametersByHandle
	parameters by handle.
Protected Attributes inherited from DtInteraction
DtInterClassDesc *	myClassDesc
DtExerciseConn *	myExConn
DtTime	myTime
DtTimeStampType	myTimeType
DtString	myTag
RTI::ParameterHandleValuePairSet *	myPvList
int	myPvListMaxSize
RTI::FedTime *	myFedTime
RTI::EventRetractionHandle	myRetractionHandle
const RTI::Region *	myConveyedRegion
bool	myCustomTagSet

Additional Inherited Members
Static Protected Attributes inherited from DtL16RadioSignalInteraction
static const DtU32	theMaxTimeIdSlotNum

Constructor & Destructor Documentation

DtRttabRadioSignalInteraction::DtRttabRadioSignalInteraction

(

)

Default constructor.

virtual DtRttabRadioSignalInteraction::~DtRttabRadioSignalInteraction ( )

virtual

Destructor.

DtRttabRadioSignalInteraction::DtRttabRadioSignalInteraction

(

const DtRttabRadioSignalInteraction &

orig

)

Copy constructor.

Member Function Documentation

static void DtRttabRadioSignalInteraction::addCallback ( DtExerciseConn *  conn, DtRttabRadioSignalInteractionCb  cb, void *  usr  )

static

static DtInteraction* DtRttabRadioSignalInteraction::create ( )

static

Create a DtSignalInteraction.

Caller is responsible for deletion.

Reimplemented from DtL16RadioSignalInteraction.

virtual DtInteractionDecoder* DtRttabRadioSignalInteraction::createDecoder ( DtExerciseConn *  exConn ) const

protectedvirtual

Virtual function override.

Creates and returns a decoder to be used by setFromPhvps to decode a ParameterHandleValuePairSet into this interaction. Implementing this function is required, unless you would like to rely on the default behavior - which is to obtain a new instance of the right decoder from the FOM Mapper. If you choose this option, you must configure the FOM Mapper so that it can correctly provide this object.

Reimplemented from DtL16RadioSignalInteraction.

virtual DtInteractionEncoder* DtRttabRadioSignalInteraction::createEncoder ( DtExerciseConn *  exConn ) const

protectedvirtual

Virtual function override.

Creates and returns an encoder to be used by phvps to encode the data in this interaction into a ParameterHandleValuePairSet. Implementing this function is required, unless you would like to rely on the default behavior - which is to obtain a new instance of the right encoder from the FOM Mapper. If you choose this option, you must configure the FOM Mapper so that it can correctly provide this object.

Reimplemented from DtL16RadioSignalInteraction.

virtual char* DtRttabRadioSignalInteraction::interactionClassToUse ( DtExerciseConn *  exConn ) const

protectedvirtual

Virtual function override.

Returns the name of the FOM class to use to represent this interaction when sending. It is called from within setExConn, when that function is called by DtExerciseConn::send. Implementing this function is required unless you would like to rely on the default behavior - which is to obtain the class to use from the FOM Mapper. If you choose this option, you must configure the FomMapper so that it can correctly provide this information.

Reimplemented from DtL16RadioSignalInteraction.

virtual const char* DtRttabRadioSignalInteraction::name ( ) const

virtual

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

Reimplemented from DtL16RadioSignalInteraction.

DtRttabRadioSignalInteraction& DtRttabRadioSignalInteraction::operator=

(

const DtRttabRadioSignalInteraction &

orig

)

Assignment operator.

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

virtual

Print the interaction's data to a stream.

Reimplemented from DtL16RadioSignalInteraction.

static void DtRttabRadioSignalInteraction::removeCallback ( DtExerciseConn *  conn, DtRttabRadioSignalInteractionCb  cb, void *  usr  )

static

virtual const DtRttabStruct& DtRttabRadioSignalInteraction::rttabData ( ) const

virtual

Set/Get the RTT A/B data.

virtual void DtRttabRadioSignalInteraction::setRttabData ( const DtRttabStruct &  data )

virtual

Set/Get the RTT A/B data.

Member Data Documentation

DtRttabStruct DtRttabRadioSignalInteraction::myRttabData

protected

The RTT A/B data.

---

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

• rttabRadioSignalInteraction.h