DtIfRadarStateRequest Class Reference

Detailed Description

Interface message for requesting radar state data

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

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

#include <ifRadarStateRequest.h>

Inheritance diagram for DtIfRadarStateRequest:

Public Member Functions
	DtIfRadarStateRequest ()
	DtIfRadarStateRequest (const DtIfRadarStateRequest &orig)
const DtIfRadarStateRequest &	operator= (const DtIfRadarStateRequest &orig)
virtual	~DtIfRadarStateRequest () 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

DtIfRadarStateRequest() [1/2]

DtIfRadarStateRequest::DtIfRadarStateRequest

(

)

Default constructor.

Initializes an empty radar state request message.

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

DtIfRadarStateRequest() [2/2]

DtIfRadarStateRequest::DtIfRadarStateRequest

(

const DtIfRadarStateRequest &

orig

)

Copy constructor.

Parameters

orig	The radar state request to copy from

Creates a new radar state request message by copying an existing one.

References DtIfRadarStateRequest().

~DtIfRadarStateRequest()

virtual DtIfRadarStateRequest::~DtIfRadarStateRequest ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

const DtIfRadarStateRequest & DtIfRadarStateRequest::operator=

(

const DtIfRadarStateRequest &

orig

)

Assignment operator.

Parameters

orig	The radar state request to copy from

Returns

Reference to this object after assignment

Copies the contents of another radar state request message into this one.

References DtIfRadarStateRequest().

type()

virtual int DtIfRadarStateRequest::type ( ) const

overridevirtual

Gets the interface message type.

Returns

The message type identifier

Returns DtRadarStateRequestMessageType as defined in vreVrfMessageTypes.h.

clone()

virtual DtSimInterfaceContent * DtIfRadarStateRequest::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 DtIfRadarStateRequest::setSubscribe ( bool value )

virtual

Sets the subscription flag.

Parameters

value

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

When set to true, radar state data will be sent every time the data changes. When set to false, only a single radar state update will be sent.

subscribe()

virtual bool DtIfRadarStateRequest::subscribe ( ) const

virtual

Gets the subscription flag.

Returns

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

setUUID()

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

virtual

Sets the UUID of the entity whose radar state is being requested.

Parameters

uuid	The entity UUID to set

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

References uuid().

uuid()

virtual const DtUUID & DtIfRadarStateRequest::uuid ( ) const

virtual

Gets the UUID of the entity whose radar state is being requested.

Returns

The entity UUID

Referenced by setUUID().

netRepSize()

virtual int DtIfRadarStateRequest::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 DtIfRadarStateRequest::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 DtIfRadarStateRequest::setToNet ( )

overridevirtual

Serializes the message for network transmission.

Returns

True if serialization was successful

Prepares the message for network transmission.

printDataToString()

virtual void DtIfRadarStateRequest::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 * DtIfRadarStateRequest::creator ( )

static

Static creator function for factory registration.

Returns

Pointer to a new instance of DtIfRadarStateRequest

This static function is used for registration with DtInterfaceContentFactory.

Member Data Documentation

myUUID

DtUUID DtIfRadarStateRequest::myUUID

protected

UUID of the entity whose radar state is being requested.

mySubscribe

bool DtIfRadarStateRequest::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/ifRadarStateRequest.h