#include <WsfElementESA_AntennaPattern.hpp>

Inheritance diagram for WsfElementESA_AntennaPattern:

[legend]

Collaboration diagram for WsfElementESA_AntennaPattern:

[legend]

Classes
class	EESA_Data

Public Types
using	ElementLocXY = std::vector<UtVec2d>
using	WeightVec = std::vector<double>
Public Types inherited from WsfESA_AntennaPattern
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
	WsfElementESA_AntennaPattern ()
	~WsfElementESA_AntennaPattern () override=default
WsfAntennaPattern *	Clone () const override
bool	Initialize (WsfSimulation *aSimulationPtr) override
bool	ProcessInput (UtInput &aInput) override
Public Member Functions inherited from WsfESA_AntennaPattern
	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
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
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
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)
Static Public Member Functions inherited from WsfESA_AntennaPattern
static WsfAntennaPattern *	ObjectFactory (const std::string &aTypeName)

Protected Member Functions
	WsfElementESA_AntennaPattern (const WsfElementESA_AntennaPattern &aSrc)
WsfElementESA_AntennaPattern &	operator= (const WsfElementESA_AntennaPattern &aRhs)=delete
	Assignment is not supported.
double	ComputeElementGain (double aFrequency, double aAzAngle, double aElAngle) const override
double	ComputeDirectivityGain (double aFrequency, double aEBS_Az, double aEBS_El) const override
EESA_Data *	GetEESA_Data () 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	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)
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()).

Additional Inherited Members
Static Public Attributes inherited from WsfAntennaPattern
static const char *	cTYPE_KIND = "antenna_pattern"
Protected Attributes inherited from WsfESA_AntennaPattern
WeightVec	mWeightVecX
WeightVec	mWeightVecY
	Calculated aperture efficiency.
double	mApertureEff
double	mApertureEffX
double	mApertureEffY
WsfAntennaPattern *	mElementPatternPtr
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.
Protected Attributes inherited from WsfAntennaPattern
BaseData *	mSharedDataPtr

Detailed Description

The implementation of an 'Element-Wise (user-defined elements) Electronically Scanned Array (ESA)' antenna patterns.

This ESA antenna pattern extends the base ESA pattern by allowing the elements to be located by the user via an input table. Although not perfect for non-uniformed arrays it does allow for more precisely modeling other than rectangular ESA patterns, as limited by the base ESA pattern class.

Adaption from Skolnik 2nd edition adding in third dimension making it non-exportable.

Member Typedef Documentation

◆ ElementLocXY

using WsfElementESA_AntennaPattern::ElementLocXY = std::vector<UtVec2d>

◆ WeightVec

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

Constructor & Destructor Documentation

◆ WsfElementESA_AntennaPattern() [1/2]

WsfElementESA_AntennaPattern::WsfElementESA_AntennaPattern ( )

References WsfESA_AntennaPattern::WsfESA_AntennaPattern().

Referenced by Clone(), ObjectFactory(), operator=(), WsfElementESA_AntennaPattern(), and ~WsfElementESA_AntennaPattern().

◆ ~WsfElementESA_AntennaPattern()

WsfElementESA_AntennaPattern::~WsfElementESA_AntennaPattern ( )

overridedefault

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

◆ WsfElementESA_AntennaPattern() [2/2]

WsfElementESA_AntennaPattern::WsfElementESA_AntennaPattern ( const WsfElementESA_AntennaPattern & aSrc )

protected

References WsfESA_AntennaPattern::mElements, WsfElementESA_AntennaPattern(), and WsfESA_AntennaPattern::WsfESA_AntennaPattern().

Member Function Documentation

◆ Clone()

WsfAntennaPattern * WsfElementESA_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.

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

◆ ComputeDirectivityGain()

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

overrideprotectedvirtual

Reimplemented from WsfESA_AntennaPattern.

References GetEESA_Data(), WsfESA_AntennaPattern::mApertureEff, WsfESA_AntennaPattern::ESA_Data::mdX, WsfESA_AntennaPattern::ESA_Data::mdY, WsfESA_AntennaPattern::mNX, and WsfESA_AntennaPattern::mNY.

◆ ComputeElementGain()

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

overrideprotectedvirtual

Reimplemented from WsfESA_AntennaPattern.

References WsfESA_AntennaPattern::mElements, WsfESA_AntennaPattern::mNX, WsfESA_AntennaPattern::mNY, and WsfAntennaPattern::mSharedDataPtr.

◆ GetEESA_Data()

EESA_Data * WsfElementESA_AntennaPattern::GetEESA_Data ( ) const

inlineprotected

References WsfESA_AntennaPattern::GetData().

Referenced by ComputeDirectivityGain(), and Initialize().

◆ Initialize()

bool WsfElementESA_AntennaPattern::Initialize ( WsfSimulation * aSimulationPtr )

overridevirtual

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

Parameters

aSimulationPtr A pointer to the simulation if this antenna pattern is going to be used in a simulation may be null to perform quick checks after inputs are read

Returns: true if successful or false if not.

Reimplemented from WsfAntennaPattern.

◆ ObjectFactory()

WsfAntennaPattern * WsfElementESA_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 WsfElementESA_AntennaPattern().

◆ operator=()

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

protecteddelete

Assignment is not supported.

References WsfElementESA_AntennaPattern().

◆ ProcessInput()

bool WsfElementESA_AntennaPattern::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

aInput a 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 WsfAntennaPattern.

References WsfESA_AntennaPattern::mApertureEff, WsfESA_AntennaPattern::mApertureEffX, WsfESA_AntennaPattern::mApertureEffY, WsfESA_AntennaPattern::mElements, WsfESA_AntennaPattern::Element::mLocation, WsfESA_AntennaPattern::Element::mNormal, WsfESA_AntennaPattern::Element::mWeight, and WsfAntennaPattern::ProcessInput().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ElementLocXY

◆ WeightVec

Constructor & Destructor Documentation

◆ WsfElementESA_AntennaPattern() [1/2]

◆ ~WsfElementESA_AntennaPattern()

◆ WsfElementESA_AntennaPattern() [2/2]

Member Function Documentation

◆ Clone()

◆ ComputeDirectivityGain()

◆ ComputeElementGain()

◆ GetEESA_Data()

◆ Initialize()

◆ ObjectFactory()

◆ operator=()

◆ ProcessInput()