WsfNearestNeighborCorrelation Class Reference

#include <WsfNearestNeighborCorrelation.hpp>

Inheritance diagram for WsfNearestNeighborCorrelation:

Collaboration diagram for WsfNearestNeighborCorrelation:

Public Member Functions
	WsfNearestNeighborCorrelation ()
	~WsfNearestNeighborCorrelation () override=default
WsfCorrelationStrategy *	Clone () const override
	Create a clone of "this" object.
WsfLocalTrack *	CorrelateImpl (double aSimTime, const WsfTrack &aNonLocalTrack, WsfLocalTrackList &aTrackList) override
bool	ProcessInput (UtInput &aInput) override
	Process input from a common source.
void	Decorrelate (const WsfTrackId &aRawTrackId) override
	Allow the user to break an existing correlation.
Public Member Functions inherited from WsfCorrelationStrategy
	~WsfCorrelationStrategy () override=default
virtual bool	Initialize (WsfTrackManager *aTrackManagerPtr)
	Perform any necessary initialization.
void	NewTrackCorrelation (const WsfTrack &aRawTrack, const WsfLocalTrack &aLocalTrack)
WsfLocalTrack *	Correlate (double aSimTime, const WsfTrack &aNonLocalTrack, WsfLocalTrackList &aTrackList)
const WsfTrackId &	GetCorrelatedTrackId (const WsfTrackId &aRawTrackId) const
void	NotifyOfLocalTrackCorrelation (double aSimTime, const WsfLocalTrack &aLocalTrack, const WsfTrackId &aRawTrackId)
WsfTrackManager &	GetTrackManager ()
	Return a reference to the track manager being accessed internally by this object.
void	SetTrackManager (WsfTrackManager *aTrackManagerPtr)
WsfSimulation *	GetSimulation () const
bool	TestCorrelation (const WsfTrack &aTrack1, const WsfTrack &aTrack2)
	Method to facilitate unit testing.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Additional Inherited Members
Public Types inherited from WsfCorrelationStrategy
typedef WsfObjectTypeList< WsfCorrelationStrategy >	CorrelationStrategyTypes
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Protected Member Functions inherited from WsfCorrelationStrategy
	WsfCorrelationStrategy ()
	WsfCorrelationStrategy (const WsfCorrelationStrategy &aSrc)
WsfCorrelationStrategy &	operator= (const WsfCorrelationStrategy &aRhs)
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Attributes inherited from WsfCorrelationStrategy
std::map< WsfTrackId, WsfTrackId >	mCorrelationMap

Detailed Description

An implementation of WsfCorrelationStrategy for which the spatially closest track is selected as being associated with the measurement under consideration.

Constructor & Destructor Documentation

WsfNearestNeighborCorrelation()

WsfNearestNeighborCorrelation::WsfNearestNeighborCorrelation

(

)

References WsfCorrelationStrategy::WsfCorrelationStrategy().

Referenced by Clone().

~WsfNearestNeighborCorrelation()

WsfNearestNeighborCorrelation::~WsfNearestNeighborCorrelation ( )

overridedefault

References WsfCorrelationStrategy::WsfCorrelationStrategy().

Member Function Documentation

Clone()

WsfCorrelationStrategy * WsfNearestNeighborCorrelation::Clone ( ) const

overridevirtual

Create a clone of "this" object.

Implements WsfCorrelationStrategy.

References WsfCorrelationStrategy::WsfCorrelationStrategy(), and WsfNearestNeighborCorrelation().

CorrelateImpl()

WsfLocalTrack * WsfNearestNeighborCorrelation::CorrelateImpl ( double aSimTime, const WsfTrack & aNonLocalTrack, WsfLocalTrackList & aTrackList )

overridevirtual

Given a non-local track update (or measurement), find the track in the track list that correlates with the given track or measurement.

Implements WsfCorrelationStrategy.

References WsfTrackListT< T >::FindTrack(), WsfTrack::GetTrackId(), WsfTrackManager::GetTrackList(), WsfCorrelationStrategy::GetTrackManager(), and WsfTrackId::IsNull().

Decorrelate()

void WsfNearestNeighborCorrelation::Decorrelate ( const WsfTrackId & aRawTrackId )

overridevirtual

Allow the user to break an existing correlation.

Reimplemented from WsfCorrelationStrategy.

References WsfCorrelationStrategy::Decorrelate().

ProcessInput()

bool WsfNearestNeighborCorrelation::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a common source.

Reimplemented from WsfCorrelationStrategy.

References WsfCorrelationStrategy::ProcessInput().

---

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

• WsfNearestNeighborCorrelation.hpp
• WsfNearestNeighborCorrelation.cpp