WsfAntennaPattern::BaseData Class Reference

#include <WsfAntennaPattern.hpp>

Inheritance diagram for WsfAntennaPattern::BaseData:

Collaboration diagram for WsfAntennaPattern::BaseData:

Public Member Functions
	BaseData ()
	BaseData (const BaseData &aSrc)=default
	~BaseData () override=default
virtual bool	ProcessInput (WsfAntennaPattern &aPattern, UtInput &aInput)
virtual bool	Initialize (WsfAntennaPattern &aAntennaPattern)
virtual double	GetGain (double aFrequency, double aTargetAz, double aTargetEl, double aEBS_Az, double aEBS_El)
virtual double	PerformGainAdjustment (double aFrequency, double aGain)
virtual void	InitializeAverageGain (double aFrequency)
	Initialize the average gain table if not already initialized.

Public Attributes
double	mMinimumGain
	The minimum gain that should be returned by any antenna pattern.
double	mGainAdjustment
	A simple gain adjustment.
GainAdjustmentTable	mGainAdjustmentTable
	Frequency-dependent gain adjustment table.
bool	mInitialized

Data used by the GetGainThreshold function.
bool	mAvgGainInitialized
bool	mShowAvgGain
std::recursive_mutex	mAvgGainMutex
std::vector< double >	mAvgGain
double	mSampledPeakGain
	The peak gain of the sample. This SHOULD be the peak gain of the pattern.

Constructor & Destructor Documentation

BaseData() [1/2]

WsfAntennaPattern::BaseData::BaseData

(

)

References mAvgGain, mAvgGainInitialized, mAvgGainMutex, mGainAdjustment, mGainAdjustmentTable, mInitialized, mMinimumGain, mSampledPeakGain, and mShowAvgGain.

Referenced by WsfALARM_AntennaPattern::ALARM_Data::ALARM_Data(), BaseData(), WsfESA_AntennaPattern::ESA_Data::ESA_Data(), and WsfStandardAntennaPattern::StandardData::StandardData().

BaseData() [2/2]

WsfAntennaPattern::BaseData::BaseData ( const BaseData & aSrc )

default

References BaseData().

~BaseData()

WsfAntennaPattern::BaseData::~BaseData ( )

overridedefault

References GetGain(), Initialize(), InitializeAverageGain(), PerformGainAdjustment(), and WsfAntennaPattern::WsfAntennaPattern().

Member Function Documentation

GetGain()

double WsfAntennaPattern::BaseData::GetGain ( double aFrequency, double aTargetAz, double aTargetEl, double aEBS_Az, double aEBS_El )

virtual

Reimplemented in WsfALARM_AntennaPattern::ALARM_Data, and WsfStandardAntennaPattern::StandardData.

References PerformGainAdjustment().

Referenced by ~BaseData().

Initialize()

bool WsfAntennaPattern::BaseData::Initialize ( WsfAntennaPattern & aAntennaPattern )

virtual

Reimplemented in WsfALARM_AntennaPattern::ALARM_Data, WsfESA_AntennaPattern::ESA_Data, WsfESA_NX_AntennaPattern::ESA_NX_Data, WsfGENAP_AntennaPattern::GENAP_Data, and WsfStandardAntennaPattern::StandardData.

References InitializeAverageGain(), mInitialized, mShowAvgGain, and WsfAntennaPattern::WsfAntennaPattern().

Referenced by ~BaseData().

InitializeAverageGain()

void WsfAntennaPattern::BaseData::InitializeAverageGain ( double aFrequency )

virtual

Initialize the average gain table if not already initialized.

References WsfAntennaPattern::GetGain(), mAvgGain, mAvgGainInitialized, mAvgGainMutex, mSampledPeakGain, and mShowAvgGain.

Referenced by Initialize(), and ~BaseData().

PerformGainAdjustment()

double WsfAntennaPattern::BaseData::PerformGainAdjustment ( double aFrequency, double aGain )

virtual

References mGainAdjustment, mGainAdjustmentTable, and mMinimumGain.

Referenced by WsfALARM_AntennaPattern::ALARM_Data::GetGain(), GetGain(), WsfStandardAntennaPattern::StandardData::GetGain(), WsfALARM_AntennaPattern::GetPeakGain(), WsfStandardAntennaPattern::GetPeakGain(), and ~BaseData().

ProcessInput()

bool WsfAntennaPattern::BaseData::ProcessInput ( WsfAntennaPattern & aPattern, UtInput & aInput )

virtual

Reimplemented in WsfALARM_AntennaPattern::ALARM_Data, WsfElementESA_AntennaPattern::EESA_Data, WsfESA_AntennaPattern::ESA_Data, WsfESA_NX_AntennaPattern::ESA_NX_Data, WsfGENAP_AntennaPattern::GENAP_Data, and WsfStandardAntennaPattern::StandardData.

References mGainAdjustment, mGainAdjustmentTable, mMinimumGain, mShowAvgGain, and WsfAntennaPattern::WsfAntennaPattern().

Referenced by WsfStandardAntennaPattern::StandardData::ProcessCircularInput(), WsfStandardAntennaPattern::StandardData::ProcessCosecantSquaredInput(), WsfALARM_AntennaPattern::ALARM_Data::ProcessInput(), WsfESA_AntennaPattern::ESA_Data::ProcessInput(), WsfGENAP_AntennaPattern::GENAP_Data::ProcessInput(), WsfStandardAntennaPattern::StandardData::ProcessInput(), WsfStandardAntennaPattern::StandardData::ProcessPatternTableInput(), WsfStandardAntennaPattern::StandardData::ProcessSineInput(), and WsfStandardAntennaPattern::StandardData::ProcessUniformInput().

Member Data Documentation

mAvgGain

std::vector<double> WsfAntennaPattern::BaseData::mAvgGain

Referenced by BaseData(), and InitializeAverageGain().

mAvgGainInitialized

bool WsfAntennaPattern::BaseData::mAvgGainInitialized

Referenced by BaseData(), and InitializeAverageGain().

mAvgGainMutex

std::recursive_mutex WsfAntennaPattern::BaseData::mAvgGainMutex

Referenced by BaseData(), and InitializeAverageGain().

mGainAdjustment

double WsfAntennaPattern::BaseData::mGainAdjustment

A simple gain adjustment.

Referenced by BaseData(), PerformGainAdjustment(), WsfALARM_AntennaPattern::ALARM_Data::ProcessInput(), and ProcessInput().

mGainAdjustmentTable

GainAdjustmentTable WsfAntennaPattern::BaseData::mGainAdjustmentTable

Frequency-dependent gain adjustment table.

Referenced by BaseData(), PerformGainAdjustment(), and ProcessInput().

mInitialized

bool WsfAntennaPattern::BaseData::mInitialized

Initialization flag for the shared data that is to be initialized only once to speed up the overall initialization of the simulation.

Referenced by BaseData(), and Initialize().

mMinimumGain

double WsfAntennaPattern::BaseData::mMinimumGain

The minimum gain that should be returned by any antenna pattern.

Referenced by BaseData(), WsfStandardAntennaPattern::StandardData::CosecantSquaredPattern(), WsfALARM_AntennaPattern::ALARM_Data::GetGain(), WsfStandardAntennaPattern::StandardData::GetGain(), PerformGainAdjustment(), and ProcessInput().

mSampledPeakGain

double WsfAntennaPattern::BaseData::mSampledPeakGain

The peak gain of the sample. This SHOULD be the peak gain of the pattern.

Referenced by BaseData(), and InitializeAverageGain().

mShowAvgGain

bool WsfAntennaPattern::BaseData::mShowAvgGain

Referenced by BaseData(), Initialize(), InitializeAverageGain(), and ProcessInput().

---

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

• WsfAntennaPattern.hpp
• WsfAntennaPattern.cpp