#include <WsfPM_Zone.hpp>

Inheritance diagram for WsfPM_ZoneDefinition:

[legend]

Collaboration diagram for WsfPM_ZoneDefinition:

[legend]

Public Types
enum	DefinitionType { cTYPE_NOT_SET = 0 , cCIRCULAR = 1 , cELLIPTICAL , cPOLYGONAL , cSPHERICAL }
using	AuxDataMap = std::map<std::string, std::string>
Public Types inherited from WsfPM_Zone
enum	ZoneType { cZONE_SET , cZONE_DEFINITION }
using	Point = UtVec2d

Public Member Functions
	WsfPM_ZoneDefinition ()
	WsfPM_ZoneDefinition (const WsfPProxyNode &aNode)
DefinitionType	GetDefinitionType () const
	Returns the definition type of the zone: circular, elliptical, spherical, or polygonal.
void	SetDefinitionType (DefinitionType aType)
WsfProxy::Length	MinimumAltitude () const
	Returns the value of the minimum altitude property. If unset, returns the minimum altitude inherited through the references tree if there is one.
WsfProxy::Length	MaximumAltitude () const
	Returns the value of the maximum altitude property. If unset, returns the maximum altitude inherited through the references tree if there is one.
WsfProxy::Length	MinimumRadius () const
	Returns the value of the minimum radius property. If unset, returns the minimum radius inherited through the references tree if there is one.
WsfProxy::Length	MaximumRadius () const
	Returns the value of the maximum radius property. If unset, returns the maximum radius inherited through the references tree if there is one.
WsfProxy::Length	LongitudinalAxis () const
	Returns the value of the longitudal axis property. If unset, returns the longitudal axis inherited through the references tree if there is one.
WsfProxy::Length	LateralAxis () const
	Returns the value of the lateral axis property. If unset, returns the lateral axis inherited through the references tree if there is one.
WsfProxy::Angle	StartAngle () const
	Returns the value of the start angle property. If unset, returns the start angle inherited through the references tree if there is one.
WsfProxy::Angle	StopAngle () const
	Returns the value of the stop angle property. If unset, returns the stop angle inherited through the references tree if there is one.
bool	UseLatLon () const
	Returns whether the points on this polygonal zone are defined using lat/lon coordinates.
bool	UseMGRS () const
	Returns whether the points on this polygonal zone are defined using MGRS coordinates.
bool	UsePolar () const
	Returns whether the points on this polygonal zone are defined using polar coordinates.
bool	UseOffset () const
	Returns whether the points on this polygonal zone are defined as an offset from a position.
bool	IsAbsolute () const
	Returns whether this zone is absolute – that is, defined using absolute coordinates (lat/lon or MGRS) AND defined without a reference zone.
WsfProxy::Angle	Heading () const noexcept
WsfPProxyNode	HeadingNode () const noexcept
WsfProxy::Position	Position () const noexcept
WsfPProxyNode	PositionNode () const noexcept
std::string	ReferencePlatform () const
	Returns the value of the reference platform property.
std::string	ReferenceZone () const
	Returns the value of the reference zone property.
bool	Negative () const
	Returns the value of the negative property.
AuxDataMap	AuxData () const
std::vector< WsfPM_Zone::Point >	Points () const
	Returns the points that define this polygonal zone.
WsfPM_Zone::Point	GetPoint (size_t aIndex) const
	Returns the point at the given index. If there is no point at this index, returns an empty instance.
WsfPM_ZonePoint	GetPointNode (size_t aIndex) const
	Returns the point proxy node at the given index. If there is no point at this index, returns a null zone point proxy node.
size_t	PointCount () const
	Returns the number of points on this polygonal zone.
WsfPM_ZonePointList	PointList () const
	Returns a list of zone point proxy nodes on this poygonal zone node. If none are defined for this zone, returns a list of inherited zone point proxy nodes.
bool	ReferencePoint (double &aX, double &aY, bool &aIsLatLon) const
	Calculates the reference point for a relative zone defined using absolute coordinates.
bool	ReferencePoint (double &aX, double &aY) const
	Calculates the reference point for a relative zone defined using absolute coordinates.
ut::optional< WsfPM_Zone::Point >	ReferencePoint () const
	Calculates the reference point for a relative zone defined using absolute coordinates.
WsfPM_ZoneDefinition	ReferenceZoneNode () const
	Returns the zone proxy node representing this zone's reference zone.
WsfPM_Platform	AnchorPlatformNode () const
	Returns the platform proxy node representing this zone's anchor platform.
WsfPM_Platform	ReferencePlatformNode () const
	Returns the platform proxy node representing this zone's reference platform.
WsfProxy::Length	AnchorPlatformAltitude () const
	Returns the altitude property of this zone's anchor platform.
bool	IsReferencePlatformValid () const
ut::optional< UtColor >	GetFillColor () const override
ut::optional< UtColor >	GetLineColor () const override
Public Member Functions inherited from WsfPM_Zone
	WsfPM_Zone ()
	WsfPM_Zone (const WsfPProxyNode &aNode)
bool	IsDefinition () const
bool	IsZoneSet () const
bool	Rename (std::string aNewName)
WsfPM_Zone	GetSourceZone () const
std::string	ParentPlatform () const
	Returns the name of the parent platform, or "Global Zones" if there is no parent platform.
WsfPM_Platform	ParentPlatformNode () const
	Returns the platform proxy node representing this zone's parent platform.
std::vector< WsfPM_Zone >	GetReferencingZones () const
	Returns a list of zones that reference this zone.
std::vector< WsfPM_ZoneSet >	GetUsingZoneSets () const
	Returns a list of zone sets that use this zone.
Public Member Functions inherited from WsfPProxyNode
void	MoveTo (WsfPProxy *aProxy, const WsfPProxyPath &aPath, size_t aSubPathLength)
	WsfPProxyNode ()
	WsfPProxyNode (WsfPProxy *aProxy, const WsfPProxyPath &aPath)
	WsfPProxyNode (WsfPProxy *aProxy, const WsfPProxyPath &aPath, size_t aSubPathLength)
	WsfPProxyNode (WsfPProxy *aProxy, const WsfPProxyPath &aPath, WsfPProxyValue aValue)
	WsfPProxyNode (const WsfPProxyNode &aSrc)
WsfPProxyNode	Root () const
WsfPProxy *	GetProxy () const
WsfPProxyValue	GetRoot () const
WsfPProxyValue	GetValue () const
WsfPProxyNode	GetParent () const
WsfPProxyNode	GetInherited () const
const WsfPProxyPath &	GetPath () const
std::string	GetPathString () const
WsfPProxyPath	GetStablePath () const
WsfPProxyPath	GetInheritedPath () const
const WsfPProxyPath *	GetTypePath () const
const WsfPProxyPath *	GetBasePath () const
std::string	GetName () const
std::string	GetAttrName () const
std::string	GetInheritedName () const
std::string	GetTypeName () const
std::vector< std::string >	GetInheritedTypeNames () const
UtTextDocumentRange	GetSourceDocumentRange () const
UtTextDocumentRange	GetFirstDocumentRange () const noexcept
UtTextDocumentRange	GetLastDocumentRange () const noexcept
std::string	GetSourceText () const
WsfPProxyIndexNode *	FindIndexNode () const
const std::set< WsfPProxyPath > *	GetInheritedValuePaths () const
bool	SwitchToBasicTypes ()
bool	SwitchToUserTypes ()
bool	UpdateParentPath (const WsfPProxyPath &oldParentPath, const WsfPProxyPath &newParentPath)
void	ResetToInheritedValue ()
	operator bool () const
	operator bool ()
bool	IsValid () const
bool	IsNull () const
bool	operator== (const WsfPProxyNode &aRhs) const
bool	operator!= (const WsfPProxyNode &aRhs) const
WsfPProxyNode &	operator+= (size_t aIndex)
WsfPProxyNode &	operator+= (const std::string &aStr)
WsfPProxyNode &	operator+= (const WsfPProxyPath &aSuffixPath)
WsfPProxyNode &	operator+= (const WsfPProxyKey &aEntry)
WsfPProxyNode &	operator+= (const WsfParseTypePath &aParseTypePath)
WsfPProxyNode	operator+ (const WsfPProxyPath &aSuffixPath) const
WsfPProxyNode	operator+ (const WsfPProxyKey &aEntry) const
WsfPProxyNode	operator+ (size_t aEntryIndex) const
WsfPProxyNode	operator+ (const std::string &aEntry) const
WsfPProxyNode	operator+ (const char *aEntry) const
WsfPProxyNode	operator+ (const WsfParseTypePath &aParseTypePath) const
WsfPProxyNode &	ToParent ()
WsfPProxyNode &	TrimPath (size_t aPathLength)
bool	operator< (const WsfPProxyNode &aRhs) const
void	SetBasePath (const WsfPProxyPath &aNewPath)
void	NotifyValueChanged () const
void	NotifyValueAdded () const
void	NotifyValueRemoved () const
void	NotifyValueMoved (const std::string &aOldName) const
void	NotifyAttributeChanged (const char *aAttributeName) const
void	NotifyBeforeValueChanged () const
void	NotifyBeforeAttributeChanged (const char *aAttributeName) const
template<typename T>
void	ChangeAttribute (const char *aAttributeName, const T &aValue)
bool	Assign (const WsfPProxyValue &aValue) const
bool	Assign (const std::string &aValue) const
bool	Assign (int aIntValue) const
bool	Assign (double aDoubleVal) const
bool	Assign (bool aBoolVal) const
bool	ClearUnset () const
bool	Unset () const
bool	UnsetAttribute (const std::string &aAttrName) const
bool	AssignAttribute (const std::string &aAttrName, const std::string &aValue) const
bool	AssignAttribute (const std::string &aAttrName, int aIntValue) const
bool	AssignAttribute (const std::string &aAttrName, double aDoubleVal) const
bool	AssignAttribute (const std::string &aAttrName, bool aBoolVal) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::String &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Double &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Int &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Latitude &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Longitude &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Length &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Length2 &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Time &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Speed &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::DataSize &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Power &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::PowerDB &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::SolidAngle &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Mass &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Force &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Torque &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Area &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::AreaDB &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Volume &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Time2 &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Acceleration &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Frequency &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Angle &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::AngularRate &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::AngularAcceleration &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::DataRate &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::MassDensity &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::MassTransfer &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Energy &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Fluence &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Irradiance &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Ratio &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::NoisePressure &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Pressure &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Temperature &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::SpecificRange &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::AngularInertia &aValue) const
bool	AssignAttribute (const std::string &aAttrName, const WsfProxy::Position &aValue) const
bool	Assign (const WsfProxy::String &aValue) const
bool	Assign (const WsfProxy::Double &aValue) const
bool	Assign (const WsfProxy::Int &aValue) const
bool	Assign (const WsfProxy::Latitude &aValue) const
bool	Assign (const WsfProxy::Longitude &aValue) const
bool	Assign (const WsfProxy::Length &aValue) const
bool	Assign (const WsfProxy::Length2 &aValue) const
bool	Assign (const WsfProxy::Time &aValue) const
bool	Assign (const WsfProxy::Speed &aValue) const
bool	Assign (const WsfProxy::DataSize &aValue) const
bool	Assign (const WsfProxy::Power &aValue) const
bool	Assign (const WsfProxy::PowerDB &aValue) const
bool	Assign (const WsfProxy::SolidAngle &aValue) const
bool	Assign (const WsfProxy::Mass &aValue) const
bool	Assign (const WsfProxy::Force &aValue) const
bool	Assign (const WsfProxy::Torque &aValue) const
bool	Assign (const WsfProxy::Area &aValue) const
bool	Assign (const WsfProxy::AreaDB &aValue) const
bool	Assign (const WsfProxy::Volume &aValue) const
bool	Assign (const WsfProxy::Time2 &aValue) const
bool	Assign (const WsfProxy::Acceleration &aValue) const
bool	Assign (const WsfProxy::Frequency &aValue) const
bool	Assign (const WsfProxy::Angle &aValue) const
bool	Assign (const WsfProxy::AngularRate &aValue) const
bool	Assign (const WsfProxy::AngularAcceleration &aValue) const
bool	Assign (const WsfProxy::DataRate &aValue) const
bool	Assign (const WsfProxy::MassDensity &aValue) const
bool	Assign (const WsfProxy::MassTransfer &aValue) const
bool	Assign (const WsfProxy::Energy &aValue) const
bool	Assign (const WsfProxy::Fluence &aValue) const
bool	Assign (const WsfProxy::Irradiance &aValue) const
bool	Assign (const WsfProxy::Ratio &aValue) const
bool	Assign (const WsfProxy::NoisePressure &aValue) const
bool	Assign (const WsfProxy::Pressure &aValue) const
bool	Assign (const WsfProxy::Temperature &aValue) const
bool	Assign (const WsfProxy::SpecificRange &aValue) const
bool	Assign (const WsfProxy::AngularInertia &aValue) const
bool	Assign (const WsfProxy::Position &aValue) const
std::string	ToJSON (int aOutputFlags=0) const
bool	IsOfBasicType () const noexcept
bool	IsA_BasicType () const noexcept
bool	IsA_StructType () const noexcept
bool	IsA_ListType () const noexcept
bool	IsA_MapType () const noexcept
bool	IsOfBasicType (const std::string &aTypeName) const noexcept
bool	IsA_PredefinedStructTypeOf (const std::string &aTypeName) const noexcept
bool	IsOfUserType (const std::string &aTypeName) const noexcept
bool	IsA_StructTypeOf (const std::string &aTypeName) const noexcept
bool	IsA_ListTypeOf (const std::string &aTypeName) const noexcept
bool	IsA_MapTypeOf (const std::string &aTypeName) const noexcept
bool	IsOfType (const std::string &aTypeName) const noexcept
bool	IsInherited () const
bool	IsInheritedFromParent () const
void	Invalidate ()

Additional Inherited Members
Static Public Member Functions inherited from WsfPProxyNode
static WsfPProxyNode	FromProxy (WsfPProxy *aProxy)
template<typename T>
T	GetAttributeT (const std::string &aName) const
WsfPProxyPath	mPath

Member Typedef Documentation

◆ AuxDataMap

using WsfPM_ZoneDefinition::AuxDataMap = std::map<std::string, std::string>

Member Enumeration Documentation

◆ DefinitionType

enum WsfPM_ZoneDefinition::DefinitionType

Enumerator
cTYPE_NOT_SET
cCIRCULAR
cELLIPTICAL
cPOLYGONAL
cSPHERICAL

Constructor & Destructor Documentation

◆ WsfPM_ZoneDefinition() [1/2]

WsfPM_ZoneDefinition::WsfPM_ZoneDefinition ( )

inline

Referenced by IsAbsolute(), PointList(), ReferencePoint(), ReferenceZoneNode(), UseLatLon(), UseMGRS(), UseOffset(), and UsePolar().

◆ WsfPM_ZoneDefinition() [2/2]

WsfPM_ZoneDefinition::WsfPM_ZoneDefinition ( const WsfPProxyNode & aNode )

inline

References WsfPM_Zone::WsfPM_Zone(), and WsfPProxyNode::WsfPProxyNode().

Member Function Documentation

◆ AnchorPlatformAltitude()

WsfProxy::Length WsfPM_ZoneDefinition::AnchorPlatformAltitude ( ) const

Returns the altitude property of this zone's anchor platform.

References WsfPM_Platform::Altitude(), WsfPM_Waypoint::Altitude(), AnchorPlatformNode(), WsfPM_Route::GetWaypoint(), WsfPM_Mover::InitialRoute(), WsfPProxyNode::IsValid(), and WsfPM_Platform::Mover().

◆ AnchorPlatformNode()

WsfPM_Platform WsfPM_ZoneDefinition::AnchorPlatformNode ( ) const

Returns the platform proxy node representing this zone's anchor platform.

References WsfPProxyNode::IsNull(), WsfPM_Zone::ParentPlatformNode(), ReferencePlatformNode(), and WsfPProxyNode::Root().

Referenced by AnchorPlatformAltitude().

◆ AuxData()

WsfPM_ZoneDefinition::AuxDataMap WsfPM_ZoneDefinition::AuxData ( ) const

References WsfPProxyValue::GetAttr(), WsfPProxyNode::GetAttrName(), WsfPProxyValue::GetObjectMap(), WsfPProxyNode::GetValue(), and WsfPProxyObjectMap::GetValues().

◆ GetDefinitionType()

WsfPM_ZoneDefinition::DefinitionType WsfPM_ZoneDefinition::GetDefinitionType ( ) const

Returns the definition type of the zone: circular, elliptical, spherical, or polygonal.

References cSPHERICAL, and cTYPE_NOT_SET.

Referenced by wizard::Zone::UpdateZone().

◆ GetFillColor()

ut::optional< UtColor > WsfPM_ZoneDefinition::GetFillColor ( ) const

overridevirtual

Reimplemented from WsfPM_Zone.

Referenced by WsfPM_Zone::GetFillColor().

◆ GetLineColor()

ut::optional< UtColor > WsfPM_ZoneDefinition::GetLineColor ( ) const

overridevirtual

Reimplemented from WsfPM_Zone.

Referenced by WsfPM_Zone::GetLineColor().

◆ GetPoint()

WsfPM_Zone::Point WsfPM_ZoneDefinition::GetPoint ( size_t aIndex ) const

Returns the point at the given index. If there is no point at this index, returns an empty instance.

Parameters

aIndex is the index of the point in question.

References WsfPM_ZonePoint::Bearing(), WsfPProxyNode::GetValue(), WsfProxy::BasicValueT< T, PROXY_TYPE_ID >::GetValue(), WsfPM_ZonePoint::GetX(), WsfPM_ZonePoint::GetY(), Heading(), WsfProxy::BasicValue::IsUnset(), WsfPProxyNode::IsValid(), WsfPM_ZonePoint::Latitude(), WsfPM_ZonePoint::Longitude(), WsfPM_ZonePoint::MGRS(), PointList(), WsfPM_ZonePoint::Range(), ReferencePoint(), ReferenceZone(), and WsfPM_List::size().

◆ GetPointNode()

WsfPM_ZonePoint WsfPM_ZoneDefinition::GetPointNode ( size_t aIndex ) const

Returns the point proxy node at the given index. If there is no point at this index, returns a null zone point proxy node.

Parameters

aIndex is the index of the point in question.

References PointCount(), and PointList().

◆ Heading()

WsfProxy::Angle WsfPM_ZoneDefinition::Heading ( ) const

noexcept

Get the heading as a WsfProxy::Angle

Return values

the zone heading	if set
the platform heading	if unset

References WsfPProxyNode::GetAttributeT(), WsfPProxyNode::GetLastDocumentRange(), WsfPM_Platform::InitialHeading(), WsfPProxyNode::IsValid(), WsfPM_Zone::ParentPlatformNode(), ReferencePlatformNode(), and WsfPProxyNode::WsfPProxyNode().

Referenced by GetPoint(), and Points().

◆ HeadingNode()

WsfPProxyNode WsfPM_ZoneDefinition::HeadingNode ( ) const

noexcept

Get the heading

Returns: the heading as a WsfPProxyNode

References WsfPProxyNode::WsfPProxyNode().

◆ IsAbsolute()

bool WsfPM_ZoneDefinition::IsAbsolute ( ) const

Returns whether this zone is absolute – that is, defined using absolute coordinates (lat/lon or MGRS) AND defined without a reference zone.

References WsfPProxyValue::GetAttr(), WsfPProxyValue::GetBoolValue(), WsfPProxyNode::GetValue(), ReferenceZone(), and WsfPM_ZoneDefinition().

◆ IsReferencePlatformValid()

bool WsfPM_ZoneDefinition::IsReferencePlatformValid ( ) const

References WsfPProxyNode::GetAttributeT(), WsfPProxyNode::GetName(), WsfPM_ObjectMapT< TYPE >::GetValuesT(), WsfPM_Root::platforms(), ReferencePlatform(), and WsfPProxyNode::Root().

◆ LateralAxis()

WsfProxy::Length WsfPM_ZoneDefinition::LateralAxis ( ) const

Returns the value of the lateral axis property. If unset, returns the lateral axis inherited through the references tree if there is one.

Referenced by wizard::Zone::UpdateZone().

◆ LongitudinalAxis()

WsfProxy::Length WsfPM_ZoneDefinition::LongitudinalAxis ( ) const

Returns the value of the longitudal axis property. If unset, returns the longitudal axis inherited through the references tree if there is one.

Referenced by wizard::Zone::UpdateZone().

◆ MaximumAltitude()

WsfProxy::Length WsfPM_ZoneDefinition::MaximumAltitude ( ) const

Returns the value of the maximum altitude property. If unset, returns the maximum altitude inherited through the references tree if there is one.

◆ MaximumRadius()

WsfProxy::Length WsfPM_ZoneDefinition::MaximumRadius ( ) const

Returns the value of the maximum radius property. If unset, returns the maximum radius inherited through the references tree if there is one.

◆ MinimumAltitude()

WsfProxy::Length WsfPM_ZoneDefinition::MinimumAltitude ( ) const

Returns the value of the minimum altitude property. If unset, returns the minimum altitude inherited through the references tree if there is one.

◆ MinimumRadius()

WsfProxy::Length WsfPM_ZoneDefinition::MinimumRadius ( ) const

Returns the value of the minimum radius property. If unset, returns the minimum radius inherited through the references tree if there is one.

◆ Negative()

bool WsfPM_ZoneDefinition::Negative ( ) const

Returns the value of the negative property.

References WsfPProxyValue::GetAttr(), WsfPProxyValue::GetBoolValue(), and WsfPProxyNode::GetValue().

◆ PointCount()

size_t WsfPM_ZoneDefinition::PointCount ( ) const

Returns the number of points on this polygonal zone.

References WsfPProxyNode::IsValid(), PointList(), and WsfPM_List::size().

Referenced by GetPointNode().

◆ PointList()

WsfPM_ZonePointList WsfPM_ZoneDefinition::PointList ( ) const

Returns a list of zone point proxy nodes on this poygonal zone node. If none are defined for this zone, returns a list of inherited zone point proxy nodes.

References WsfPM_ZoneDefinition().

Referenced by GetPoint(), GetPointNode(), PointCount(), and Points().

◆ Points()

std::vector< WsfPM_Zone::Point > WsfPM_ZoneDefinition::Points ( ) const

Returns the points that define this polygonal zone.

References WsfPM_ZonePoint::Bearing(), WsfPProxyNode::GetValue(), WsfProxy::BasicValueT< T, PROXY_TYPE_ID >::GetValue(), WsfPM_ZonePoint::GetX(), WsfPM_ZonePoint::GetY(), Heading(), WsfPProxyNode::IsNull(), WsfProxy::BasicValue::IsUnset(), WsfPProxyNode::IsValid(), WsfPM_ZonePoint::Latitude(), WsfPM_ZonePoint::Longitude(), WsfPM_ZonePoint::MGRS(), PointList(), WsfPM_ZonePoint::Range(), ReferencePoint(), ReferenceZone(), and WsfPM_List::size().

Referenced by wizard::Zone::UpdateZone().

◆ Position()

WsfProxy::Position WsfPM_ZoneDefinition::Position ( ) const

noexcept

Get the position as a WsfProxy::Position

Return values

the zone position	if set
the platform position	if unset

References WsfPProxyNode::GetAttributeT(), WsfPProxyNode::GetLastDocumentRange(), WsfPM_Platform::InitialLocation(), WsfPProxyNode::IsValid(), WsfPM_Zone::ParentPlatformNode(), ReferencePlatformNode(), and WsfPProxyNode::WsfPProxyNode().

Referenced by ReferencePoint().

◆ PositionNode()

WsfPProxyNode WsfPM_ZoneDefinition::PositionNode ( ) const

noexcept

Get the position

Returns: the position as a WsfPProxyNode

References WsfPProxyNode::WsfPProxyNode().

◆ ReferencePlatform()

std::string WsfPM_ZoneDefinition::ReferencePlatform ( ) const

Returns the value of the reference platform property.

References WsfPProxyValue::GetAttr(), WsfPProxyNode::GetValue(), and WsfPProxyValue::ValueToString().

Referenced by IsReferencePlatformValid(), ReferencePlatformNode(), and wizard::Zone::UpdateZone().

◆ ReferencePlatformNode()

WsfPM_Platform WsfPM_ZoneDefinition::ReferencePlatformNode ( ) const

Returns the platform proxy node representing this zone's reference platform.

References WsfPM_ObjectMap::Find(), WsfPProxyNode::IsValid(), WsfPM_Root::platforms(), ReferencePlatform(), and WsfPProxyNode::Root().

Referenced by AnchorPlatformNode(), Heading(), and Position().

◆ ReferencePoint() [1/3]

ut::optional< WsfPM_Zone::Point > WsfPM_ZoneDefinition::ReferencePoint ( ) const

Calculates the reference point for a relative zone defined using absolute coordinates.

Returns: the point if this is a relative zone with absolute coordinates, and an empty optional otherwise.

References WsfProxy::BasicValueT< T, PROXY_TYPE_ID >::GetValue(), WsfProxy::BasicValue::IsUnset(), WsfPProxyNode::IsValid(), WsfPM_ZonePoint::Latitude(), WsfPM_ZonePoint::Longitude(), WsfPM_ZonePoint::MGRS(), pos, Position(), WsfPM_List::size(), and WsfPM_ZoneDefinition().

Referenced by GetPoint(), Points(), and ReferencePoint().

◆ ReferencePoint() [2/3]

bool WsfPM_ZoneDefinition::ReferencePoint	(	double &	aX,
		double &	aY ) const

inline

Calculates the reference point for a relative zone defined using absolute coordinates.

Parameters

aX	will be the latitude/x component of the point.
aY	will be the longitude/y component of the point.

Returns: true if this zone has a reference point, false otherwise.

References ReferencePoint().

◆ ReferencePoint() [3/3]

bool WsfPM_ZoneDefinition::ReferencePoint	(	double &	aX,
		double &	aY,
		bool &	aIsLatLon ) const

Calculates the reference point for a relative zone defined using absolute coordinates.

Parameters

aX	will be the latitude/x component of the point.
aY	will be the longitude/y component of the point.
aIsLatLon	will be true if the point is absolute.

Returns: true if this zone has a reference point, false otherwise.

References ReferencePoint().

Referenced by ReferencePoint().

◆ ReferenceZone()

std::string WsfPM_ZoneDefinition::ReferenceZone ( ) const

Returns the value of the reference zone property.

References WsfPProxyValue::GetAttr(), WsfPProxyNode::GetValue(), and WsfPProxyValue::ValueToString().

Referenced by GetPoint(), WsfPM_Zone::GetReferencingZones(), IsAbsolute(), Points(), and ReferenceZoneNode().

◆ ReferenceZoneNode()

WsfPM_ZoneDefinition WsfPM_ZoneDefinition::ReferenceZoneNode ( ) const

Returns the zone proxy node representing this zone's reference zone.

References WsfPM_ObjectMap::Find(), WsfPProxyNode::IsNull(), WsfPProxyNode::IsValid(), WsfPM_Zone::ParentPlatform(), WsfPM_Root::platforms(), ReferenceZone(), WsfPProxyNode::Root(), WsfPM_Zone::WsfPM_Zone(), WsfPM_ZoneDefinition(), WsfPM_Platform::Zone(), and WsfPM_Root::zones().

◆ SetDefinitionType()

void WsfPM_ZoneDefinition::SetDefinitionType ( DefinitionType aType )

inline

References WsfPProxyValue::GetAttr(), WsfPProxyNode::GetValue(), WsfPProxyNode::NotifyAttributeChanged(), and WsfPProxyValue::SetIntegerValue().

◆ StartAngle()

WsfProxy::Angle WsfPM_ZoneDefinition::StartAngle ( ) const

Returns the value of the start angle property. If unset, returns the start angle inherited through the references tree if there is one.

◆ StopAngle()

WsfProxy::Angle WsfPM_ZoneDefinition::StopAngle ( ) const

Returns the value of the stop angle property. If unset, returns the stop angle inherited through the references tree if there is one.

◆ UseLatLon()

bool WsfPM_ZoneDefinition::UseLatLon ( ) const

Returns whether the points on this polygonal zone are defined using lat/lon coordinates.

References WsfPProxyValue::GetAttr(), WsfPProxyValue::GetBoolValue(), WsfPProxyNode::GetValue(), and WsfPM_ZoneDefinition().

◆ UseMGRS()

bool WsfPM_ZoneDefinition::UseMGRS ( ) const

Returns whether the points on this polygonal zone are defined using MGRS coordinates.

References WsfPProxyValue::GetAttr(), WsfPProxyValue::GetBoolValue(), WsfPProxyNode::GetValue(), and WsfPM_ZoneDefinition().

◆ UseOffset()

bool WsfPM_ZoneDefinition::UseOffset ( ) const

Returns whether the points on this polygonal zone are defined as an offset from a position.

References WsfPProxyValue::GetAttr(), WsfPProxyValue::GetBoolValue(), WsfPProxyNode::GetValue(), and WsfPM_ZoneDefinition().

◆ UsePolar()

bool WsfPM_ZoneDefinition::UsePolar ( ) const

Returns whether the points on this polygonal zone are defined using polar coordinates.

References WsfPProxyValue::GetAttr(), WsfPProxyValue::GetBoolValue(), WsfPProxyNode::GetValue(), and WsfPM_ZoneDefinition().

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

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ AuxDataMap

Member Enumeration Documentation

◆ DefinitionType

Constructor & Destructor Documentation

◆ WsfPM_ZoneDefinition() [1/2]

◆ WsfPM_ZoneDefinition() [2/2]

Member Function Documentation

◆ AnchorPlatformAltitude()

◆ AnchorPlatformNode()

◆ AuxData()

◆ GetDefinitionType()

◆ GetFillColor()

◆ GetLineColor()

◆ GetPoint()

◆ GetPointNode()

◆ Heading()

◆ HeadingNode()

◆ IsAbsolute()

◆ IsReferencePlatformValid()

◆ LateralAxis()

◆ LongitudinalAxis()

◆ MaximumAltitude()

◆ MaximumRadius()

◆ MinimumAltitude()

◆ MinimumRadius()

◆ Negative()

◆ PointCount()

◆ PointList()

◆ Points()

◆ Position()

◆ PositionNode()

◆ ReferencePlatform()

◆ ReferencePlatformNode()

◆ ReferencePoint() [1/3]

◆ ReferencePoint() [2/3]

◆ ReferencePoint() [3/3]

◆ ReferenceZone()

◆ ReferenceZoneNode()

◆ SetDefinitionType()

◆ StartAngle()

◆ StopAngle()

◆ UseLatLon()

◆ UseMGRS()

◆ UseOffset()

◆ UsePolar()