vreRadarObjectSensorDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreRadarObjectSensorDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Radar object sensor descriptor for VREngage
//!
//! This file defines the DtVreRadarObjectSensorDescriptor class, which configures
//! radar object sensor components in VREngage. It extends the base radar object sensor
//! descriptor to add configuration for radar state and entity labeling.
 
#pragma once
 
#include "vreVrfobjparam/export.h"
#include <vrfobjparam/radarObjectSensorDescriptor.h>
 
#include "vreVrfMessages/rwRadarStateInfo.h"
#include <vrfutil/rwTemplatedMap.h>
 
namespace makVre
{
//! \brief Type identifier string for the radar object sensor descriptor
const char DtVreRadarObjectSensorDescriptorType[] = "vre-radar-object-sensor-descriptor";
 
//! \brief Type definition for a map of entity types to label strings
using DtEntityLabelMap = DtRwTemplatedMapPtr<DtRwEntityType, DtRwString>;
 
//! \brief Radar object sensor descriptor for VREngage
//!
//! This class extends the base radar object sensor descriptor to add configuration for
//! radar state and entity labeling. It provides additional information needed to
//! publish a representative emitter system and customize entity display labels in
//! the radar interface.
class VREVRFOBJPARAM_DLL DtVreRadarObjectSensorDescriptor : public DtRadarObjectSensorDescriptor
{
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreRadarObjectSensorDescriptor();
 
public:
   //! \brief Constructor with component name
   //! \param name The name of this component
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new radar object sensor descriptor with the specified name.
   DtVreRadarObjectSensorDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new radar object sensor descriptor as a copy of the provided original.
   DtVreRadarObjectSensorDescriptor(
      const DtVreRadarObjectSensorDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source descriptor to copy from
   //! \return Reference to this descriptor after assignment
   //!
   //! Assigns the contents of the provided descriptor to this one.
   DtVreRadarObjectSensorDescriptor& operator=(const DtVreRadarObjectSensorDescriptor& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtVreRadarObjectSensorDescriptor() override;
 
   //! \brief Gets the type identifier for this descriptor
   //! \return String identifying this descriptor type
   //!
   //! Returns a unique type identifier string for this descriptor type.
   //! Will return DtVreRadarObjectSensorDescriptorType.
   virtual DtString type() const override;
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return Pointer to a new descriptor that is a clone of this one
   //!
   //! Creates a new radar object sensor descriptor as a deep copy of this one.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Factory function to create a new instance of this descriptor
   //! \return Pointer to a newly created descriptor
   //!
   //! Static factory function used by the descriptor creation system to instantiate
   //! new instances of this descriptor type.
   static DtComponentDescriptor* creator();
 
   //! \brief Gets the initial radar state
   //! \return Reference to the initial radar state information
   //!
   //! Returns the initial state configuration for the radar system when it is first
   //! initialized. This includes operating modes, ranges, and other radar parameters.
   const DtRwRadarStateInfo& initialRadarState() const;
 
   //! \brief Gets the entity label map
   //! \return Reference to the entity label map
   //!
   //! Returns the map of entity types to label strings. This mapping is used to
   //! customize how different entity types are labeled in the radar interface.
   virtual const DtEntityLabelMap& entityLabels() const;
 
protected:
   //! \brief Initial radar state information
   //!
   //! Stores the initial state configuration for the radar system when it is first
   //! initialized. This includes operating modes, ranges, and other radar parameters.
   DtRwRadarStateInfo myInitialRadarState;
 
   //! \brief Entity label mapping
   //!
   //! Stores the mapping of entity types to label strings. This mapping is used to
   //! customize how different entity types are labeled in the radar interface.
   DtEntityLabelMap myEntityLabelMap;
};
} // namespace makVre