VR-Engage  2.2
Loading...
Searching...
No Matches
DtIfRadarStateData Class Reference

Detailed Description

Interface message for radar state data

This class encapsulates the current internal state of a radar system, including source entity ID, radar name, and detailed state information.

#include <ifRadarStateData.h>

Inheritance diagram for DtIfRadarStateData:
[legend]

Public Member Functions

 DtIfRadarStateData ()
 
 DtIfRadarStateData (const DtIfRadarStateData &orig)
 
const DtIfRadarStateDataoperator= (const DtIfRadarStateData &orig)
 
virtual ~DtIfRadarStateData () override
 
virtual int type () const override
 
virtual DtSimInterfaceContent * clone () const override
 
virtual DtString radarName () const
 
virtual void setRadarName (const DtString &val)
 
virtual void setSourceEntity (const DtUUID &val)
 
virtual const DtUUID & sourceEntity () const
 
virtual DtRwRadarStateInfo radarStateInfo () const
 
virtual void setRadarStateInfo (const DtRwRadarStateInfo &val)
 
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 mySourceEntity
 
DtString myRadarName
 
DtRwRadarStateInfo myRadarStateInfo
 

Constructor & Destructor Documentation

◆ DtIfRadarStateData() [1/2]

DtIfRadarStateData::DtIfRadarStateData ( )

Default constructor.

Initializes an empty radar state data message.

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

◆ DtIfRadarStateData() [2/2]

DtIfRadarStateData::DtIfRadarStateData ( const DtIfRadarStateData & orig)

Copy constructor.

Parameters
origThe radar state data to copy from

Creates a new radar state data object by copying an existing one.

References DtIfRadarStateData().

◆ ~DtIfRadarStateData()

virtual DtIfRadarStateData::~DtIfRadarStateData ( )
overridevirtual

Virtual destructor.

Member Function Documentation

◆ operator=()

const DtIfRadarStateData & DtIfRadarStateData::operator= ( const DtIfRadarStateData & orig)

Assignment operator.

Parameters
origThe radar state data to copy from
Returns
Reference to this object after assignment

Copies the contents of another radar state data object into this one.

References DtIfRadarStateData().

◆ type()

virtual int DtIfRadarStateData::type ( ) const
overridevirtual

Gets the interface message type.

Returns
The message type identifier

Returns DtRadarStateDataMessageType as defined in vreVrfMessageTypes.h.

◆ clone()

virtual DtSimInterfaceContent * DtIfRadarStateData::clone ( ) const
overridevirtual

Creates a copy of this message.

Returns
Pointer to the new copy

Creates a dynamically allocated copy of this message.

◆ radarName()

virtual DtString DtIfRadarStateData::radarName ( ) const
virtual

Gets the name of the radar.

Returns
The radar name

◆ setRadarName()

virtual void DtIfRadarStateData::setRadarName ( const DtString & val)
virtual

Sets the name of the radar.

Parameters
valThe radar name to set

◆ setSourceEntity()

virtual void DtIfRadarStateData::setSourceEntity ( const DtUUID & val)
virtual

Sets the source entity UUID.

Parameters
valThe UUID of the source entity

Sets the UUID of the entity that owns the radar system.

◆ sourceEntity()

virtual const DtUUID & DtIfRadarStateData::sourceEntity ( ) const
virtual

Gets the source entity UUID.

Returns
The UUID of the source entity

Returns the UUID of the entity that owns the radar system.

◆ radarStateInfo()

virtual DtRwRadarStateInfo DtIfRadarStateData::radarStateInfo ( ) const
virtual

Gets the radar state information.

Returns
The radar state information structure

◆ setRadarStateInfo()

virtual void DtIfRadarStateData::setRadarStateInfo ( const DtRwRadarStateInfo & val)
virtual

Sets the radar state information.

Parameters
valThe radar state information to set

◆ netRepSize()

virtual int DtIfRadarStateData::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 DtIfRadarStateData::setFromNet ( const char * contentBuffer,
unsigned contentSize )
overridevirtual

Deserializes the message from a network buffer.

Parameters
contentBufferPointer to the network buffer
contentSizeSize of the buffer in bytes
Returns
True if deserialization was successful

Fills the message from the provided network buffer.

◆ setToNet()

virtual bool DtIfRadarStateData::setToNet ( )
overridevirtual

Serializes the message for network transmission.

Returns
True if serialization was successful

Prepares the message for network transmission.

◆ printDataToString()

virtual void DtIfRadarStateData::printDataToString ( DtString & str)
overridevirtual

Formats the message data as a string.

Parameters
strString to store the formatted message data

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

◆ creator()

static DtSimInterfaceContent * DtIfRadarStateData::creator ( )
static

Static creator function for factory registration.

Returns
Pointer to a new instance of DtIfRadarStateData

This static function is used for registration with DtInterfaceContentFactory.

Member Data Documentation

◆ mySourceEntity

DtUUID DtIfRadarStateData::mySourceEntity
protected

UUID of the entity that owns the radar.

◆ myRadarName

DtString DtIfRadarStateData::myRadarName
protected

Name of the radar system.

◆ myRadarStateInfo

DtRwRadarStateInfo DtIfRadarStateData::myRadarStateInfo
protected

Detailed radar state information.


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