#include <WsfALARM_AntennaPatternBanded.hpp>

Inheritance diagram for WsfALARM_AntennaPatternBanded:

[legend]

Collaboration diagram for WsfALARM_AntennaPatternBanded:

[legend]

Public Member Functions
	WsfALARM_AntennaPatternBanded ()
	~WsfALARM_AntennaPatternBanded () override=default
WsfAntennaPattern *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
double	GetGain (double aFrequency, double aTargetAz, double aTargetEl, double aEBS_Az, double aEBS_El) override
Public Member Functions inherited from WsfALARM_AntennaPattern
	WsfALARM_AntennaPattern (ALARM_Data *aBaseDataPtr)
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
virtual const std::vector< double > &	GetAzAngles () const
virtual const std::vector< double > &	GetAzGains () const
virtual const std::vector< double > &	GetElAngles () const
virtual const std::vector< double > &	GetElGains () const
virtual ApertureShape	GetApertureShape () const
virtual double	GetMinGain () const
virtual double	GetGainCorrection () const
virtual double	GetInputAzimuthBeamwidth () const
virtual double	GetInputElevationBeamwidth () const
Public Member Functions inherited from WsfAntennaPattern
	WsfAntennaPattern ()
	WsfAntennaPattern (BaseData *aBasePtr)
	~WsfAntennaPattern () override
WsfAntennaPattern *	Clone () const 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 bool	Initialize (WsfSimulation *aSimulationPtr)
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)
Static Public Member Functions inherited from WsfALARM_AntennaPattern
static WsfAntennaPattern *	ObjectFactory (const std::string &aTypeName)

Protected Member Functions
	WsfALARM_AntennaPatternBanded (const WsfALARM_AntennaPatternBanded &aSrc)=default
WsfALARM_AntennaPatternBanded &	operator= (const WsfALARM_AntennaPatternBanded &aRhs)=delete
ALARM_Data *	AlarmData () const
	WsfALARM_AntennaPattern (const WsfALARM_AntennaPattern &aSrc)=default
WsfALARM_AntennaPattern	operator= (const WsfALARM_AntennaPattern &aRhs) const =delete
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()).

Protected Attributes
double	mMaxElevationRad
Protected Attributes inherited from WsfAntennaPattern
BaseData *	mSharedDataPtr

Additional Inherited Members
Public Types inherited from WsfALARM_AntennaPattern
enum	ApertureShape { cAS_UNKNOWN = 0 , cAS_CIRCULAR = 1 , cAS_ELLIPTICAL = 2 , cAS_RECTANGULAR = 3 , cAS_SQUARE = 4 }
using	Table = std::vector<double>
using	TableIndex = std::vector<double>::size_type
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Static Public Attributes inherited from WsfAntennaPattern
static const char *	cTYPE_KIND = "antenna_pattern"

Detailed Description

This class works with a propagation table to prevent double-counting, or reapply any antenna effects that already rolled into the propagation table. Simply said, when the propagation table is in its usable range and being applied, this class returns its maximum gain for the given antenna. Otherwise, the returned gain is the actual/normal gain.

Constructor & Destructor Documentation

◆ WsfALARM_AntennaPatternBanded() [1/2]

WsfALARM_AntennaPatternBanded::WsfALARM_AntennaPatternBanded ( )

References mMaxElevationRad, and WsfALARM_AntennaPattern::WsfALARM_AntennaPattern().

Referenced by Clone(), ObjectFactory(), operator=(), and WsfALARM_AntennaPatternBanded().

◆ ~WsfALARM_AntennaPatternBanded()

WsfALARM_AntennaPatternBanded::~WsfALARM_AntennaPatternBanded ( )

overridedefault

References WsfAntennaPattern::WsfAntennaPattern().

◆ WsfALARM_AntennaPatternBanded() [2/2]

WsfALARM_AntennaPatternBanded::WsfALARM_AntennaPatternBanded ( const WsfALARM_AntennaPatternBanded & aSrc )

protecteddefault

References WsfALARM_AntennaPatternBanded().

Member Function Documentation

◆ Clone()

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

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

◆ GetGain()

double WsfALARM_AntennaPatternBanded::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.

References WsfAntennaPattern::GetGain(), and mMaxElevationRad.

◆ ObjectFactory()

WsfAntennaPattern * WsfALARM_AntennaPatternBanded::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 WsfALARM_AntennaPatternBanded(), and WsfAntennaPattern::WsfAntennaPattern().

◆ operator=()

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

protecteddelete

References WsfALARM_AntennaPatternBanded().

◆ ProcessInput()

bool WsfALARM_AntennaPatternBanded::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 WsfObject.

References mMaxElevationRad, and WsfAntennaPattern::ProcessInput().

Member Data Documentation

◆ mMaxElevationRad

double WsfALARM_AntennaPatternBanded::mMaxElevationRad

protected

Referenced by GetGain(), ProcessInput(), and WsfALARM_AntennaPatternBanded().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfALARM_AntennaPatternBanded() [1/2]

◆ ~WsfALARM_AntennaPatternBanded()

◆ WsfALARM_AntennaPatternBanded() [2/2]

Member Function Documentation

◆ Clone()

◆ GetGain()

◆ ObjectFactory()

◆ operator=()

◆ ProcessInput()

Member Data Documentation

◆ mMaxElevationRad