WSF
wsf::SimpleDopplerSignalProcessor Class Reference

#include <WsfSimpleDopplerSignalProcessor.hpp>

Inheritance diagram for wsf::SimpleDopplerSignalProcessor:
Collaboration diagram for wsf::SimpleDopplerSignalProcessor:

Public Member Functions

WsfSensorSignalProcessorClone () const override
bool ProcessInput (UtInput &aInput) override
void Execute (double aSimTime, WsfSensorResult &aResult) override
bool GetFilterOwnshipFromDoppler () const
void SetFilterOwnshipFromDoppler (bool aFilterOwnshipFromDoppler)
double GetMinDopplerSpeed () const
void SetMinDopplerSpeed (double aMinDopplerSpeed)
double GetMaxDopplerSpeed () const
void SetMaxDopplerSpeed (double aMaxDopplerSpeed)
virtual bool Initialize (double aSimTime, WsfSensor *aSensorPtr, WsfSensorMode *aModePtr, size_t aBeamIndex=0)
bool ProcessInput (UtInput &aInput) override
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 TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (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)

Static Public Member Functions

static WsfSensorSignalProcessorObjectFactory (const std::string &aTypeName)
 The object factory for the MTI signal processor type.
static void AddObjectFactory (FactoryPtr aFactoryPtr)
static void RemoveObjectFactory (FactoryPtr aFactoryPtr)
static WsfSensorSignalProcessorCreateInstance (const std::string &aTypeName)
static void ClearTypes ()

Additional Inherited Members

Public Types inherited from WsfSensorSignalProcessor
using FactoryPtr = WsfSensorSignalProcessor* (*)(const std::string&)
using ObjectFactoryList = std::list<FactoryPtr>
Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).
bool mDebug {false}
 If 'true' additional information is written out to aid debugging.

Detailed Description

A class derived from WsfSensorSignalProcessor that defines simple Doppler processing techniques for a radar sensor.

Member Function Documentation

◆ Clone()

WsfSensorSignalProcessor * wsf::SimpleDopplerSignalProcessor::Clone ( ) const
overridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfSensorSignalProcessor.

◆ Execute()

◆ GetFilterOwnshipFromDoppler()

bool wsf::SimpleDopplerSignalProcessor::GetFilterOwnshipFromDoppler ( ) const
inline

◆ GetMaxDopplerSpeed()

double wsf::SimpleDopplerSignalProcessor::GetMaxDopplerSpeed ( ) const
inline

◆ GetMinDopplerSpeed()

double wsf::SimpleDopplerSignalProcessor::GetMinDopplerSpeed ( ) const
inline

◆ ObjectFactory()

WsfSensorSignalProcessor * wsf::SimpleDopplerSignalProcessor::ObjectFactory ( const std::string & aTypeName)
static

The object factory for the MTI signal processor type.

Referenced by WsfSensorTypes::WsfSensorTypes().

◆ ProcessInput()

bool wsf::SimpleDopplerSignalProcessor::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
aInputa 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.

References WsfSensorSignalProcessor::ProcessInput().

◆ SetFilterOwnshipFromDoppler()

void wsf::SimpleDopplerSignalProcessor::SetFilterOwnshipFromDoppler ( bool aFilterOwnshipFromDoppler)
inline

◆ SetMaxDopplerSpeed()

void wsf::SimpleDopplerSignalProcessor::SetMaxDopplerSpeed ( double aMaxDopplerSpeed)
inline

◆ SetMinDopplerSpeed()

void wsf::SimpleDopplerSignalProcessor::SetMinDopplerSpeed ( double aMinDopplerSpeed)
inline

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved