WSF
Public Member Functions | Public Attributes | List of all members
WsfRadarSensor::RadarBeam Class Reference

#include <WsfRadarSensor.hpp>

Inheritance diagram for WsfRadarSensor::RadarBeam:
Inheritance graph
[legend]
Collaboration diagram for WsfRadarSensor::RadarBeam:
Collaboration graph
[legend]

Public Member Functions

 RadarBeam ()
 RadarBeam (const RadarBeam &aSrc)
RadarBeam & operator= (const RadarBeam &aRhs)
 ~RadarBeam () override
WsfEM_Rcvr * GetEM_Rcvr () override
WsfEM_Xmtr * GetEM_Xmtr () override
void AttemptToDetect (double aSimTime, WsfPlatform *aTargetPtr, Settings &aSettings, WsfSensorResult &aResult)
double GetAdjustmentFactor () const
double GetIntegrationGain () const override
void SetIntegrationGain (double aIntegrationGain) override
int GetNumberOfPulsesIntegrated () const override
bool UsingDetector () const
wsf::MarcumSwerling & GetDetector ()
std::shared_ptr< wsf::DetectionProbabilityTable > & GetProbabilityTable ()
double GetDopplerResolution () const
WsfEM_Clutter * GetClutter () const override
double GetClutterAttenuationFactor () const
bool Initialize (double aSimTime, unsigned int aBeamIndex, WsfSensor *aSensorPtr, RadarMode *aModePtr, bool aCanTransmit, bool aCanReceive, bool aShowCalibrationData, bool aIsMultiBeam)
bool ProcessInput (UtInput &aInput) override
WsfStringId GetClutterType () const
Public Member Functions inherited from WsfSensorBeam
 WsfSensorBeam ()
 WsfSensorBeam (const WsfSensorBeam &aSrc)=default
WsfSensorBeam & operator= (const WsfSensorBeam &aRhs)
virtual ~WsfSensorBeam ()=default
virtual bool Initialize (double aSimTime)
void SetBeamOwner (WsfSensorMode *aSensorModePtr)
 Set the beam owner (the parent mode).
void SetBeamIndex (size_t aBeamIndex)
WsfSensorMode * GetSensorMode () const
size_t GetBeamIndex () const
WsfSensorSignalProcessor::List & GetSignalProcessors ()

Public Attributes

std::unique_ptr< WsfEM_Antenna > mAntennaPtr
std::unique_ptr< WsfEM_Xmtr > mXmtrPtr
 The transmitter for a radar beam.
std::unique_ptr< WsfEM_Rcvr > mRcvrPtr
 The receiver for a radar beam.
WsfEM_Clutter * mClutterPtr
double mErrorModelAzBeamwidth
 Additional parameters associated with measurement errors.
double mErrorModelElBeamwidth
double mErrorModelPulseWidth
double mErrorModelDopplerResolution

Detailed Description

A RadarBeam represents a beam in a radar system. A single-beam radar is represents by one such object. A multi-beam radar is represented by a vector of these objects.

Constructor & Destructor Documentation

◆ RadarBeam() [1/2]

WsfRadarSensor::RadarBeam::RadarBeam ( )

References GetEM_Rcvr(), mAntennaPtr, mClutterPtr, mErrorModelAzBeamwidth, mErrorModelDopplerResolution, mErrorModelElBeamwidth, mErrorModelPulseWidth, mRcvrPtr, mXmtrPtr, and WsfSensorBeam::WsfSensorBeam().

Referenced by operator=(), and RadarBeam().

◆ RadarBeam() [2/2]

WsfRadarSensor::RadarBeam::RadarBeam ( const RadarBeam & aSrc)

References GetEM_Rcvr(), mAntennaPtr, mClutterPtr, mErrorModelAzBeamwidth, mErrorModelDopplerResolution, mErrorModelElBeamwidth, mErrorModelPulseWidth, mRcvrPtr, mXmtrPtr, RadarBeam(), and WsfSensorBeam::WsfSensorBeam().

◆ ~RadarBeam()

WsfRadarSensor::RadarBeam::~RadarBeam ( )
override

References mClutterPtr.

Member Function Documentation

◆ AttemptToDetect()

void WsfRadarSensor::RadarBeam::AttemptToDetect ( double aSimTime,
WsfPlatform * aTargetPtr,
Settings & aSettings,
WsfSensorResult & aResult )

Attempt to detect the specified target.

Parameters
aSimTime[input] The current simulation time.
aTargetPtr[input] The target that is trying to be detected.
aSettings[input] The settings of the sensor which is attempting to detect the aTargetPtr.
aResult[updated] On input this contains the current relative geometry information. On output this it will be updated to contain the RCS, signal-to-noise and Pd.

References WsfSensor::AttemptToDetect(), WsfSensorResult::BeginGenericInteraction(), WsfEM_Interaction::cSIGNAL_LEVEL, WsfRadarSensor::GetEM_Rcvr(), WsfRadarSensor::GetEM_Xmtr(), WsfEM_XmtrRcvr::GetPlatform(), WsfSensorResult::mBeamIndex, WsfEM_Interaction::mFailedStatus, mRcvrPtr, WsfEM_Interaction::mSignalToNoise, and WsfSensorResult::Reset().

Referenced by WsfCTD_SensorComponent::AttemptToDetect().

◆ GetAdjustmentFactor()

double WsfRadarSensor::RadarBeam::GetAdjustmentFactor ( ) const
inline

Referenced by WsfRF_Jammer::ComputeReceiverGains().

◆ GetClutter()

WsfEM_Clutter * WsfRadarSensor::RadarBeam::GetClutter ( ) const
inlineoverridevirtual

Reimplemented from WsfSensorBeam.

References mClutterPtr.

◆ GetClutterAttenuationFactor()

double WsfRadarSensor::RadarBeam::GetClutterAttenuationFactor ( ) const
inline

Referenced by WsfRadarMTI_AdjSignalProcessor::Initialize().

◆ GetClutterType()

WsfStringId WsfRadarSensor::RadarBeam::GetClutterType ( ) const
inline

◆ GetDetector()

wsf::MarcumSwerling & WsfRadarSensor::RadarBeam::GetDetector ( )
inline

◆ GetDopplerResolution()

double WsfRadarSensor::RadarBeam::GetDopplerResolution ( ) const
inline

◆ GetEM_Rcvr()

WsfEM_Rcvr * WsfRadarSensor::RadarBeam::GetEM_Rcvr ( )
inlineoverridevirtual

Reimplemented from WsfSensorBeam.

References mRcvrPtr.

Referenced by Initialize(), RadarBeam(), RadarBeam(), and WsfRadarSensor::UpdateXmtrRcvrLists().

◆ GetEM_Xmtr()

WsfEM_Xmtr * WsfRadarSensor::RadarBeam::GetEM_Xmtr ( )
inlineoverridevirtual

Reimplemented from WsfSensorBeam.

References mXmtrPtr.

Referenced by WsfRadarSensor::UpdateXmtrRcvrLists().

◆ GetIntegrationGain()

double WsfRadarSensor::RadarBeam::GetIntegrationGain ( ) const
inlineoverridevirtual

Reimplemented from WsfSensorBeam.

Referenced by WsfRF_Jammer::ComputeReceiverGains().

◆ GetNumberOfPulsesIntegrated()

int WsfRadarSensor::RadarBeam::GetNumberOfPulsesIntegrated ( ) const
inlineoverridevirtual

Reimplemented from WsfSensorBeam.

Referenced by WsfRadarMTI_AdjSignalProcessor::Initialize(), WsfEW_RPJ_Effect::UpdateEffects(), WsfEW_SimpleFT_Effect::UpdateEffects(), WsfEW_FalseTargetEffect::UpdateFT(), WsfEW_FalseTargetEffect::UpdateJammerPulseDensity(), and WsfEW_SimpleFT_Effect::UpdateJammerPulseDensity().

◆ GetProbabilityTable()

std::shared_ptr< wsf::DetectionProbabilityTable > & WsfRadarSensor::RadarBeam::GetProbabilityTable ( )
inline

Pointer to the detection probability table. If this is not a null pointer then it is used for determining the probability of detection.

◆ Initialize()

bool WsfRadarSensor::RadarBeam::Initialize ( double aSimTime,
unsigned int aBeamIndex,
WsfSensor * aSensorPtr,
RadarMode * aModePtr,
bool aCanTransmit,
bool aCanReceive,
bool aShowCalibrationData,
bool aIsMultiBeam )

References WsfPlatformPart::cLEVEL_TWO_DEBUG, WsfObjectTypeList< T >::Clone(), WsfPlatformPart::DebugEnabled(), WsfEM_ClutterTypes::Get(), WsfPlatformPart::GetDebugMask(), GetEM_Rcvr(), WsfNamed::GetName(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetScenario(), WsfSensorBeam::GetSignalProcessors(), WsfPlatformPart::GetSimulation(), WsfScenario::GetSimulationInput(), WsfSensorBeam::Initialize(), mAntennaPtr, mClutterPtr, mRcvrPtr, mXmtrPtr, ok, WsfSimulationInput::UseDefaultFrequency(), and WsfSensorBeam::WsfSensor.

Referenced by WsfRadarSensor::RadarMode::Initialize().

◆ operator=()

WsfRadarSensor::RadarBeam & WsfRadarSensor::RadarBeam::operator= ( const RadarBeam & aRhs)

References WsfRadarSensor::GetEM_Rcvr(), mAntennaPtr, mClutterPtr, mErrorModelAzBeamwidth, mErrorModelDopplerResolution, mErrorModelElBeamwidth, mErrorModelPulseWidth, mRcvrPtr, mXmtrPtr, WsfSensorBeam::operator=(), and RadarBeam().

◆ ProcessInput()

bool WsfRadarSensor::RadarBeam::ProcessInput ( UtInput & aInput)
overridevirtual

Reimplemented from WsfSensorBeam.

References wsf::MarcumSwerling::cDL_LINEAR, wsf::MarcumSwerling::cDL_LOG, wsf::MarcumSwerling::cDL_SQUARE, WsfScenario::FromInput(), WsfEM_ClutterTypes::Get(), mAntennaPtr, mErrorModelAzBeamwidth, mErrorModelDopplerResolution, mErrorModelElBeamwidth, mErrorModelPulseWidth, mRcvrPtr, mXmtrPtr, and WsfSensorBeam::ProcessInput().

◆ SetIntegrationGain()

void WsfRadarSensor::RadarBeam::SetIntegrationGain ( double aIntegrationGain)
inlineoverridevirtual

Reimplemented from WsfSensorBeam.

◆ UsingDetector()

bool WsfRadarSensor::RadarBeam::UsingDetector ( ) const
inline

Referenced by WsfRadarMTI_AdjSignalProcessor::Initialize(), WsfEW_RPJ_Effect::UpdateEffects(), WsfEW_SimpleFT_Effect::UpdateEffects(), WsfEW_FalseTargetEffect::UpdateFT(), WsfEW_FalseTargetEffect::UpdateJammerPulseDensity(), and WsfEW_SimpleFT_Effect::UpdateJammerPulseDensity().

Member Data Documentation

◆ mAntennaPtr

std::unique_ptr<WsfEM_Antenna> WsfRadarSensor::RadarBeam::mAntennaPtr

Referenced by WsfRadarMTI_AdjSignalProcessor::Initialize(), Initialize(), WsfRadarSensor::RadarMode::Initialize(), operator=(), ProcessInput(), RadarBeam(), and RadarBeam().

◆ mClutterPtr

WsfEM_Clutter* WsfRadarSensor::RadarBeam::mClutterPtr

The pointer to the clutter model (after initialization). This will be zero if no clutter model has been selected.

Referenced by GetClutter(), Initialize(), operator=(), RadarBeam(), RadarBeam(), and ~RadarBeam().

◆ mErrorModelAzBeamwidth

double WsfRadarSensor::RadarBeam::mErrorModelAzBeamwidth

Additional parameters associated with measurement errors.

Referenced by operator=(), ProcessInput(), RadarBeam(), and RadarBeam().

◆ mErrorModelDopplerResolution

double WsfRadarSensor::RadarBeam::mErrorModelDopplerResolution

Referenced by operator=(), ProcessInput(), RadarBeam(), and RadarBeam().

◆ mErrorModelElBeamwidth

double WsfRadarSensor::RadarBeam::mErrorModelElBeamwidth

Referenced by operator=(), ProcessInput(), RadarBeam(), and RadarBeam().

◆ mErrorModelPulseWidth

double WsfRadarSensor::RadarBeam::mErrorModelPulseWidth

Referenced by operator=(), ProcessInput(), RadarBeam(), and RadarBeam().

◆ mRcvrPtr

std::unique_ptr<WsfEM_Rcvr> WsfRadarSensor::RadarBeam::mRcvrPtr

The receiver for a radar beam.

Referenced by AttemptToDetect(), GetEM_Rcvr(), WsfRadarMTI_AdjSignalProcessor::Initialize(), Initialize(), operator=(), ProcessInput(), RadarBeam(), and RadarBeam().

◆ mXmtrPtr

std::unique_ptr<WsfEM_Xmtr> WsfRadarSensor::RadarBeam::mXmtrPtr

The transmitter for a radar beam.

Referenced by WsfRF_Jammer::ComputeReceiverGains(), GetEM_Xmtr(), WsfRadarMTI_AdjSignalProcessor::Initialize(), Initialize(), WsfRadarSensor::RadarMode::Initialize(), operator=(), ProcessInput(), RadarBeam(), and RadarBeam().

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