DtIfRadioMessageReceived Class Reference

DtIfRadioMessageReceived.

Interface content which is sent by the sim engine for any radio message that is received by a radio. It provides notification for any network app (Like VRF GUI) which may want to visualize actual network traffic though the radios.

Note

This message must be sent via the DtRadioMessageReceivedHandler in order be be received by the GUI application correctly.

Inheritance diagram for DtIfRadioMessageReceived:

Public Member Functions
	DtIfRadioMessageReceived ()
virtual	~DtIfRadioMessageReceived ()
	DtIfRadioMessageReceived (const DtIfRadioMessageReceived &orig)
DtIfRadioMessageReceived &	operator= (const DtIfRadioMessageReceived &orig)
virtual DtSimInterfaceContent *	clone () const
virtual int	type () const
virtual void	printDataToString (DtString &str)
virtual DtString	sender () const
virtual void	setSender (const DtString &globIdString)
virtual DtString	receiver () const
virtual void	setReceiver (const DtString &globIdString)
virtual DtString	senderObjectName () const
virtual void	setSenderObjectName (const DtString &globIdString)
virtual DtString	receiverObjectName () const
virtual void	setReceiverObjectName (const DtString &globIdString)
virtual double	frequency () const
virtual void	setFrequency (double frequency)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtString	mySenderObjectName
DtString	myReceiverObjectName
double	myFrequency
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfRadioMessageReceived::DtIfRadioMessageReceived

(

)

default constructor

virtual DtIfRadioMessageReceived::~DtIfRadioMessageReceived ( )

virtual

destructor

DtIfRadioMessageReceived::DtIfRadioMessageReceived

(

const DtIfRadioMessageReceived &

orig

)

copy constructor

Member Function Documentation

DtIfRadioMessageReceived& DtIfRadioMessageReceived::operator=

(

const DtIfRadioMessageReceived &

orig

)

assignment operator

virtual DtSimInterfaceContent* DtIfRadioMessageReceived::clone ( ) const

virtual

Returns a newly created instance of a DtIfRadioMessageReceived.

Implements DtSimInterfaceContent.

virtual int DtIfRadioMessageReceived::type ( ) const

virtual

Returns the string type of message, DtRadioMessageReceiveMessageType (defined in msgTypes.h).

Implements DtSimInterfaceContent.

virtual DtString DtIfRadioMessageReceived::sender ( ) const

virtual

The Global ID string of the sender.

virtual void DtIfRadioMessageReceived::setSender ( const DtString &  globIdString )

virtual

The Global ID string of the sender.

virtual DtString DtIfRadioMessageReceived::receiver ( ) const

virtual

The Global ID string of the receiver.

virtual void DtIfRadioMessageReceived::setReceiver ( const DtString &  globIdString )

virtual

The Global ID string of the receiver.

virtual DtString DtIfRadioMessageReceived::senderObjectName ( ) const

virtual

The Global ID string of the sender.

Deprecated:

For backwards compatibility. Calls sender() and setSender().

Referenced by makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkRadioCommLineListener::setRadioMessage().

virtual void DtIfRadioMessageReceived::setSenderObjectName ( const DtString &  globIdString )

virtual

The Global ID string of the sender.

Deprecated:

For backwards compatibility. Calls sender() and setSender().

virtual DtString DtIfRadioMessageReceived::receiverObjectName ( ) const

virtual

The Global ID string of the receiver.

Deprecated:

For backwards compatibility. Calls receiver() and setReceiver().

Referenced by makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkRadioCommLineListener::setRadioMessage().

virtual void DtIfRadioMessageReceived::setReceiverObjectName ( const DtString &  globIdString )

virtual

The Global ID string of the receiver.

Deprecated:

For backwards compatibility. Calls receiver() and setReceiver().

virtual double DtIfRadioMessageReceived::frequency ( ) const

virtual

The frequency (in Hz) of the radio message.

Referenced by makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkRadioCommLineListener::setRadioMessage().

virtual void DtIfRadioMessageReceived::setFrequency ( double  frequency )

virtual

The frequency (in Hz) of the radio message.

virtual int DtIfRadioMessageReceived::netRepSize ( ) const

virtual

Network serialization methods.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRadioMessageReceived::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Network serialization methods.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRadioMessageReceived::setToNet ( )

virtual

Network serialization methods.

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRadioMessageReceived::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfRadioMessageReceived::creator ( )

static

Member Data Documentation

DtString DtIfRadioMessageReceived::mySenderObjectName

protected

DtString DtIfRadioMessageReceived::myReceiverObjectName

protected

double DtIfRadioMessageReceived::myFrequency

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfExtProtocol/ifRadioMessageReceived.h