#include <WsfGENAP_AntennaPattern.hpp>

Inheritance diagram for WsfGENAP_AntennaPattern:

[legend]

Collaboration diagram for WsfGENAP_AntennaPattern:

[legend]

Classes
class	GENAP_Data
	Data that is shared amongst all instances of a given ALARM antenna pattern. More...

Public Types
enum	Distribution { cDF_UNKNOWN = 0 , cDF_UNIFORM = 1 , cDF_COSINE = 3 , cDF_COSECANT = 11 , cDF_BW_SLL = 13 }
	Illumination distribution function. More...
enum	BlockageShape { cBS_NONE = 0 , cBS_ELLIPTICAL = 1 , cBS_RECTANGULAR = 2 , cBS_DIAMOND = 3 }
	aperture blockage shape More...
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.

Public Member Functions
	WsfGENAP_AntennaPattern ()
WsfAntennaPattern *	Clone () const override
bool	ProcessInput (UtInput &aInput) 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 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
const char *	GetScriptClassName () const override
virtual double	GetGain (double aFrequency, double aTargetAz, double aTargetEl, double aEBS_Az, double aEBS_El)
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)
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)

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!
ApertureShape	GetApertureShape () const override
Distribution	GetAzDistribution () const
Distribution	GetElDistribution () const
double	GetAzExponent () const
double	GetElExponent () const
double	GetElCosecantLimit () const
double	GetAzSidelobeLevelInput () const
double	GetElSidelobeLevelInput () const
	WsfGENAP_AntennaPattern (const WsfGENAP_AntennaPattern &aSrc)=default
WsfGENAP_AntennaPattern	operator= (const WsfGENAP_AntennaPattern &aRhs) const
	Assignment is not supported.

Additional Inherited Members
Static Public Attributes inherited from WsfAntennaPattern
static const char *	cTYPE_KIND = "antenna_pattern"
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 inherited from WsfAntennaPattern
BaseData *	mSharedDataPtr

Detailed Description

A class that implements an interface to the GENeralized Antenna Pattern (GENAP) generator from SUPPRESSOR 6.0.

The GENeralized Antenna Pattern generator in SUPPRESSOR 6.0 is an interface to a subset of the capabilities that exist in Technical Radar Analysis and Modeling System (TRAMS).

Note: This class populates data for the base class WsfALARM_AntennaPattern which performs the actual interpolation of the data.; The interface is only available if WSF_WITH_GENAP=1 defined. The real genap.f is not supplied with the standard WSF distribution because it has not been determined if it is government limited distribution.

Member Enumeration Documentation

◆ BlockageShape

enum WsfGENAP_AntennaPattern::BlockageShape

aperture blockage shape

Enumerator
cBS_NONE
cBS_ELLIPTICAL
cBS_RECTANGULAR
cBS_DIAMOND

◆ Distribution

enum WsfGENAP_AntennaPattern::Distribution

Illumination distribution function.

Enumerator
cDF_UNKNOWN
cDF_UNIFORM
cDF_COSINE
cDF_COSECANT
cDF_BW_SLL

Constructor & Destructor Documentation

◆ WsfGENAP_AntennaPattern() [1/2]

WsfGENAP_AntennaPattern::WsfGENAP_AntennaPattern ( )

References WsfALARM_AntennaPattern::WsfALARM_AntennaPattern().

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

◆ WsfGENAP_AntennaPattern() [2/2]

WsfGENAP_AntennaPattern::WsfGENAP_AntennaPattern ( const WsfGENAP_AntennaPattern & aSrc )

protecteddefault

References WsfGENAP_AntennaPattern().

Member Function Documentation

◆ Clone()

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

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

◆ GetApertureShape()

ApertureShape WsfGENAP_AntennaPattern::GetApertureShape ( ) const

inlineoverridevirtual

Reimplemented from WsfALARM_AntennaPattern.

◆ GetAzDistribution()

Distribution WsfGENAP_AntennaPattern::GetAzDistribution ( ) const

inline

◆ GetAzExponent()

double WsfGENAP_AntennaPattern::GetAzExponent ( ) const

inline

◆ GetAzSidelobeLevelInput()

double WsfGENAP_AntennaPattern::GetAzSidelobeLevelInput ( ) const

inline

◆ GetElCosecantLimit()

double WsfGENAP_AntennaPattern::GetElCosecantLimit ( ) const

inline

◆ GetElDistribution()

Distribution WsfGENAP_AntennaPattern::GetElDistribution ( ) const

inline

◆ GetElExponent()

double WsfGENAP_AntennaPattern::GetElExponent ( ) const

inline

◆ GetElSidelobeLevelInput()

double WsfGENAP_AntennaPattern::GetElSidelobeLevelInput ( ) const

inline

◆ ObjectFactory()

WsfAntennaPattern * WsfGENAP_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 WsfGENAP_AntennaPattern().

◆ operator=()

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

protected

Assignment is not supported.

References WsfAntennaPattern::mSharedDataPtr, and WsfGENAP_AntennaPattern().

◆ ProcessInput()

bool WsfGENAP_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 WsfAntennaPattern::ProcessInput().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private data access.

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BlockageShape

◆ Distribution

Constructor & Destructor Documentation

◆ WsfGENAP_AntennaPattern() [1/2]

◆ WsfGENAP_AntennaPattern() [2/2]

Member Function Documentation

◆ Clone()

◆ GetApertureShape()

◆ GetAzDistribution()

◆ GetAzExponent()

◆ GetAzSidelobeLevelInput()

◆ GetElCosecantLimit()

◆ GetElDistribution()

◆ GetElExponent()

◆ GetElSidelobeLevelInput()

◆ ObjectFactory()

◆ operator=()

◆ ProcessInput()