#include <WsfCodedZone.hpp>

Inheritance diagram for WsfCodedZone:

[legend]

Collaboration diagram for WsfCodedZone:

[legend]

Public Member Functions
	WsfCodedZone ()=default
	WsfCodedZone (ut::span< const Point > aLL_Points)
	~WsfCodedZone () override=default
WsfZone *	Clone () const override
	The standard Clone() method (virtual copy constructor).
bool	ProcessInput (UtInput &aInput) override
Public Member Functions inherited from WsfZoneDefinition
	WsfZoneDefinition ()
	WsfZoneDefinition (const WsfZoneDefinition &aSrc)
WsfZoneDefinition &	operator= (const WsfZoneDefinition &)=delete
	~WsfZoneDefinition () override=default
WsfZone *	Clone () const override
	The standard Clone() method (virtual copy constructor).
bool	PointIsInside (WsfSimulation *aSimulationPtr, const double aViewedPointWCS[3], const double aEyePointWCS[3], const double aLookHeading, const double aDeltaDownRange=0.0) override
double	CheckIntersections (const double aLLA1[3], const double aLLA2[3]) override
void	Initialize (const WsfScenario &aScenario) override
bool	ProcessInput (UtInput &aInput) override
void	UpdateReference (const WsfSimulation &aSimulation)
	Update the geometric reference point for the zone from the simulation.
void	SetReference (UtEntity &aReference)
	Set the geometric reference point for the zone.
void	SetReference (const WsfGeoPoint &aReference, double aReferenceHeading)
	Set the geometric reference point for the zone.
void	SetReference (double aReferenceWCS[3], double aReferenceHeading)
	Set the geometric reference point for the zone.
void	SetReference (double aReferenceLat, double aReferenceLon, double aReferenceHeading)
	Set the geodetic reference point for the zone.
WsfGeoPoint	Reference () override
	return the geopoint of the reference point
void	SetShapeType (ShapeType aType)
void	SetRelativeType (RelativeToType aType)
void	SetAltBounds (double aMinAlt, double aMaxAlt)
void	SetRadialBounds (double aMinRadius, double aMaxRadius)
void	SetAngleBounds (double aStartAngle, double aStopAngle)
void	SetEllipticalAxes (double aLatAxisLen, double aLonAxisLen)
void	SetPolyPoints (const std::vector< WsfGeoPoint > &aPoints)
void	SetPolyPointsRelative (const std::vector< UtVec3d > &aPoints)
const std::vector< WsfZone::Point > &	GetPoints () const
void	GetPoints (std::vector< WsfGeoPoint > &aPoints) const
ut::optional< UtColor >	GetFillColor () const override
ut::optional< UtColor >	GetLineColor () const override
ShapeType	GetShapeType () const
RelativeToType	GetRelativeType () const
WsfStringId	GetReferencePlatformName () const
double	GetReferenceLat () const
double	GetReferenceLon () const
bool	IsNegative () const
	Returns true the zone is a 'negative' zone and returns the opposite value for PointIsInside().
bool	HasAbsoluteLatLon () const
void	SetPointsAreLatLon (bool aValue)
bool	PointsAreLatLon ()
bool	GetLatLonExtrema (double &aSouthernLat, double &aWesternLon, double &aNorthernLat, double &aEasternLon) const override
double	GetRadius () const
double	GetMinRadius () const
double	GetReferenceHeading () const
double	GetLatAxisLength () const
double	GetLonAxisLength () const
void	GetAngleBounds (double &aStartAngle, double &aStopAngle) const
void	GetAltBounds (double &aMinAlt, double &aMaxAlt) const
WsfPlatform *	GetReferencePlatform (WsfSimulation *aSimulationPtr) const
void	VerticesIn (double aMinX, double aMinY, double aMaxX, double aMaxY, std::vector< Point > &aPointsVector) const
void	Draw (WsfDraw &aDraw) override
void	DrawRelative (WsfDraw &aDraw, const double aEyePointWCS[3], const double aLookHeading) override
void	DrawCentroid (WsfDraw &aDraw) override
	draw the centroid using WsfDraw in an x
void	DrawBounds (WsfDraw &aDraw) override
	draw the bounding box using WsfDraw
void	DebugDrawZone (WsfDraw &aDraw) override
	draw the zone using WsfDraw
void	DebugDrawZoneRelative (WsfDraw &aDraw, const double aEyePointWCS[3], const double aLookHeading) override
void	DebugDrawCentroid (WsfDraw &aDraw) override
	draw the centroid using WsfDraw in an x
void	DebugDrawBounds (WsfDraw &aDraw) override
	draw the bounding box using WsfDraw
bool	WithinPolygonSides (const double aXorLatValue, const double aYorLonValue) const
Public Member Functions inherited from WsfZone
	WsfZone ()
WsfZone &	operator= (const WsfZone &)=delete
	~WsfZone () override=default
WsfComponent *	CloneComponent () const override
int	GetComponentInitializationOrder () const override
WsfStringId	GetComponentName () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatform *	GetPlatform () const
bool	Initialize (double aSimTime) override
void	SetGlobalName (WsfStringId aGlobalName)
	Set the global model that this zone was cloned from.
WsfStringId	GetGlobalName () const
virtual double	Area ()
virtual WsfGeoPoint	Centroid ()
virtual void	MaxPoint (double &aX, double &aY, double &aAlt)
virtual void	MinPoint (double &aX, double &aY, double &aAlt)
virtual const std::map< WsfStringId, double > &	GetModifierList () const
	Get the modifier list for WsfZoneAttenuation.
virtual double	ModifierValue (const std::string &aModifierName) const
	returns the value of the modifier matching the given name
bool	IsInitialized () const
void	SetFillColor (const std::string &aColor)
void	SetFillColor (const UtColor &aColor)
void	SetLineColor (const std::string &aColor)
void	SetLineColor (const UtColor &aColor)
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)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual bool	Initialize2 (double aSimTime)
virtual void	PreInput ()
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Protected Member Functions
	WsfCodedZone (const WsfCodedZone &aSrc)=default
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfZoneDefinition
void	AddPoint (const Point &aPoint)
	WsfZone (const WsfZone &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Additional Inherited Members
Public Types inherited from WsfZoneDefinition
enum	RelativeToType { cOBSERVER , cINTERNAL }
enum	ShapeType { cNO_SHAPE , cCIRCULAR , cELLIPTICAL , cPOLYGONAL , cSPHERICAL }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
Static Public Attributes inherited from WsfZone
static constexpr const char *	cTYPE_KIND = "zone"
static constexpr double	cUNSPECIFIED = 1.0E20
static constexpr double	cHUGE = 9.9E20
static constexpr double	cSMALL = -9.9E20
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
WsfPlatform *	mPlatformPtr
std::map< WsfStringId, double >	mModifierList
double	mMinAlt
double	mMaxAlt
double	mMinX
double	mMaxX
double	mMinY
double	mMaxY
double	mArea
Point	mCentroid
bool	mIsInitialized

Detailed Description

A class which removes some encapsulation to enable hand-creating a Zone in C++ code. This implementation DOES ASSUME a Polygonal Zone defined of clockwise (Lat, Lon) points.

Constructor & Destructor Documentation

◆ WsfCodedZone() [1/3]

WsfCodedZone::WsfCodedZone ( )

default

References WsfCodedZone().

Referenced by Clone(), WsfCodedZone(), and WsfCodedZone().

◆ WsfCodedZone() [2/3]

WsfCodedZone::WsfCodedZone ( ut::span< const Point > aLL_Points )

Old form of the constructor

Parameters

aLL_Points Input vector of latitude/longitude points.

References WsfZoneDefinition::AddPoint(), WsfZoneDefinition::cPOLYGONAL, WsfZoneDefinition::SetPointsAreLatLon(), WsfZoneDefinition::SetShapeType(), and WsfZoneDefinition::WsfZoneDefinition().

◆ ~WsfCodedZone()

WsfCodedZone::~WsfCodedZone ( )

overridedefault

References WsfZone::WsfZone().

◆ WsfCodedZone() [3/3]

WsfCodedZone::WsfCodedZone ( const WsfCodedZone & aSrc )

protecteddefault

Copy constructor (for Clone()).

References WsfCodedZone().

Member Function Documentation

◆ Clone()

WsfZone * WsfCodedZone::Clone ( ) const

overridevirtual

The standard Clone() method (virtual copy constructor).

Implements WsfZone.

References WsfCodedZone(), and WsfZone::WsfZone().

◆ ProcessInput()

bool WsfCodedZone::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 WsfObject.

References WsfZoneDefinition::AddPoint(), WsfZoneDefinition::cPOLYGONAL, WsfZoneDefinition::SetPointsAreLatLon(), and WsfZoneDefinition::SetShapeType().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members