#include <WsfStandardAntennaPattern.hpp>

Inheritance diagram for WsfStandardAntennaPattern:

[legend]

Collaboration diagram for WsfStandardAntennaPattern:

[legend]

Classes
class	StandardData

Public Types
enum	PatternType { cUNKNOWN , cTABLE , cCIRCULAR_PATTERN , cCOSECANT_SQUARED_PATTERN , cSINE_PATTERN , cUNIFORM_PATTERN }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfStandardAntennaPattern ()
WsfStandardAntennaPattern &	operator= (const WsfStandardAntennaPattern &aRhs)=delete
	~WsfStandardAntennaPattern () override
WsfAntennaPattern *	Clone () const 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
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)

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	GetSineAngleModificationFactor () const
int	GetSineFunctionType () const
int	GetStandardPatternType () const
UtAzElTable *	GetUtAzElTable () const
double	GetCscMinElForPeakGain () const
double	GetCscElOfPeakCsc2Boundary () const
double	GetCscMaxElForCsc2 () const
virtual double	GetInputAzimuthBeamwidth () const
virtual double	GetInputElevationBeamwidth () const
StandardData *	GetStandardData () const
	WsfStandardAntennaPattern (const WsfStandardAntennaPattern &aSrc)

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()).
Protected Attributes inherited from WsfAntennaPattern
BaseData *	mSharedDataPtr

Detailed Description

The implementation of 'standard' antenna patterns.

The class provides an implementation for several common antenna patterns

sin x/x circular aperture
sin x/x elliptical and rectangular aperture
uniform or constant
an inline or external table of gain vs. az/el.

Member Enumeration Documentation

◆ PatternType

enum WsfStandardAntennaPattern::PatternType

Enumerator
cUNKNOWN
cTABLE
cCIRCULAR_PATTERN
cCOSECANT_SQUARED_PATTERN
cSINE_PATTERN
cUNIFORM_PATTERN

Constructor & Destructor Documentation

◆ WsfStandardAntennaPattern() [1/2]

WsfStandardAntennaPattern::WsfStandardAntennaPattern ( )

References WsfAntennaPattern::WsfAntennaPattern().

Referenced by Clone(), operator=(), and WsfStandardAntennaPattern().

◆ ~WsfStandardAntennaPattern()

WsfStandardAntennaPattern::~WsfStandardAntennaPattern ( )

override

◆ WsfStandardAntennaPattern() [2/2]

WsfStandardAntennaPattern::WsfStandardAntennaPattern ( const WsfStandardAntennaPattern & aSrc )

protected

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

Member Function Documentation

◆ Clone()

WsfAntennaPattern * WsfStandardAntennaPattern::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 WsfStandardAntennaPattern().

◆ GetAzimuthBeamwidth()

double WsfStandardAntennaPattern::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(), and GetStandardData().

◆ GetCscElOfPeakCsc2Boundary()

double WsfStandardAntennaPattern::GetCscElOfPeakCsc2Boundary ( ) const

inline

References GetStandardData().

◆ GetCscMaxElForCsc2()

double WsfStandardAntennaPattern::GetCscMaxElForCsc2 ( ) const

inline

References GetStandardData().

◆ GetCscMinElForPeakGain()

double WsfStandardAntennaPattern::GetCscMinElForPeakGain ( ) const

inline

References GetStandardData().

◆ GetElevationBeamwidth()

double WsfStandardAntennaPattern::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(), and GetStandardData().

◆ GetGain()

double WsfStandardAntennaPattern::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 WsfStandardAntennaPattern::StandardData::GetGain(), and GetStandardData().

◆ GetInputAzimuthBeamwidth()

virtual double WsfStandardAntennaPattern::GetInputAzimuthBeamwidth ( ) const

inlinevirtual

References GetStandardData().

◆ GetInputElevationBeamwidth()

virtual double WsfStandardAntennaPattern::GetInputElevationBeamwidth ( ) const

inlinevirtual

References GetStandardData().

◆ GetPeakGain()

double WsfStandardAntennaPattern::GetPeakGain ( double aFrequency ) const

overridevirtual

Return the peak 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.

References GetStandardData(), and WsfAntennaPattern::BaseData::PerformGainAdjustment().

◆ GetSineAngleModificationFactor()

double WsfStandardAntennaPattern::GetSineAngleModificationFactor ( ) const

inline

References GetStandardData().

◆ GetSineFunctionType()

int WsfStandardAntennaPattern::GetSineFunctionType ( ) const

inline

References GetStandardData().

◆ GetStandardData()

StandardData * WsfStandardAntennaPattern::GetStandardData ( ) const

inline

References WsfAntennaPattern::mSharedDataPtr.

Referenced by GetAzimuthBeamwidth(), GetCscElOfPeakCsc2Boundary(), GetCscMaxElForCsc2(), GetCscMinElForPeakGain(), GetElevationBeamwidth(), GetGain(), GetInputAzimuthBeamwidth(), GetInputElevationBeamwidth(), GetPeakGain(), GetSineAngleModificationFactor(), GetSineFunctionType(), GetStandardPatternType(), and GetUtAzElTable().

◆ GetStandardPatternType()

int WsfStandardAntennaPattern::GetStandardPatternType ( ) const

inline

References GetStandardData().

◆ GetUtAzElTable()

UtAzElTable * WsfStandardAntennaPattern::GetUtAzElTable ( ) const

inline

References GetStandardData().

◆ operator=()

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

delete

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

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

Classes

Public Types

Public Member Functions

Private data access.

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PatternType

Constructor & Destructor Documentation

◆ WsfStandardAntennaPattern() [1/2]

◆ ~WsfStandardAntennaPattern()

◆ WsfStandardAntennaPattern() [2/2]

Member Function Documentation

◆ Clone()

◆ GetAzimuthBeamwidth()

◆ GetCscElOfPeakCsc2Boundary()

◆ GetCscMaxElForCsc2()

◆ GetCscMinElForPeakGain()

◆ GetElevationBeamwidth()

◆ GetGain()

◆ GetInputAzimuthBeamwidth()

◆ GetInputElevationBeamwidth()

◆ GetPeakGain()

◆ GetSineAngleModificationFactor()

◆ GetSineFunctionType()

◆ GetStandardData()

◆ GetStandardPatternType()

◆ GetUtAzElTable()

◆ operator=()