DtIfRadarContactData Class Reference

Detailed Description

Interface message for radar contact data

This class encapsulates the current internal state of a radar system's contact detection capability. It contains information about the entity that owns the radar, the radar's name, and a list of currently detected contacts with their respective properties.

#include <ifRadarContactData.h>

Inheritance diagram for DtIfRadarContactData:

Public Member Functions
	DtIfRadarContactData ()
	DtIfRadarContactData (const DtIfRadarContactData &orig)
const DtIfRadarContactData &	operator= (const DtIfRadarContactData &orig)
virtual	~DtIfRadarContactData () override
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual void	setSourceEntity (const DtUUID &entity)
virtual const DtUUID &	sourceEntity () const
virtual void	setSensorName (const DtString &sensorName)
virtual DtString	sensorName () const
virtual const DtRadarDataEntryList &	radarDataEntryList () const
virtual DtRadarDataEntryList &	radarDataEntryList ()
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	mySensorName
DtRadarDataEntryList	myRadarContactDataList

Constructor & Destructor Documentation

DtIfRadarContactData() [1/2]

DtIfRadarContactData::DtIfRadarContactData

(

)

Default constructor.

Initializes an empty radar contact data message.

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

DtIfRadarContactData() [2/2]

DtIfRadarContactData::DtIfRadarContactData

(

const DtIfRadarContactData &

orig

)

Copy constructor.

Parameters

orig	The radar contact data to copy from

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

References DtIfRadarContactData().

~DtIfRadarContactData()

virtual DtIfRadarContactData::~DtIfRadarContactData ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

const DtIfRadarContactData & DtIfRadarContactData::operator=

(

const DtIfRadarContactData &

orig

)

Assignment operator.

Parameters

orig	The radar contact data to copy from

Returns

Reference to this object after assignment

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

References DtIfRadarContactData().

type()

virtual int DtIfRadarContactData::type ( ) const

overridevirtual

Gets the interface message type.

Returns

The message type identifier

Returns DtRadarContactDataMessageType as defined in vreVrfMessageTypes.h.

clone()

virtual DtSimInterfaceContent * DtIfRadarContactData::clone ( ) const

overridevirtual

Creates a copy of this message.

Returns

Pointer to the new copy

Creates a dynamically allocated copy of this message.

setSourceEntity()

virtual void DtIfRadarContactData::setSourceEntity ( const DtUUID & entity )

virtual

Sets the source entity UUID.

Parameters

entity

The UUID of the source entity

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

sourceEntity()

virtual const DtUUID & DtIfRadarContactData::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.

setSensorName()

virtual void DtIfRadarContactData::setSensorName ( const DtString & sensorName )

virtual

Sets the radar sensor name.

Parameters

sensorName

The name of the radar sensor

Sets the name of the radar sensor that detected these contacts.

References sensorName().

sensorName()

virtual DtString DtIfRadarContactData::sensorName ( ) const

virtual

Gets the radar sensor name.

Returns

The name of the radar sensor

Referenced by setSensorName().

radarDataEntryList() [1/2]

virtual const DtRadarDataEntryList & DtIfRadarContactData::radarDataEntryList ( ) const

virtual

Gets the list of radar contacts (const version)

Returns

Const reference to the list of radar contacts

Returns a constant reference to the list of contacts detected by the radar.

radarDataEntryList() [2/2]

virtual DtRadarDataEntryList & DtIfRadarContactData::radarDataEntryList ( )

virtual

Gets the list of radar contacts (non-const version)

Returns

Reference to the list of radar contacts

Returns a modifiable reference to the list of contacts detected by the radar.

netRepSize()

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

overridevirtual

Serializes the message for network transmission.

Returns

True if serialization was successful

Prepares the message for network transmission.

printDataToString()

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

static

Static creator function for factory registration.

Returns

Pointer to a new instance of DtIfRadarContactData

This static function is used for registration with DtInterfaceContentFactory.

Member Data Documentation

mySourceEntity

DtUUID DtIfRadarContactData::mySourceEntity

protected

UUID of the entity that owns the radar system.

mySensorName

DtString DtIfRadarContactData::mySensorName

protected

Name of the radar sensor.

myRadarContactDataList

DtRadarDataEntryList DtIfRadarContactData::myRadarContactDataList

protected

List of radar contacts detected by the radar.

---

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

• include/vrfExtensions/vreVrfMessages/ifRadarContactData.h