#include <WsfESA_AntennaPattern.hpp>

Inheritance diagram for WsfESA_AntennaPattern:

[legend]

Collaboration diagram for WsfESA_AntennaPattern:

[legend]

Classes
struct	Element
class	ESA_Data

Public Types
enum	LatticeType { cLT_RECTANGLULAR , cLT_TRIANGLULAR }
enum	WeightingFun { cWT_None = 0 , cWT_Taylor = 1 , cWT_Uniform = 2 }
using	ElementVec = std::vector<Element>
using	WeightVec = std::vector<double>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfESA_AntennaPattern (ESA_Data *aEsaData=nullptr)
	~WsfESA_AntennaPattern () override
WsfAntennaPattern *	Clone () const override
bool	Initialize (WsfSimulation *aSimulationPtr) override
double	GetGain (double aFrequency, double aTargetAz, double aTargetEl, double aEBS_Az, double aEBS_EL) override
double	GetAzimuthBeamwidth (double aFrequency, double aEBS_Azimuth, double aEBS_Elevation) const override
double	GetElevationBeamwidth (double aFrequency, double aEBS_Azimuth, double aEBS_Elevation) const override
double	GetPeakGain (double aFrequency) const override
Public Member Functions inherited from WsfAntennaPattern
	WsfAntennaPattern ()
	WsfAntennaPattern (BaseData *aBasePtr)
	~WsfAntennaPattern () override
const char *	GetScriptClassName () const override
virtual WSF_DEPRECATED double	GetAzimuthBeamwidth (double aFrequency) const final
virtual WSF_DEPRECATED double	GetElevationBeamwidth (double aFrequency) const final
virtual double	GetMinimumGain () const
virtual const GainAdjustmentTable &	GetGainAdjustmentTable () const
virtual double	GetGainAdjustment () const
bool	ProcessInput (UtInput &aInput) override
virtual double	GetGainThresholdFraction (double aGainThreshold, double aPeakGain, double aMinAz, double aMaxAz, double aFrequency)
virtual void	SetAntennaBeamCount (unsigned int aBeamCount)
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)

Static Public Member Functions
static WsfAntennaPattern *	ObjectFactory (const std::string &aTypeName)

Protected Attributes
WeightVec	mWeightVecX
WeightVec	mWeightVecY
	Calculated aperture efficiency.
double	mApertureEff
double	mApertureEffX
double	mApertureEffY
WsfAntennaPattern *	mElementPatternPtr
Protected Attributes inherited from WsfAntennaPattern
BaseData *	mSharedDataPtr

Current ESA data
ElementVec	mElements
	Current vector of elements used for pattern calculations.
double	mLengthX
	Current X-axis length of the array in meters.
double	mLengthY
	Current Y-axis length of the array in meters.
int	mNX
	Current X-axis number of elements.
int	mNY
	Current Y-axis number of elements.

Private data access.
These methods return data that should not be considered part of the public interface. They were provided to support External Services. Use at your own risk!
double	GetElementSpacingX () const
double	GetElementSpacingY () const
int	GetNumberElementsX () const
int	GetNumberElementsY () const
bool	IsDistributionTaylor () const
bool	IsDistributionUniform () const
double	GetTaylorDataSidelobeLevelX () const
double	GetTaylorDataSidelobeLevelY () const
double	GetTaylorDataN_BarX () const
double	GetTaylorDataN_BarY () const
int	GetPhaseNumBits () const
int	GetAmpNumBits () const
	WsfESA_AntennaPattern (const WsfESA_AntennaPattern &aSrc)
WsfESA_AntennaPattern &	operator= (const WsfESA_AntennaPattern &aRhs)=delete
	Assignment is not supported.
ESA_Data *	GetData () const
virtual double	ComputeDirectivityGain (double aFrequency, double aEBS_Az, double aEBS_El) const
virtual double	ComputeElementGain (double aFrequency, double aAzAngle, double aElAngle) const
virtual double	ComputeElementFactor (double aFrequency, double aEBS_Az, double aEBS_El, double aAzAngle, double aElAngle) const
void	SetESA_DataPtr (ESA_Data *aESA_DataPtr)
virtual void	ResizeArray ()
virtual void	AdjustApertureElements (ut::Random &aRandom)
virtual void	AdjustElementLocations ()
void	ComputeFailedModulesWeights (ut::Random &aRandom)

Additional Inherited Members
Static Public Attributes inherited from WsfAntennaPattern
static const char *	cTYPE_KIND = "antenna_pattern"
Protected Member Functions inherited from WsfAntennaPattern
	WsfAntennaPattern (const WsfAntennaPattern &aSrc)
	Copy Constructor for Clone().
WsfAntennaPattern &	operator= (const WsfAntennaPattern &aRhs)
virtual double	ApplyEBS (double aBeamwidth, double aEBS_Az, double aEBS_El) const
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Detailed Description

The implementation of an 'Electronically Scanned Array (ESA)' antenna patterns.

Different weighting functions can be applied:

Uniform (default)
Taylor

Member Typedef Documentation

◆ ElementVec

using WsfESA_AntennaPattern::ElementVec = std::vector<Element>

◆ WeightVec

using WsfESA_AntennaPattern::WeightVec = std::vector<double>

Member Enumeration Documentation

◆ LatticeType

enum WsfESA_AntennaPattern::LatticeType

Enumerator
cLT_RECTANGLULAR
cLT_TRIANGLULAR

◆ WeightingFun

enum WsfESA_AntennaPattern::WeightingFun

Enumerator
cWT_None
cWT_Taylor
cWT_Uniform

Constructor & Destructor Documentation

◆ WsfESA_AntennaPattern() [1/2]

WsfESA_AntennaPattern::WsfESA_AntennaPattern ( ESA_Data * aEsaData = nullptr )

◆ ~WsfESA_AntennaPattern()

WsfESA_AntennaPattern::~WsfESA_AntennaPattern ( )

override

References mElementPatternPtr.

◆ WsfESA_AntennaPattern() [2/2]

WsfESA_AntennaPattern::WsfESA_AntennaPattern ( const WsfESA_AntennaPattern & aSrc )

protected

References Initialize(), mApertureEff, mApertureEffX, mApertureEffY, mElementPatternPtr, mElements, mLengthX, mLengthY, mNX, mNY, WsfAntennaPattern::mSharedDataPtr, mWeightVecX, mWeightVecY, WsfAntennaPattern::WsfAntennaPattern(), and WsfESA_AntennaPattern().

Member Function Documentation

◆ AdjustApertureElements()

void WsfESA_AntennaPattern::AdjustApertureElements ( ut::Random & aRandom )

protectedvirtual

References AdjustElementLocations(), ComputeFailedModulesWeights(), mElements, mNX, mNY, mWeightVecX, mWeightVecY, and ResizeArray().

Referenced by Initialize(), WsfESA_NX_AntennaPattern::Initialize(), and WsfESA_NX_AntennaPattern::SetAntennaBeamCount().

◆ AdjustElementLocations()

void WsfESA_AntennaPattern::AdjustElementLocations ( )

protectedvirtual

Reimplemented in WsfESA_NX_AntennaPattern.

References cLT_TRIANGLULAR, mElements, WsfESA_AntennaPattern::Element::mLocation, mNX, and mNY.

Referenced by AdjustApertureElements().

◆ Clone()

WsfAntennaPattern * WsfESA_AntennaPattern::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.

Reimplemented from WsfAntennaPattern.

Reimplemented in WsfESA_NX_AntennaPattern.

References WsfAntennaPattern::WsfAntennaPattern(), and WsfESA_AntennaPattern().

◆ ComputeDirectivityGain()

double WsfESA_AntennaPattern::ComputeDirectivityGain	(	double	aFrequency,
		double	aEBS_Az,
		double	aEBS_El ) const

protectedvirtual

Reimplemented in WsfElementESA_AntennaPattern, and WsfESA_NX_AntennaPattern.

References mApertureEff, mNX, and mNY.

Referenced by WsfESA_NX_AntennaPattern::ComputeDirectivityGain(), and ComputeElementFactor().

◆ ComputeElementFactor()

double WsfESA_AntennaPattern::ComputeElementFactor	(	double	aFrequency,
		double	aEBS_Az,
		double	aEBS_El,
		double	aAzAngle,
		double	aElAngle ) const

protectedvirtual

References ComputeDirectivityGain(), ComputeElementGain(), and mApertureEff.

◆ ComputeElementGain()

double WsfESA_AntennaPattern::ComputeElementGain	(	double	aFrequency,
		double	aAzAngle,
		double	aElAngle ) const

protectedvirtual

Reimplemented in WsfElementESA_AntennaPattern.

References mElementPatternPtr, mElements, mNX, and mNY.

Referenced by ComputeElementFactor().

◆ ComputeFailedModulesWeights()

void WsfESA_AntennaPattern::ComputeFailedModulesWeights ( ut::Random & aRandom )

protected

References mElements, mNX, and mNY.

Referenced by AdjustApertureElements(), and WsfElementESA_AntennaPattern::Initialize().

◆ GetAmpNumBits()

int WsfESA_AntennaPattern::GetAmpNumBits ( ) const

inline

◆ GetAzimuthBeamwidth()

double WsfESA_AntennaPattern::GetAzimuthBeamwidth	(	double	aFrequency,
		double	aEBS_Azimuth,
		double	aEBS_Elevation ) const

overridevirtual

Return the azimuth beamwidth at the specified frequency. The beamwidth is defined to be the width of the main lobe where the gain is 3 dB down from the peak gain.

Parameters

aFrequency	The frequency in Hz.
aEBS_Azimuth	The Electronic Beamwidth Steering in terms of Azimuth (radians)
aEBS_Elevation	The Electronic Beamwidth Steering in terms of Elevation (radians)

Returns: The azimuth beamwidth (radians)

Reimplemented from WsfAntennaPattern.

References WsfAntennaPattern::ApplyEBS(), mApertureEffX, and mNX.

◆ GetData()

ESA_Data * WsfESA_AntennaPattern::GetData ( ) const

inlineprotected

Referenced by WsfElementESA_AntennaPattern::GetEESA_Data(), and WsfESA_NX_AntennaPattern::NX_Data().

◆ GetElementSpacingX()

double WsfESA_AntennaPattern::GetElementSpacingX ( ) const

inline

◆ GetElementSpacingY()

double WsfESA_AntennaPattern::GetElementSpacingY ( ) const

inline

◆ GetElevationBeamwidth()

double WsfESA_AntennaPattern::GetElevationBeamwidth	(	double	aFrequency,
		double	aEBS_Azimuth,
		double	aEBS_Elevation ) const

overridevirtual

Return the elevation beamwidth at the specified frequency. The beamwidth is defined to be the width of the main lobe where the gain is 3 dB down from the peak gain.

Parameters

aFrequency	The frequency in Hz.
aEBS_Azimuth	The Electronic Beamwidth Steering in terms of Azimuth (radians)
aEBS_Elevation	The Electronic Beamwidth Steering in terms of Elevation (radians)

Returns: The azimuth beamwidth (radians)

Reimplemented from WsfAntennaPattern.

References WsfAntennaPattern::ApplyEBS(), mApertureEffY, and mNY.

◆ GetGain()

double WsfESA_AntennaPattern::GetGain	(	double	aFrequency,
		double	aTargetAz,
		double	aTargetEl,
		double	aEBS_Az,
		double	aEBS_El )

overridevirtual

Return the antenna gain at a specified azimuth and elevation.

Parameters

aFrequency	The frequency at which to get the gain (Hz).
aTargetAz	Target azimuth with respect to the gain pattern boresight (radians).
aTargetEl	Target elevation with respect to the gain pattern boresight (radians).
aEBS_Az	The Electronic Beam Steering azimuth angle (radians).
aEBS_El	The Electronic Beam Steering elevation angle (radians).

Returns: The gain multiplier (NOT in dB!)

Reimplemented from WsfAntennaPattern.

◆ GetNumberElementsX()

int WsfESA_AntennaPattern::GetNumberElementsX ( ) const

inline

◆ GetNumberElementsY()

int WsfESA_AntennaPattern::GetNumberElementsY ( ) const

inline

◆ GetPeakGain()

double WsfESA_AntennaPattern::GetPeakGain ( double aFrequency ) const

overridevirtual

Return the peak (boresight) gain in the pattern at the specified frequency.

Parameters

aFrequency The frequency in Hz.

Returns: The peak gain (as an absolute ratio, NOT dB)

Reimplemented from WsfAntennaPattern.

◆ GetPhaseNumBits()

int WsfESA_AntennaPattern::GetPhaseNumBits ( ) const

inline

◆ GetTaylorDataN_BarX()

double WsfESA_AntennaPattern::GetTaylorDataN_BarX ( ) const

inline

◆ GetTaylorDataN_BarY()

double WsfESA_AntennaPattern::GetTaylorDataN_BarY ( ) const

inline

◆ GetTaylorDataSidelobeLevelX()

double WsfESA_AntennaPattern::GetTaylorDataSidelobeLevelX ( ) const

inline

◆ GetTaylorDataSidelobeLevelY()

double WsfESA_AntennaPattern::GetTaylorDataSidelobeLevelY ( ) const

inline

◆ Initialize()

bool WsfESA_AntennaPattern::Initialize ( WsfSimulation * aSimulationPtr )

overridevirtual

Initialize the antenna pattern. This is called after all the input for an antenna pattern has been processed.

Returns: true if successful or false if not.

Reimplemented from WsfAntennaPattern.

Reimplemented in WsfESA_NX_AntennaPattern.

References AdjustApertureElements(), WsfObjectTypeList< T >::Clone(), WsfAntennaPatternTypes::Get(), WsfSimulation::GetRandom(), WsfSimulation::GetScenario(), WsfObject::GetType(), WsfAntennaPattern::Initialize(), mApertureEff, mApertureEffX, mApertureEffY, mElementPatternPtr, and ok.

Referenced by WsfESA_AntennaPattern().

◆ IsDistributionTaylor()

bool WsfESA_AntennaPattern::IsDistributionTaylor ( ) const

inline

References cWT_Taylor.

◆ IsDistributionUniform()

bool WsfESA_AntennaPattern::IsDistributionUniform ( ) const

inline

References cWT_Uniform.

◆ ObjectFactory()

WsfAntennaPattern * WsfESA_AntennaPattern::ObjectFactory ( const std::string & aTypeName )

static

Factory method for WsfAntennaPatternTypes. This is called by WsfAntennaPatternTypes::LoadType to determine if a pattern represented by this class is being requested.

References WsfAntennaPattern::WsfAntennaPattern(), and WsfESA_AntennaPattern().

Referenced by WsfMilExtension::AddedToScenario().

◆ operator=()

WsfESA_AntennaPattern & WsfESA_AntennaPattern::operator= ( const WsfESA_AntennaPattern & aRhs )

protecteddelete

Assignment is not supported.

References WsfESA_AntennaPattern().

◆ ResizeArray()

void WsfESA_AntennaPattern::ResizeArray ( )

protectedvirtual

Reimplemented in WsfESA_NX_AntennaPattern.

References mLengthX, mLengthY, mNX, and mNY.

Referenced by AdjustApertureElements().

◆ SetESA_DataPtr()

void WsfESA_AntennaPattern::SetESA_DataPtr ( ESA_Data * aESA_DataPtr )

inlineprotected

Member Data Documentation

◆ mApertureEff

double WsfESA_AntennaPattern::mApertureEff

protected

Referenced by WsfElementESA_AntennaPattern::ComputeDirectivityGain(), ComputeDirectivityGain(), ComputeElementFactor(), WsfElementESA_AntennaPattern::Initialize(), Initialize(), WsfESA_NX_AntennaPattern::Initialize(), WsfElementESA_AntennaPattern::ProcessInput(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

◆ mApertureEffX

double WsfESA_AntennaPattern::mApertureEffX

protected

Referenced by GetAzimuthBeamwidth(), WsfElementESA_AntennaPattern::Initialize(), Initialize(), WsfESA_NX_AntennaPattern::Initialize(), WsfElementESA_AntennaPattern::ProcessInput(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

◆ mApertureEffY

double WsfESA_AntennaPattern::mApertureEffY

protected

Referenced by GetElevationBeamwidth(), WsfElementESA_AntennaPattern::Initialize(), Initialize(), WsfESA_NX_AntennaPattern::Initialize(), WsfElementESA_AntennaPattern::ProcessInput(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

◆ mElementPatternPtr

WsfAntennaPattern* WsfESA_AntennaPattern::mElementPatternPtr

protected

Referenced by ComputeElementGain(), Initialize(), WsfESA_AntennaPattern(), WsfESA_AntennaPattern(), and ~WsfESA_AntennaPattern().

◆ mElements

ElementVec WsfESA_AntennaPattern::mElements

protected

Current vector of elements used for pattern calculations.

Referenced by AdjustApertureElements(), AdjustElementLocations(), WsfESA_NX_AntennaPattern::AdjustElementLocations(), WsfElementESA_AntennaPattern::ComputeElementGain(), ComputeElementGain(), ComputeFailedModulesWeights(), WsfElementESA_AntennaPattern::ProcessInput(), WsfElementESA_AntennaPattern::WsfElementESA_AntennaPattern(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

◆ mLengthX

double WsfESA_AntennaPattern::mLengthX

protected

Current X-axis length of the array in meters.

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

◆ mLengthY

double WsfESA_AntennaPattern::mLengthY

protected

Current Y-axis length of the array in meters.

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

◆ mNX

int WsfESA_AntennaPattern::mNX

protected

Current X-axis number of elements.

Referenced by AdjustApertureElements(), AdjustElementLocations(), WsfESA_NX_AntennaPattern::AdjustElementLocations(), WsfElementESA_AntennaPattern::ComputeDirectivityGain(), ComputeDirectivityGain(), WsfElementESA_AntennaPattern::ComputeElementGain(), ComputeElementGain(), ComputeFailedModulesWeights(), GetAzimuthBeamwidth(), WsfElementESA_AntennaPattern::Initialize(), ResizeArray(), WsfESA_NX_AntennaPattern::ResizeArray(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

◆ mNY

int WsfESA_AntennaPattern::mNY

protected

Current Y-axis number of elements.

Referenced by AdjustApertureElements(), AdjustElementLocations(), WsfESA_NX_AntennaPattern::AdjustElementLocations(), WsfElementESA_AntennaPattern::ComputeDirectivityGain(), ComputeDirectivityGain(), WsfElementESA_AntennaPattern::ComputeElementGain(), ComputeElementGain(), ComputeFailedModulesWeights(), GetElevationBeamwidth(), WsfElementESA_AntennaPattern::Initialize(), ResizeArray(), WsfESA_NX_AntennaPattern::ResizeArray(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

◆ mWeightVecX

WeightVec WsfESA_AntennaPattern::mWeightVecX

protected

Referenced by AdjustApertureElements(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

◆ mWeightVecY

WeightVec WsfESA_AntennaPattern::mWeightVecY

protected

Calculated aperture efficiency.

Referenced by AdjustApertureElements(), WsfESA_AntennaPattern(), and WsfESA_AntennaPattern().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Current ESA data

Private data access.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ElementVec

◆ WeightVec

Member Enumeration Documentation

◆ LatticeType

◆ WeightingFun

Constructor & Destructor Documentation

◆ WsfESA_AntennaPattern() [1/2]

◆ ~WsfESA_AntennaPattern()

◆ WsfESA_AntennaPattern() [2/2]

Member Function Documentation

◆ AdjustApertureElements()

◆ AdjustElementLocations()

◆ Clone()

◆ ComputeDirectivityGain()

◆ ComputeElementFactor()

◆ ComputeElementGain()

◆ ComputeFailedModulesWeights()

◆ GetAmpNumBits()

◆ GetAzimuthBeamwidth()

◆ GetData()

◆ GetElementSpacingX()

◆ GetElementSpacingY()

◆ GetElevationBeamwidth()

◆ GetGain()

◆ GetNumberElementsX()

◆ GetNumberElementsY()

◆ GetPeakGain()

◆ GetPhaseNumBits()

◆ GetTaylorDataN_BarX()

◆ GetTaylorDataN_BarY()

◆ GetTaylorDataSidelobeLevelX()

◆ GetTaylorDataSidelobeLevelY()

◆ Initialize()

◆ IsDistributionTaylor()

◆ IsDistributionUniform()

◆ ObjectFactory()

◆ operator=()

◆ ResizeArray()

◆ SetESA_DataPtr()

Member Data Documentation

◆ mApertureEff

◆ mApertureEffX

◆ mApertureEffY

◆ mElementPatternPtr

◆ mElements

◆ mLengthX

◆ mLengthY

◆ mNX

◆ mNY

◆ mWeightVecX

◆ mWeightVecY