WSF
Classes | Public Member Functions | Public Attributes | List of all members
WsfESA_AntennaPattern::ESA_Data Class Reference

#include <WsfESA_AntennaPattern.hpp>

Inheritance diagram for WsfESA_AntennaPattern::ESA_Data:
Inheritance graph
[legend]
Collaboration diagram for WsfESA_AntennaPattern::ESA_Data:
Collaboration graph
[legend]

Classes

struct  TaylorWeightingData

Public Member Functions

 ESA_Data ()
 ESA_Data (const ESA_Data &aSrc)=default
 ~ESA_Data () override=default
bool ProcessInput (WsfAntennaPattern &aPattern, UtInput &aInput) override
bool Initialize (WsfAntennaPattern &aAntennaPattern) override
Public Member Functions inherited from WsfAntennaPattern::BaseData
 BaseData ()
 BaseData (const BaseData &aSrc)=default
 ~BaseData () override=default
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 mdX
 X-axis element spacing in meters.
double mdY
 Y-axis element spacing in meters.
double mLengthX
 Input X-axis length of the array in meters.
double mLengthY
 Input Y-axis length of the array in meters.
int mNX
 Input X-axis number of elements.
int mNY
 Input Y-axis number of elements.
bool mBackBaffled
double mFailedRatio
 Back baffled array flag, minimum gain is used if Azimuth angles outside +-90 degs.
WeightingFun mDistribution
 The weighting function to be applied.
TaylorWeightingData mTaylorData
 Taylor sidelobe level control data.
double mScanExponentX
 Azimuth exponent for azimuth distribution function - NOT USED.
double mScanExponentY
 Elevation exponent for elevation distribution function - NOT USED.
int mPhaseNumBits
 Quantization of the steering phase.
int mAmpNumBits
 Quantization of the amplitude weighting.
LatticeType mLatticeType
 The lattice type (i.e. shape) for element location calculations.
WsfStringId mElementPatternTypeId
bool mDebug
Public Attributes inherited from WsfAntennaPattern::BaseData
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
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

◆ ESA_Data() [1/2]

WsfESA_AntennaPattern::ESA_Data::ESA_Data ( )

References WsfAntennaPattern::BaseData::BaseData(), WsfESA_AntennaPattern::cLT_RECTANGLULAR, WsfESA_AntennaPattern::cWT_None, mAmpNumBits, mBackBaffled, mDebug, mDistribution, mdX, mdY, mElementPatternTypeId, mFailedRatio, mLatticeType, mLengthX, mLengthY, mNX, mNY, mPhaseNumBits, mScanExponentX, mScanExponentY, and mTaylorData.

Referenced by WsfElementESA_AntennaPattern::EESA_Data::EESA_Data(), ESA_Data(), and WsfESA_NX_AntennaPattern::ESA_NX_Data::ESA_NX_Data().

◆ ESA_Data() [2/2]

WsfESA_AntennaPattern::ESA_Data::ESA_Data ( const ESA_Data & aSrc)
default

References ESA_Data().

◆ ~ESA_Data()

WsfESA_AntennaPattern::ESA_Data::~ESA_Data ( )
overridedefault

References WsfAntennaPattern::WsfAntennaPattern().

Member Function Documentation

◆ Initialize()

bool WsfESA_AntennaPattern::ESA_Data::Initialize ( WsfAntennaPattern & aAntennaPattern)
overridevirtual

Reimplemented from WsfAntennaPattern::BaseData.

Reimplemented in WsfESA_NX_AntennaPattern::ESA_NX_Data.

References WsfObject::GetType(), mDebug, mdX, mdY, mLengthX, mLengthY, mNX, mNY, and WsfAntennaPattern::WsfAntennaPattern().

Referenced by WsfESA_NX_AntennaPattern::ESA_NX_Data::Initialize().

◆ ProcessInput()

bool WsfESA_AntennaPattern::ESA_Data::ProcessInput ( WsfAntennaPattern & aPattern,
UtInput & aInput )
overridevirtual

Reimplemented from WsfAntennaPattern::BaseData.

Reimplemented in WsfESA_NX_AntennaPattern::ESA_NX_Data.

References WsfESA_AntennaPattern::cLT_RECTANGLULAR, WsfESA_AntennaPattern::cLT_TRIANGLULAR, WsfESA_AntennaPattern::cWT_Taylor, WsfESA_AntennaPattern::cWT_Uniform, WsfScenario::FindTypeT(), WsfScenario::FromInput(), WsfObject::GetTypeId(), mAmpNumBits, mBackBaffled, mDebug, mDistribution, mdX, mdY, mElementPatternTypeId, mFailedRatio, mLatticeType, mLengthX, mLengthY, mNX, mNY, mPhaseNumBits, mScanExponentX, mScanExponentY, WsfAntennaPattern::BaseData::ProcessInput(), and WsfAntennaPattern::WsfAntennaPattern().

Referenced by WsfElementESA_AntennaPattern::EESA_Data::ProcessInput(), and WsfESA_NX_AntennaPattern::ESA_NX_Data::ProcessInput().

Member Data Documentation

◆ mAmpNumBits

int WsfESA_AntennaPattern::ESA_Data::mAmpNumBits

Quantization of the amplitude weighting.

Referenced by ESA_Data(), WsfESA_NX_AntennaPattern::GetAmpNumBits(), and ProcessInput().

◆ mBackBaffled

bool WsfESA_AntennaPattern::ESA_Data::mBackBaffled

Referenced by ESA_Data(), and ProcessInput().

◆ mDebug

bool WsfESA_AntennaPattern::ESA_Data::mDebug

Referenced by ESA_Data(), Initialize(), and ProcessInput().

◆ mDistribution

WeightingFun WsfESA_AntennaPattern::ESA_Data::mDistribution

The weighting function to be applied.

Referenced by ESA_Data(), WsfESA_NX_AntennaPattern::IsDistributionTaylor(), WsfESA_NX_AntennaPattern::IsDistributionUniform(), and ProcessInput().

◆ mdX

double WsfESA_AntennaPattern::ESA_Data::mdX

X-axis element spacing in meters.

Referenced by WsfESA_NX_AntennaPattern::AdjustElementLocations(), WsfElementESA_AntennaPattern::ComputeDirectivityGain(), ESA_Data(), WsfESA_NX_AntennaPattern::GetElementSpacingX(), Initialize(), WsfElementESA_AntennaPattern::EESA_Data::ProcessInput(), ProcessInput(), and WsfESA_NX_AntennaPattern::ResizeArray().

◆ mdY

double WsfESA_AntennaPattern::ESA_Data::mdY

Y-axis element spacing in meters.

Referenced by WsfESA_NX_AntennaPattern::AdjustElementLocations(), WsfElementESA_AntennaPattern::ComputeDirectivityGain(), ESA_Data(), WsfESA_NX_AntennaPattern::GetElementSpacingY(), Initialize(), WsfElementESA_AntennaPattern::EESA_Data::ProcessInput(), ProcessInput(), and WsfESA_NX_AntennaPattern::ResizeArray().

◆ mElementPatternTypeId

WsfStringId WsfESA_AntennaPattern::ESA_Data::mElementPatternTypeId

The element pattern type Id for loading an element pattern from and antenna pattern type.

Referenced by ESA_Data(), and ProcessInput().

◆ mFailedRatio

double WsfESA_AntennaPattern::ESA_Data::mFailedRatio

Back baffled array flag, minimum gain is used if Azimuth angles outside +-90 degs.

Ratio of failed elements in the ESA

Referenced by ESA_Data(), and ProcessInput().

◆ mLatticeType

LatticeType WsfESA_AntennaPattern::ESA_Data::mLatticeType

The lattice type (i.e. shape) for element location calculations.

Referenced by ESA_Data(), and ProcessInput().

◆ mLengthX

double WsfESA_AntennaPattern::ESA_Data::mLengthX

Input X-axis length of the array in meters.

Referenced by ESA_Data(), WsfElementESA_AntennaPattern::Initialize(), Initialize(), ProcessInput(), and WsfESA_NX_AntennaPattern::ResizeArray().

◆ mLengthY

double WsfESA_AntennaPattern::ESA_Data::mLengthY

Input Y-axis length of the array in meters.

Referenced by ESA_Data(), WsfElementESA_AntennaPattern::Initialize(), Initialize(), ProcessInput(), and WsfESA_NX_AntennaPattern::ResizeArray().

◆ mNX

int WsfESA_AntennaPattern::ESA_Data::mNX

Input X-axis number of elements.

Referenced by ESA_Data(), WsfESA_NX_AntennaPattern::GetNumberElementsX(), WsfElementESA_AntennaPattern::Initialize(), Initialize(), ProcessInput(), and WsfESA_NX_AntennaPattern::ResizeArray().

◆ mNY

int WsfESA_AntennaPattern::ESA_Data::mNY

Input Y-axis number of elements.

Referenced by ESA_Data(), WsfESA_NX_AntennaPattern::GetNumberElementsY(), WsfElementESA_AntennaPattern::Initialize(), Initialize(), ProcessInput(), and WsfESA_NX_AntennaPattern::ResizeArray().

◆ mPhaseNumBits

int WsfESA_AntennaPattern::ESA_Data::mPhaseNumBits

Quantization of the steering phase.

Referenced by ESA_Data(), WsfESA_NX_AntennaPattern::GetPhaseNumBits(), and ProcessInput().

◆ mScanExponentX

double WsfESA_AntennaPattern::ESA_Data::mScanExponentX

Azimuth exponent for azimuth distribution function - NOT USED.

Note
The steering loss is applied in WsfEM_Antenna::ComputeBeamSteeringLoss outside this class. This allows it to be extended to other antenna pattern classes. An example of how this would be applied is below.

Referenced by ESA_Data(), and ProcessInput().

◆ mScanExponentY

double WsfESA_AntennaPattern::ESA_Data::mScanExponentY

Elevation exponent for elevation distribution function - NOT USED.

Referenced by ESA_Data(), and ProcessInput().

◆ mTaylorData

TaylorWeightingData WsfESA_AntennaPattern::ESA_Data::mTaylorData

Taylor sidelobe level control data.

Referenced by ESA_Data(), WsfESA_NX_AntennaPattern::GetTaylorDataN_BarX(), WsfESA_NX_AntennaPattern::GetTaylorDataN_BarY(), WsfESA_NX_AntennaPattern::GetTaylorDataSidelobeLevelX(), and WsfESA_NX_AntennaPattern::GetTaylorDataSidelobeLevelY().

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