WsfCircularFieldOfView Class Reference

A field of view with circular extent defined by a conical half-angle. More...

#include <WsfCircularFieldOfView.hpp>

Inheritance diagram for WsfCircularFieldOfView:

Collaboration diagram for WsfCircularFieldOfView:

Public Member Functions
	WsfCircularFieldOfView ()
bool	operator== (const WsfCircularFieldOfView &aRhs) const
bool	operator!= (const WsfCircularFieldOfView &aRhs) const
bool	ProcessInput (UtInput &aInput) override
const char *	GetScriptClassName () const override
WsfCircularFieldOfView *	Clone () const override
bool	WithinFieldOfView (double aThisToTgtAz, double aThisToTgtEl) override
bool	GetAzimuthFieldOfView (double &aMinAzFOV, double &aMaxAzFOV) const override
	Provide the azimuth field of view.
bool	GetElevationFieldOfView (double &aMinElFOV, double &aMaxElFOV) const override
	Provide the elevation field of view.
double	GetHalfAngle () const
	Return the conical half-angle defining the field-of-view.
void	SetHalfAngle (double aHalfAngle)
	Set the conical half-angle defining the 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.
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 circular extent defined by a conical half-angle.

Constructor & Destructor Documentation

WsfCircularFieldOfView()

WsfCircularFieldOfView::WsfCircularFieldOfView

(

)

References WsfFieldOfView::SetType().

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

Member Function Documentation

Clone()

WsfCircularFieldOfView * WsfCircularFieldOfView::Clone ( ) const

inlineoverridevirtual

Make a copy of this object.

Returns

The copy of "this" object.

Implements WsfFieldOfView.

References WsfCircularFieldOfView().

GetAzimuthFieldOfView()

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

inlineoverridevirtual

Provide the azimuth field of view.

Reimplemented from WsfFieldOfView.

GetElevationFieldOfView()

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

inlineoverridevirtual

Provide the elevation field of view.

Reimplemented from WsfFieldOfView.

GetHalfAngle()

double WsfCircularFieldOfView::GetHalfAngle ( ) const

inline

Return the conical half-angle defining the field-of-view.

GetScriptClassName()

const char * WsfCircularFieldOfView::GetScriptClassName ( ) const

inlineoverride

operator!=()

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

inline

References WsfCircularFieldOfView().

operator==()

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

inline

References WsfCircularFieldOfView().

ProcessInput()

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

SetHalfAngle()

void WsfCircularFieldOfView::SetHalfAngle ( double aHalfAngle )

inline

Set the conical half-angle defining the field-of-view.

WithinFieldOfView()

bool WsfCircularFieldOfView::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:

• WsfCircularFieldOfView.hpp
• WsfCircularFieldOfView.cpp