WsfRectangularFieldOfView Class Reference

A field of view with rectangular az-el extents. More...

#include <WsfRectangularFieldOfView.hpp>

Inheritance diagram for WsfRectangularFieldOfView:

Collaboration diagram for WsfRectangularFieldOfView:

Public Member Functions
	WsfRectangularFieldOfView ()
bool	operator== (const WsfRectangularFieldOfView &aRhs) const
bool	operator!= (const WsfRectangularFieldOfView &aRhs) const
bool	ProcessInput (UtInput &aInput) override
const char *	GetScriptClassName () const override
WsfFieldOfView *	Clone () const override
bool	WithinFieldOfView (double aThisToTgtAz, double aThisToTgtEl) override
bool	GetAzimuthFieldOfView (double &aMinAzFOV, double &aMaxAzFOV) const override
bool	SetAzimuthFieldOfView (double aMinAzFOV, double aMaxAzFOV) override
	Set the azimuth field of view.
bool	GetElevationFieldOfView (double &aMinElFOV, double &aMaxElFOV) const override
bool	SetElevationFieldOfView (double aMinElFOV, double aMaxElFOV) override
	Set the elevation field of view.
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.
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 rectangular az-el extents.

Constructor & Destructor Documentation

WsfRectangularFieldOfView()

WsfRectangularFieldOfView::WsfRectangularFieldOfView

(

)

References WsfFieldOfView::SetType().

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

Member Function Documentation

Clone()

WsfFieldOfView * WsfRectangularFieldOfView::Clone ( ) const

inlineoverridevirtual

Make a copy of this object.

Returns

The copy of "this" object.

Implements WsfFieldOfView.

References WsfRectangularFieldOfView().

GetAzimuthFieldOfView()

bool WsfRectangularFieldOfView::GetAzimuthFieldOfView ( double & aMinAzFOV, double & aMaxAzFOV ) const

inlineoverridevirtual

Return the azimuth field of view limits, if applicable.

Parameters

aMinAzFOV	The minimum azimuth field-of-view limit.
aMaxAzFOV	The maximum azimuth field-of-view limit.

Returns

True if the limits apply to the field-of-view type; false otherwise.

Reimplemented from WsfFieldOfView.

GetElevationFieldOfView()

bool WsfRectangularFieldOfView::GetElevationFieldOfView ( double & aMinElFOV, double & aMaxElFOV ) const

inlineoverridevirtual

Return the elevation field of view limits, if applicable.

Parameters

aMinElFOV	The minimum elevation field-of-view limit.
aMaxElFOV	The maximum elevation field-of-view limit.

Returns

True if the limits apply to the field-of-view type; false otherwise.

Reimplemented from WsfFieldOfView.

GetScriptClassName()

const char * WsfRectangularFieldOfView::GetScriptClassName ( ) const

inlineoverride

operator!=()

bool WsfRectangularFieldOfView::operator!=

(

const WsfRectangularFieldOfView &

aRhs

)

const

References WsfRectangularFieldOfView().

operator==()

bool WsfRectangularFieldOfView::operator==

(

const WsfRectangularFieldOfView &

aRhs

)

const

References WsfRectangularFieldOfView().

ProcessInput()

bool WsfRectangularFieldOfView::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.

References SetAzimuthFieldOfView(), and SetElevationFieldOfView().

SetAzimuthFieldOfView()

bool WsfRectangularFieldOfView::SetAzimuthFieldOfView ( double aMinAzFOV, double aMaxAzFOV )

overridevirtual

Set the azimuth field of view.

Reimplemented from WsfFieldOfView.

Referenced by ProcessInput().

SetElevationFieldOfView()

bool WsfRectangularFieldOfView::SetElevationFieldOfView ( double aMinElFOV, double aMaxElFOV )

overridevirtual

Set the elevation field of view.

Reimplemented from WsfFieldOfView.

Referenced by ProcessInput().

WithinFieldOfView()

bool WsfRectangularFieldOfView::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.

---

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

• WsfRectangularFieldOfView.hpp
• WsfRectangularFieldOfView.cpp