vreRadarObjectSensorPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreRadarObjectSensorPSR.h
//! \ingroup vreVrfobjcore
//! \brief Radar object sensor process state repository for VREngage
//!
//! This file defines the DtVreRadarObjectSensorPSR class, which extends the basic
//! radar object sensor PSR to provide VREngage-specific radar functionality. It adds
//! support for additional radar state information and creates extended contact info
//! objects for radar detections.
 
#pragma once
 
#include "vreVrfobjcore/export.h"
#include <vrfobjcore/radarObjectSensorPSR.h>
#include "vreVrfMessages/rwRadarStateInfo.h"
 
namespace makVre
{
//! \brief Type identifier string for the VREngage radar object sensor PSR
const char DtVreRadarObjectSensorPSRType[] = "vre-radar-object-sensor-psr";
 
//! \brief Extended radar object sensor process state repository for VREngage
//!
//! This class extends the basic radar object sensor PSR to provide VREngage-specific
//! radar functionality. It adds support for additional radar state information
//! and creates extended contact info objects for radar detections. The extended
//! functionality is used to provide more detailed radar information for VREngage
//! displays and interfaces.
class VREVRFOBJCORE_DLL DtVreRadarObjectSensorPSR : public DtRadarObjectSensorPSR
{
public:
   //! \brief Constructor with VRF object and optional name
   //! \param vrfObject Pointer to the local object this PSR is associated with
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new radar object sensor PSR for the specified VRF object.
   DtVreRadarObjectSensorPSR(DtLocalObject* vrfObject, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source PSR to copy from
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new radar object sensor PSR as a copy of the provided original.
   DtVreRadarObjectSensorPSR(const DtVreRadarObjectSensorPSR& orig, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the PSR.
   virtual ~DtVreRadarObjectSensorPSR() override;
 
   //! \brief Assignment operator (not implemented)
   //! \param orig The source PSR to copy from
   //! \return Reference to this PSR after assignment
   //!
   //! Assignment operator is declared but not implemented to prevent assignment.
   DtVreRadarObjectSensorPSR& operator=(const DtVreRadarObjectSensorPSR& orig);
 
   //! \brief Creates a clone of this PSR
   //! \param rwName Optional reader/writer name for the clone
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to a new PSR that is a clone of this one
   //!
   //! Creates a new radar object sensor PSR as a deep copy of this one.
   virtual DtVrfProcessStateRepository* clone(const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the type identifier for this PSR
   //! \return String identifying this PSR type
   //!
   //! Returns a unique type identifier string for this PSR type.
   //! Will return DtVreRadarObjectSensorPSRType.
   virtual DtString type() const override;
 
   //! \brief Creates a sensor contact info list with extended functionality
   //! \param name The name to assign to the new list
   //! \return Pointer to the newly created sensor contact info list
   //!
   //! Overridden to create extended contact info objects that contain VREngage-specific
   //! radar contact information. The extended information is used to provide more
   //! detailed radar displays and interfaces in VREngage applications.
   virtual DtSensorContactInfoList* createSensorContactInfoList(const DtString& name) override;
 
   //! \brief Gets the radar state information (const version)
   //! \return Const reference to the radar state information
   //!
   //! Returns a constant reference to the radar state information, containing
   //! details about the current radar operating parameters and mode.
   virtual const DtRwRadarStateInfo& radarStateInfo() const;
 
   //! \brief Gets the radar state information (non-const version)
   //! \return Reference to the radar state information
   //!
   //! Returns a reference to the radar state information, allowing modification
   //! of the current radar operating parameters and mode.
   virtual DtRwRadarStateInfo& radarStateInfo();
 
   //! \brief Factory function to create a new instance of this PSR
   //! \param rwName The reader/writer name for the new instance
   //! \param vrfObject Pointer to the local object this PSR will be associated with
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to a newly created PSR instance
   //!
   //! Static factory function used by the PSR creation system to instantiate
   //! new instances of this PSR type.
   static DtVrfProcessStateRepository* creator(
      const DtString& rwName, DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
 
protected:
   //! \brief Radar state information
   //!
   //! Stores the current radar state information, including operating parameters
   //! and mode. This is used to provide detailed radar status information to VREngage
   //! displays and interfaces.
   DtRwRadarStateInfo myRadarStateInfo;
};
 
} // namespace makVre