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

Detailed Description

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.

#include <radarContactInfoList.h>

Inheritance diagram for DtRadarContactInfoList:
[legend]

Public Member Functions

 DtRadarContactInfoList ()
 
 DtRadarContactInfoList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRadarContactInfoList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRadarContactInfoList () override
 
 DtRadarContactInfoList (const DtString &name, const DtRadarContactInfoList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRadarContactInfoList (const DtSymbolString &name, const DtRadarContactInfoList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtRadarContactInfoListoperator= (const DtRadarContactInfoList &orig)
 
virtual DtRadarContactInfoListclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtRadarContactInfoListclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtRwSensorContactInfo * createSensorContactInfo () override
 
bool operator== (const DtRadarContactInfoList &other) const
 

Constructor & Destructor Documentation

◆ DtRadarContactInfoList() [1/5]

DtRadarContactInfoList::DtRadarContactInfoList ( )

Default constructor.

Initializes an empty radar contact information list.

Referenced by clone(), clone(), DtRadarContactInfoList(), DtRadarContactInfoList(), operator=(), and operator==().

◆ DtRadarContactInfoList() [2/5]

DtRadarContactInfoList::DtRadarContactInfoList ( const DtString & name,
DtReaderWriterRegistry * parentRegistry = NULL )

Constructor with name for reader/writer functionality.

Parameters
nameThe name to identify this list
parentRegistryOptional reader-writer registry for serialization

◆ DtRadarContactInfoList() [3/5]

DtRadarContactInfoList::DtRadarContactInfoList ( const DtSymbolString & name,
DtReaderWriterRegistry * parentRegistry = NULL )

Constructor with symbol name for reader/writer functionality.

Parameters
nameThe symbol name to identify this list
parentRegistryOptional reader-writer registry for serialization

◆ ~DtRadarContactInfoList()

virtual DtRadarContactInfoList::~DtRadarContactInfoList ( )
overridevirtual

Virtual destructor.

Destroys the list and all contained radar contact information objects.

◆ DtRadarContactInfoList() [4/5]

DtRadarContactInfoList::DtRadarContactInfoList ( const DtString & name,
const DtRadarContactInfoList & orig,
DtReaderWriterRegistry * parentRegistry = NULL )

Copy constructor with name.

Parameters
nameThe name to identify this list
origThe radar contact list to copy from
parentRegistryOptional reader-writer registry for serialization

Creates a deep copy, cloning all list items onto the new list.

References DtRadarContactInfoList().

◆ DtRadarContactInfoList() [5/5]

DtRadarContactInfoList::DtRadarContactInfoList ( const DtSymbolString & name,
const DtRadarContactInfoList & orig,
DtReaderWriterRegistry * parentRegistry = NULL )

Copy constructor with symbol name.

Parameters
nameThe symbol name to identify this list
origThe radar contact list to copy from
parentRegistryOptional reader-writer registry for serialization

Creates a deep copy, cloning all list items onto the new list.

References DtRadarContactInfoList().

Member Function Documentation

◆ operator=()

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

Assignment operator.

Parameters
origThe radar contact list to copy from
Returns
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.

References DtRadarContactInfoList().

◆ clone() [1/2]

virtual DtRadarContactInfoList * DtRadarContactInfoList::clone ( const DtString & name,
DtReaderWriterRegistry * parentRegistry = NULL )
virtual

Creates a complete clone of the list and all items.

Parameters
nameThe name to identify the cloned list
parentRegistryOptional reader-writer registry for serialization
Returns
Pointer to a new dynamically allocated copy

Creates a deep copy of the entire list and all contained items.

References DtRadarContactInfoList().

◆ clone() [2/2]

virtual DtRadarContactInfoList * DtRadarContactInfoList::clone ( const DtSymbolString & name,
DtReaderWriterRegistry * parentRegistry = NULL )
virtual

Creates a complete clone of the list and all items.

Parameters
nameThe symbol name to identify the cloned list
parentRegistryOptional reader-writer registry for serialization
Returns
Pointer to a new dynamically allocated copy

Creates a deep copy of the entire list and all contained items.

References DtRadarContactInfoList().

◆ createSensorContactInfo()

virtual DtRwSensorContactInfo * DtRadarContactInfoList::createSensorContactInfo ( )
overridevirtual

Factory method for creating sensor contact information objects.

Returns
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.

◆ operator==()

bool DtRadarContactInfoList::operator== ( const DtRadarContactInfoList & other) const

Equality comparison operator.

Parameters
otherThe radar contact list to compare with
Returns
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.

References DtRadarContactInfoList().


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