radarContactInfoList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file radarContactInfoList.h
//! \ingroup vreVrfMessages
//! \brief A specialized list for radar contact information
//!
//! This file defines the DtRadarContactInfoList class, which is a specialized
//! container for managing and persisting radar contact information in the VREngage
//! simulation system.
 
//! \brief A specialized list for radar contact information
#pragma once
 
#include "vreVrfMessages/export.h"
#include <vrfutil/sensorContactInfoList.h>
 
class DtReaderWriterRegistry;
class DtString;
 
//! \brief A reader-writer list of radar contact information elements
//!
//! This class provides a specialized container for managing radar contact information.
//! It extends the base DtSensorContactInfoList with radar-specific functionality.
//! Use the DtRwList::add() and remove() methods for adding and removing elements.
//! The list can be iterated through using DtList iteration methods.
//!
//! \note The list will delete all of its contents when destroyed, so use caution
//! if holding pointers to any of the list elements.
//!
//! If you need to monitor the change state of the list, use a DtRadarContactInfoListChangeMonitor.
class VRFMESSAGES_DLL DtRadarContactInfoList : public DtSensorContactInfoList
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty radar contact information list.
   DtRadarContactInfoList();
 
   //! \brief Constructor with name for reader/writer functionality
   //! \param name The name to identify this list
   //! \param parentRegistry Optional reader-writer registry for serialization
   DtRadarContactInfoList(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Constructor with symbol name for reader/writer functionality
   //! \param name The symbol name to identify this list
   //! \param parentRegistry Optional reader-writer registry for serialization
   DtRadarContactInfoList(const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Virtual destructor
   //!
   //! Destroys the list and all contained radar contact information objects.
   virtual ~DtRadarContactInfoList() override;
 
   //! \brief Copy constructor with name
   //! \param name The name to identify this list
   //! \param orig The radar contact list to copy from
   //! \param parentRegistry Optional reader-writer registry for serialization
   //!
   //! Creates a deep copy, cloning all list items onto the new list.
   DtRadarContactInfoList(
      const DtString& name, const DtRadarContactInfoList& orig, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor with symbol name
   //! \param name The symbol name to identify this list
   //! \param orig The radar contact list to copy from
   //! \param parentRegistry Optional reader-writer registry for serialization
   //!
   //! Creates a deep copy, cloning all list items onto the new list.
   DtRadarContactInfoList(
      const DtSymbolString& name, const DtRadarContactInfoList& orig, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Assignment operator
   //! \param orig The radar contact list to copy from
   //! \return Reference to this object after assignment
   //!
   //! Performs a deep copy. All items on the target list are deleted, and new
   //! items are cloned onto the list from the source.
   DtRadarContactInfoList& operator=(const DtRadarContactInfoList& orig);
 
   //! \brief Creates a complete clone of the list and all items
   //! \param name The name to identify the cloned list
   //! \param parentRegistry Optional reader-writer registry for serialization
   //! \return Pointer to a new dynamically allocated copy
   //!
   //! Creates a deep copy of the entire list and all contained items.
   virtual DtRadarContactInfoList* clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Creates a complete clone of the list and all items
   //! \param name The symbol name to identify the cloned list
   //! \param parentRegistry Optional reader-writer registry for serialization
   //! \return Pointer to a new dynamically allocated copy
   //!
   //! Creates a deep copy of the entire list and all contained items.
   virtual DtRadarContactInfoList* clone(const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Factory method for creating sensor contact information objects
   //! \return Pointer to a new DtRwSensorContactInfo or derived class
   //!
   //! This factory method creates a DtRwSensorContactInfo or derivative.
   //! The base implementation creates a standard DtRwSensorContactInfo object.
   //! The getData() method uses this when adding new items to the list that are
   //! read from an input file.
   //!
   //! All items on the list should be of the type created by this method.
   //! If you need custom data in your sensor contact information, create
   //! a derived version of DtRwSensorContactInfo, override this class, and return
   //! your specialized contact info from this method.
   virtual DtRwSensorContactInfo* createSensorContactInfo() override;
 
   //! \brief Equality comparison operator
   //! \param other The radar contact list to compare with
   //! \return True if the lists are equal, false otherwise
   //!
   //! Compares this list with another radar contact list for equality.
   //! Lists are equal if they contain the same number of elements and each
   //! corresponding element is equal.
   bool operator==(const DtRadarContactInfoList& other) const;
};