DtIfRadarStateUnsubscribe Class Reference

Detailed Description

Interface message for canceling radar state subscriptions

This class is used to indicate that any previous radar state subscription from the originating simulation address should be canceled, and radar state messages should no longer be sent. This is the counterpart to a subscription request with the subscribe flag set to true.

#include <ifRadarStateUnsubscribe.h>

Inheritance diagram for DtIfRadarStateUnsubscribe:

Public Member Functions
	DtIfRadarStateUnsubscribe ()
	DtIfRadarStateUnsubscribe (const DtIfRadarStateUnsubscribe &orig)
const DtIfRadarStateUnsubscribe &	operator= (const DtIfRadarStateUnsubscribe &orig)
virtual	~DtIfRadarStateUnsubscribe () override
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual void	setUUID (const DtUUID &name)
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

Constructor & Destructor Documentation

DtIfRadarStateUnsubscribe() [1/2]

DtIfRadarStateUnsubscribe::DtIfRadarStateUnsubscribe

(

)

Default constructor.

Initializes an empty radar state unsubscribe message.

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

DtIfRadarStateUnsubscribe() [2/2]

DtIfRadarStateUnsubscribe::DtIfRadarStateUnsubscribe

(

const DtIfRadarStateUnsubscribe &

orig

)

Copy constructor.

Parameters

orig	The radar state unsubscribe message to copy from

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

References DtIfRadarStateUnsubscribe().

~DtIfRadarStateUnsubscribe()

virtual DtIfRadarStateUnsubscribe::~DtIfRadarStateUnsubscribe ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

const DtIfRadarStateUnsubscribe & DtIfRadarStateUnsubscribe::operator=

(

const DtIfRadarStateUnsubscribe &

orig

)

Assignment operator.

Parameters

orig	The radar state unsubscribe message to copy from

Returns

Reference to this object after assignment

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

References DtIfRadarStateUnsubscribe().

type()

virtual int DtIfRadarStateUnsubscribe::type ( ) const

overridevirtual

Gets the interface message type.

Returns

The message type identifier

Returns DtRadarStateUnsubscribeMessageType as defined in vreVrfMessageTypes.h.

clone()

virtual DtSimInterfaceContent * DtIfRadarStateUnsubscribe::clone ( ) const

overridevirtual

Creates a copy of this message.

Returns

Pointer to the new copy

Creates a dynamically allocated copy of this message.

setUUID()

virtual void DtIfRadarStateUnsubscribe::setUUID ( const DtUUID & name )

virtual

Sets the UUID of the entity to unsubscribe from.

Parameters

name	The entity UUID to set

Sets the UUID of the entity whose radar state updates should no longer be received. This identifies the specific radar system subscription to cancel.

uuid()

virtual const DtUUID & DtIfRadarStateUnsubscribe::uuid ( ) const

virtual

Gets the UUID of the entity being unsubscribed from.

Returns

The entity UUID

netRepSize()

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

overridevirtual

Serializes the message for network transmission.

Returns

True if serialization was successful

Prepares the message for network transmission.

printDataToString()

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

static

Static creator function for factory registration.

Returns

Pointer to a new instance of DtIfRadarStateUnsubscribe

This static function is used for registration with DtInterfaceContentFactory.

Member Data Documentation

myUUID

DtUUID DtIfRadarStateUnsubscribe::myUUID

protected

UUID of the entity whose radar state is being unsubscribed from.

---

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

• include/vrfExtensions/vreVrfMessages/ifRadarStateUnsubscribe.h