DtIfRwrDataRequest Class Reference

Detailed Description

Interface message for requesting RWR data

This class is used to request radar warning receiver data messages to be sent from a DtObjectRwr. Two types of requests are supported:

• If subscribe is true, the request indicates that a new RWR data message should be sent every time the RWR contact list changes, until a DtRwrDataUnsubscribe message is sent to cancel the subscription.
• If subscribe is false, the request is for just one message containing the current RWR state to be sent.

#include <ifRwrDataRequest.h>

Inheritance diagram for DtIfRwrDataRequest:

Public Member Functions
	DtIfRwrDataRequest ()
	DtIfRwrDataRequest (const DtIfRwrDataRequest &orig)
const DtIfRwrDataRequest &	operator= (const DtIfRwrDataRequest &orig)
virtual	~DtIfRwrDataRequest () override
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual void	setSubscribe (bool value)
virtual bool	subscribe () const
virtual void	setUUID (const DtUUID &uuid)
virtual const DtUUID &	uuid () const
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	printDataToString (DtString &str) override

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtUUID	myUUID
bool	mySubscribe

Constructor & Destructor Documentation

DtIfRwrDataRequest() [1/2]

DtIfRwrDataRequest::DtIfRwrDataRequest

(

)

Default constructor.

Initializes an empty RWR data request message.

Referenced by DtIfRwrDataRequest(), and operator=().

DtIfRwrDataRequest() [2/2]

DtIfRwrDataRequest::DtIfRwrDataRequest

(

const DtIfRwrDataRequest &

orig

)

Copy constructor.

Parameters

orig	The RWR data request to copy from

Creates a new RWR data request message by copying an existing one.

References DtIfRwrDataRequest().

~DtIfRwrDataRequest()

virtual DtIfRwrDataRequest::~DtIfRwrDataRequest ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

const DtIfRwrDataRequest & DtIfRwrDataRequest::operator=

(

const DtIfRwrDataRequest &

orig

)

Assignment operator.

Parameters

orig	The RWR data request to copy from

Returns

Reference to this object after assignment

Copies the contents of another RWR data request message into this one.

References DtIfRwrDataRequest().

type()

virtual int DtIfRwrDataRequest::type ( ) const

overridevirtual

Gets the interface message type.

Returns

The message type identifier

Returns DtRwrDataRequestMessageType as defined in vreVrfMessageTypes.h.

clone()

virtual DtSimInterfaceContent * DtIfRwrDataRequest::clone ( ) const

overridevirtual

Creates a copy of this message.

Returns

Pointer to the new copy

Creates a dynamically allocated copy of this message.

setSubscribe()

virtual void DtIfRwrDataRequest::setSubscribe ( bool value )

virtual

Sets the subscription flag.

Parameters

value

True for continuous updates, false for a one-time request

When set to true, RWR data will be sent every time the RWR contact list changes. When set to false, only a single RWR data update will be sent.

subscribe()

virtual bool DtIfRwrDataRequest::subscribe ( ) const

virtual

Gets the subscription flag.

Returns

True if requesting continuous updates, false for a one-time request

setUUID()

virtual void DtIfRwrDataRequest::setUUID ( const DtUUID & uuid )

virtual

Sets the UUID of the entity whose RWR data is being requested.

Parameters

uuid	The entity UUID to set

Sets the UUID of the entity whose RWR data is being requested. This identifies the specific radar warning receiver system in the simulation.

References uuid().

uuid()

virtual const DtUUID & DtIfRwrDataRequest::uuid ( ) const

virtual

Gets the UUID of the entity whose RWR data is being requested.

Returns

The entity UUID

Referenced by setUUID().

netRepSize()

virtual int DtIfRwrDataRequest::netRepSize ( ) const

overridevirtual

Gets the network representation size.

Returns

Size in bytes of the network representation

Returns the size of the network buffer needed to store this message.

setFromNet()

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

overridevirtual

Deserializes the message from a network buffer.

Parameters

contentBuffer	Pointer to the network buffer
contentSize	Size of the buffer in bytes

Returns

True if deserialization was successful

Fills the message from the provided network buffer.

setToNet()

virtual bool DtIfRwrDataRequest::setToNet ( )

overridevirtual

Serializes the message for network transmission.

Returns

True if serialization was successful

Prepares the message for network transmission.

printDataToString()

virtual void DtIfRwrDataRequest::printDataToString ( DtString & str )

overridevirtual

Formats the message data as a string.

Parameters

str	String to store the formatted message data

Appends a human-readable representation of the message to the provided string.

creator()

static DtSimInterfaceContent * DtIfRwrDataRequest::creator ( )

static

Static creator function for factory registration.

Returns

Pointer to a new instance of DtIfRwrDataRequest

This static function is used for registration with DtInterfaceContentFactory.

Member Data Documentation

myUUID

DtUUID DtIfRwrDataRequest::myUUID

protected

UUID of the entity whose RWR data is being requested.

mySubscribe

bool DtIfRwrDataRequest::mySubscribe

protected

Flag indicating whether continuous updates are requested When true, data will be sent each time it changes. When false, only a single update is sent.

---

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

• include/vrfExtensions/vreVrfMessages/ifRwrDataRequest.h