WsfPolygonalFieldOfView Class Reference

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

#include <WsfPolygonalFieldOfView.hpp>

Inheritance diagram for WsfPolygonalFieldOfView:

Collaboration diagram for WsfPolygonalFieldOfView:

Public Types
using	AzElPoints = std::vector<std::pair<double, double>>

Public Member Functions
	WsfPolygonalFieldOfView ()
	WsfPolygonalFieldOfView (const WsfPolygonalFieldOfView &aSrc)
WsfPolygonalFieldOfView &	operator= (const WsfPolygonalFieldOfView &)=delete
bool	operator== (const WsfPolygonalFieldOfView &aRhs) const
bool	operator!= (const WsfPolygonalFieldOfView &aRhs) const
bool	ProcessInput (UtInput &aInput) override
bool	Initialize (const WsfArticulatedPart &aArticulatedPart) override
const char *	GetScriptClassName () const override
WsfFieldOfView *	Clone () const override
bool	WithinFieldOfView (double aThisToTgtAz, double aThisToTgtEl) override
const AzElPoints &	GetAzElPoints () const
const WsfZoneDefinition &	GetPoints () const
Public Member Functions inherited from WsfFieldOfView
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 Polygonal az-el extents.

Member Typedef Documentation

AzElPoints

using WsfPolygonalFieldOfView::AzElPoints = std::vector<std::pair<double, double>>

Constructor & Destructor Documentation

WsfPolygonalFieldOfView() [1/2]

WsfPolygonalFieldOfView::WsfPolygonalFieldOfView

(

)

References WsfZoneDefinition::cPOLYGONAL, and WsfFieldOfView::SetType().

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

WsfPolygonalFieldOfView() [2/2]

WsfPolygonalFieldOfView::WsfPolygonalFieldOfView

(

const WsfPolygonalFieldOfView &

aSrc

)

References WsfZoneDefinition::cPOLYGONAL, and WsfPolygonalFieldOfView().

Member Function Documentation

Clone()

WsfFieldOfView * WsfPolygonalFieldOfView::Clone ( ) const

inlineoverridevirtual

Make a copy of this object.

Returns

The copy of "this" object.

Implements WsfFieldOfView.

References WsfPolygonalFieldOfView().

GetAzElPoints()

const AzElPoints & WsfPolygonalFieldOfView::GetAzElPoints ( ) const

inline

GetPoints()

const WsfZoneDefinition & WsfPolygonalFieldOfView::GetPoints ( ) const

inline

GetScriptClassName()

const char * WsfPolygonalFieldOfView::GetScriptClassName ( ) const

inlineoverride

Initialize()

bool WsfPolygonalFieldOfView::Initialize ( const WsfArticulatedPart & aArticulatedPart )

overridevirtual

Provide initialization of the field of view object.

Parameters

aArticulatedPart

The articulated part on which the field of view is being defined.

Returns

Whether the initialization was successful.

Reimplemented from WsfFieldOfView.

References WsfPlatformPart::GetScenario(), WsfFieldOfView::Initialize(), Initialize(), and ok.

Referenced by Initialize().

operator!=()

bool WsfPolygonalFieldOfView::operator!=

(

const WsfPolygonalFieldOfView &

aRhs

)

const

References WsfPolygonalFieldOfView().

operator=()

WsfPolygonalFieldOfView & WsfPolygonalFieldOfView::operator= ( const WsfPolygonalFieldOfView & )

delete

References WsfPolygonalFieldOfView().

operator==()

bool WsfPolygonalFieldOfView::operator==

(

const WsfPolygonalFieldOfView &

aRhs

)

const

References WsfPolygonalFieldOfView().

ProcessInput()

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

WithinFieldOfView()

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

• WsfPolygonalFieldOfView.hpp
• WsfPolygonalFieldOfView.cpp