#include <WsfEquatorialFieldOfView.hpp>

Inheritance diagram for WsfEquatorialFieldOfView:

Collaboration diagram for WsfEquatorialFieldOfView:

Public Member Functions
	WsfEquatorialFieldOfView ()
bool	operator== (const WsfEquatorialFieldOfView &aRhs) const
bool	operator!= (const WsfEquatorialFieldOfView &aRhs) const
bool	ProcessInput (UtInput &aInput) override
const char *	GetScriptClassName () const override
WsfFieldOfView *	Clone () const override
bool	GetCuedAzElPlatformLat (double &aCuedAz, double &aCuedEl, double &aPlatformLatDeg) const
void	GetEquatorialFieldOfView (double &aMinEqFOV, double &aMaxEqFOV) const
void	GetPolarFieldOfView (double &aMinPolarFOV, double &aMaxPolarFOV) const
void	SetEquatorialFieldOfView (double aMinEqFOV, double aMaxEqFOV)
void	SetPolarFieldOfView (double aMinPolarFOV, double aMaxPolarFOV)
bool	WithinFieldOfView (double aThisToTgtAz, double aThisToTgtEl) override
bool	WithinFieldOfView (double aThisToTgtAz, double aThisToTgtEl, double aCuedAz, double aCuedEl, double aLatitude) const
Public Member Functions inherited from WsfFieldOfView
virtual bool	Initialize (const WsfArticulatedPart &aArticulatedPart)
const char *	GetScriptClassName () const override
virtual bool	WithinFieldOfView (WsfArticulatedPart *aArticulatedPart, double aTgtLocWCS[3], double aEarthRadiusMultiplier, double &aTrueThisToTgtAz, double &aTrueThisToTgtEl, double aApparentThisToTgtLocWCS[3], double &aApparentThisToTgtAz, double &aApparentThisToTgtEl, double aApparentTgtToThisLocWCS[3])
	Compute azimuth and elevation of the target and determine if it is within the field of view.
virtual bool	WithinFieldOfView (WsfEM_Antenna *aAntennaPtr, double aTgtLocWCS[3], double aEarthRadiusMultiplier, double &aTrueThisToTgtAz, double &aTrueThisToTgtEl, double aApparentThisToTgtLocWCS[3], double &aApparentThisToTgtAz, double &aApparentThisToTgtEl, double aApparentTgtToThisLocWCS[3])
	Compute azimuth and elevation of the target and determine if it is within the field of view.
virtual bool	GetAzimuthFieldOfView (double &aMinAzFOV, double &aMaxAzFOV) const
virtual bool	GetElevationFieldOfView (double &aMinElFOV, double &aMaxElFOV) const
virtual bool	SetAzimuthFieldOfView (double aMinAzFOV, double aMaxAzFOV)
virtual bool	SetElevationFieldOfView (double aMinElFOV, double aMaxElFOV)
const WsfStringId &	GetType () const

Additional Inherited Members
void	SetType (const WsfStringId &aType)
	Set the type corresponding with the type of derived class.
const WsfArticulatedPart *	GetArticulatedPart () const

Detailed Description

A field of view with azimuth-polar (can also be thought roughly of as latitude-longitude) extents with equator oriented to match Earth's projected equator.

Constructor & Destructor Documentation

◆ WsfEquatorialFieldOfView()

WsfEquatorialFieldOfView::WsfEquatorialFieldOfView ( )

References WsfFieldOfView::SetType().

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

Member Function Documentation

◆ Clone()

WsfFieldOfView * WsfEquatorialFieldOfView::Clone ( ) const

inlineoverridevirtual

Make a copy of this object.

Returns: The copy of "this" object.

Implements WsfFieldOfView.

References WsfEquatorialFieldOfView().

◆ GetCuedAzElPlatformLat()

bool WsfEquatorialFieldOfView::GetCuedAzElPlatformLat	(	double &	aCuedAz,
		double &	aCuedEl,
		double &	aPlatformLatDeg ) const

Obtain the cued azimuth/elevation and the location latitude of the associated platform.

Parameters

aCuedAz	[output] Cued azimuth (radians).
aCuedEl	[output] Cued elevation (radians).
aPlatformLatDeg	[output] Latitude of the platform's location (degrees).

Returns: 'true' if successful in obtaining the values or 'false' if not.

References WsfFieldOfView::GetArticulatedPart(), and WsfPlatformPart::GetPlatform().

Referenced by WithinFieldOfView().

◆ GetEquatorialFieldOfView()

void WsfEquatorialFieldOfView::GetEquatorialFieldOfView	(	double &	aMinEqFOV,
		double &	aMaxEqFOV ) const

Obtain the field of view range along the equatorial axis.

Parameters

aMinEqFOV	[output] Minimum of the range. (radians).
aMaxEqFOV	[output] Maximum of the range (radians).

◆ GetPolarFieldOfView()

void WsfEquatorialFieldOfView::GetPolarFieldOfView	(	double &	aMinPolarFOV,
		double &	aMaxPolarFOV ) const

Obtain the field of view range along the polar axis.

Parameters

aMinPolarFOV	[output] Minimum of the range. (radians).
aMaxPolarFOV	[output] Maximum of the range (radians).

◆ GetScriptClassName()

const char * WsfEquatorialFieldOfView::GetScriptClassName ( ) const

inlineoverride

◆ operator!=()

bool WsfEquatorialFieldOfView::operator!= ( const WsfEquatorialFieldOfView & aRhs ) const

References WsfEquatorialFieldOfView().

◆ operator==()

bool WsfEquatorialFieldOfView::operator== ( const WsfEquatorialFieldOfView & aRhs ) const

References WsfEquatorialFieldOfView().

◆ ProcessInput()

bool WsfEquatorialFieldOfView::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from an input object.

Parameters

aInput The input source.

Returns: Whether the current input commands were processed in this method.

Reimplemented from WsfFieldOfView.

◆ SetEquatorialFieldOfView()

void WsfEquatorialFieldOfView::SetEquatorialFieldOfView	(	double	aMinEqFOV,
		double	aMaxEqFOV )

Set the field of view range along the equatorial axis.

Parameters

aMinEqFOV	[input] Minimum of the range. (radians).
aMaxEqFOV	[input] Maximum of the range (radians).

◆ SetPolarFieldOfView()

void WsfEquatorialFieldOfView::SetPolarFieldOfView	(	double	aMinPolarFOV,
		double	aMaxPolarFOV )

Set the field of view range along the polar axis.

Parameters

aMinPolarFOV	[input] Minimum of the range. (radians).
aMaxPolarFOV	[input] Maximum of the range (radians).

◆ WithinFieldOfView() [1/2]

bool WsfEquatorialFieldOfView::WithinFieldOfView	(	double	aThisToTgtAz,
		double	aThisToTgtEl )

overridevirtual

Is the target within the field-of-view?

Parameters

aThisToTgtAz	[input] Azimuth of the target with respect to the device (radians).
aThisToTgtEl	[input] Elevation of the target with respect to the device (radians).

Returns: 'true' if within the field of view or 'false' if not.

Implements WsfFieldOfView.

References GetCuedAzElPlatformLat(), and WithinFieldOfView().

Referenced by WithinFieldOfView().

◆ WithinFieldOfView() [2/2]

bool WsfEquatorialFieldOfView::WithinFieldOfView	(	double	aThisToTgtAz,
		double	aThisToTgtEl,
		double	aCuedAz,
		double	aCuedEl,
		double	aLatitude ) const

Is the target within the field of view?

Parameters

aThisToTgtAz	[input] Azimuth of the target with respect to the device (radians).
aThisToTgtEl	[input] Elevation of the target with respect to the device (radians).
aCuedAz	[input] Cued azimuth of the device (radians).
aCuedEl	[input] Cued elevation of the device (radians).
aLatitude	[input] Latitude of the device's location (degrees).

Returns: 'true' if within the field of view or 'false' if not.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfEquatorialFieldOfView()

Member Function Documentation

◆ Clone()

◆ GetCuedAzElPlatformLat()

◆ GetEquatorialFieldOfView()

◆ GetPolarFieldOfView()

◆ GetScriptClassName()

◆ operator!=()

◆ operator==()

◆ ProcessInput()

◆ SetEquatorialFieldOfView()

◆ SetPolarFieldOfView()

◆ WithinFieldOfView() [1/2]

◆ WithinFieldOfView() [2/2]