A base class for SensorErrorModels. More...

#include <WsfSensorErrorModel.hpp>

Inheritance diagram for wsf::SensorErrorModelBase:

[legend]

Collaboration diagram for wsf::SensorErrorModelBase:

Public Types
using	SensorModelTypes = WsfObjectTypeList<SensorErrorModelBase>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
bool	ProcessInput (UtInput &aInput) override
virtual bool	Initialize (WsfSensorMode *aSensorModePtr)
virtual void	ApplyMeasurementErrors (WsfSensorResult &aResult)=0
SensorErrorModelBase *	Clone () const override=0
	Create a clone of "this" object.
virtual bool	IsNullModel () const
	Is this a null model (i.e., ApplyMeasurementErrors has no effect).
virtual bool	IsStandardModel () const
bool	DebugEnabled () const
WsfSensorMode *	GetSensorMode () const
void	SetSensorMode (WsfSensorMode *aSensorModePtr)
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
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Detailed Description

A base class for SensorErrorModels.

Member Typedef Documentation

◆ SensorModelTypes

using wsf::SensorErrorModelBase::SensorModelTypes = WsfObjectTypeList<SensorErrorModelBase>

Member Function Documentation

◆ ApplyMeasurementErrors()

virtual void wsf::SensorErrorModelBase::ApplyMeasurementErrors ( WsfSensorResult & aResult )

pure virtual

Compute and apply measurement errors to the current detection attempt.

Parameters

aResult The results of a sensing chance to be modified by the error model.

Note: This method is defined in wsf::SensorErrorModel.

Implemented in wsf::SensorErrorModel< ErrorType >, and WsfTRIMSIM_ErrorModel.

Referenced by WsfEOIR_Sensor::Update().

◆ Clone()

SensorErrorModelBase * wsf::SensorErrorModelBase::Clone ( ) const

overridepure virtual

Create a clone of "this" object.

Implements WsfObject.

Implemented in wsf::AbsoluteSensorErrorModel, wsf::BistaticErrorModel, wsf::OTH_RadarSensorErrorModel, wsf::RadarSensorErrorModel, wsf::StandardSensorErrorModel, wsf::SurfaceWaveRadarSensorErrorModel, WsfEOIR_Sensor::EOIR_ErrorModel, WsfPassiveSensor::PassiveMode::PassiveErrorModel, WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel, and WsfTRIMSIM_ErrorModel.

◆ DebugEnabled()

bool wsf::SensorErrorModelBase::DebugEnabled ( ) const

inline

Referenced by wsf::BistaticErrorModel::LoadPositionSigmaTable().

◆ GetSensorMode()

WsfSensorMode * wsf::SensorErrorModelBase::GetSensorMode ( ) const

inline

Referenced by wsf::AbsoluteSensorErrorModel::ApplyMeasurementErrors(), wsf::RadarSensorErrorModel::ApplyMeasurementErrors(), wsf::StandardSensorErrorModel::ApplyMeasurementErrors(), wsf::SurfaceWaveRadarSensorErrorModel::ApplyMeasurementErrors(), WsfEOIR_Sensor::EOIR_ErrorModel::ApplyMeasurementErrors(), wsf::AbsoluteSensorErrorModel::ComputeMeasurementErrors(), wsf::StandardSensorErrorModel::ComputeMeasurementErrors(), WsfPassiveSensor::PassiveMode::PassiveErrorModel::ComputeMeasurementErrors(), wsf::StandardSensorErrorModel::GetSphericalErrorStdDev(), and wsf::SurfaceWaveRadarSensorErrorModel::GetSphericalErrorStdDev().

◆ Initialize()

bool wsf::SensorErrorModelBase::Initialize ( WsfSensorMode * aSensorModePtr )

virtual

Perform any necessary initialization.

Parameters

aSensorModePtr The sensor mode used by this error model.

Reimplemented in wsf::BistaticErrorModel, wsf::OTH_RadarSensorErrorModel, wsf::RadarSensorErrorModel, wsf::SurfaceWaveRadarSensorErrorModel, WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel, and WsfTRIMSIM_ErrorModel.

Referenced by wsf::BistaticErrorModel::Initialize(), wsf::OTH_RadarSensorErrorModel::Initialize(), wsf::RadarSensorErrorModel::Initialize(), wsf::SurfaceWaveRadarSensorErrorModel::Initialize(), WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel::Initialize(), and WsfTRIMSIM_ErrorModel::Initialize().

◆ IsNullModel()

virtual bool wsf::SensorErrorModelBase::IsNullModel ( ) const

inlinevirtual

Is this a null model (i.e., ApplyMeasurementErrors has no effect).

Reimplemented in WsfTRIMSIM_ErrorModel.

◆ IsStandardModel()

virtual bool wsf::SensorErrorModelBase::IsStandardModel ( ) const

inlinevirtual

Is this a "standard" model that utilizes az/el/range/range rate standard deviations to compute normally distributed errors.

Reimplemented in wsf::StandardSensorErrorModel.

◆ ProcessInput()

bool wsf::SensorErrorModelBase::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

Reimplemented in wsf::StandardSensorErrorModel, wsf::SurfaceWaveRadarSensorErrorModel, and WsfTRIMSIM_ErrorModel.

References WsfObject::ProcessInput().

Referenced by wsf::AbsoluteSensorErrorModel::ProcessInput(), wsf::StandardSensorErrorModel::ProcessInput(), and WsfTRIMSIM_ErrorModel::ProcessInput().

◆ SetSensorMode()

void wsf::SensorErrorModelBase::SetSensorMode ( WsfSensorMode * aSensorModePtr )

inline

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SensorModelTypes

Member Function Documentation

◆ ApplyMeasurementErrors()

◆ Clone()

◆ DebugEnabled()

◆ GetSensorMode()

◆ Initialize()

◆ IsNullModel()

◆ IsStandardModel()

◆ ProcessInput()

◆ SetSensorMode()