wizard::Zone Class Reference

#include <Zone.hpp>

Public Member Functions
	Zone (WsfPM_ZoneDefinition &aZoneNode, ZoneSet *aOwningZoneSetPtr, int aZoneSetIndex)
	~Zone ()=default
const std::string	GetReferencePlatformName () const
	Get the reference platform name.
void	RemoveZone ()
	Remove the zone and its anchor from the scenario.
bool	IsGlobal ()
	Get whether or not this is a global zone.
wkf::AttachmentZone *	GetZone ()
	Get the AttachmentZone associated with this zone.
const std::string	GetZoneSetName () const
	Get the zone set name.
const std::string	GetParentPlatformName () const
	Get the parent platform name.
std::string	GetDefinitionName () const
std::string	GetDefinitionParentPlatformName () const
	Get the definition's parent platform name.
void	LinkProxyCallbacks ()
void	UnlinkProxyCallbacks ()
WsfPM_Zone &	GetZoneProxyNode ()
	Get the zone proxy node.
void	UpdateZone (WsfPM_ZoneDefinition &aZone)
	Updates a zone along with it's anchor platform if necessary.

Constructor & Destructor Documentation

Zone()

wizard::Zone::Zone	(	WsfPM_ZoneDefinition &	aZoneNode,
		ZoneSet *	aOwningZoneSetPtr,
		int	aZoneSetIndex )

~Zone()

wizard::Zone::~Zone ( )

default

Member Function Documentation

GetDefinitionName()

std::string wizard::Zone::GetDefinitionName ( ) const

inline

GetDefinitionParentPlatformName()

std::string wizard::Zone::GetDefinitionParentPlatformName ( ) const

inline

Get the definition's parent platform name.

GetParentPlatformName()

const std::string wizard::Zone::GetParentPlatformName

(

)

const

Get the parent platform name.

GetReferencePlatformName()

const std::string wizard::Zone::GetReferencePlatformName ( ) const

inline

Get the reference platform name.

Returns

the reference platform name

GetZone()

wkf::AttachmentZone * wizard::Zone::GetZone ( )

inline

Get the AttachmentZone associated with this zone.

Returns

a pointer to the AttachmentZone associated with this zone

GetZoneProxyNode()

WsfPM_Zone & wizard::Zone::GetZoneProxyNode ( )

inline

Get the zone proxy node.

Returns

the zone proxy node

GetZoneSetName()

const std::string wizard::Zone::GetZoneSetName

(

)

const

Get the zone set name.

Returns

the zone set name

IsGlobal()

bool wizard::Zone::IsGlobal ( )

inline

Get whether or not this is a global zone.

Returns

true if this is a global zone

Referenced by UpdateZone().

LinkProxyCallbacks()

void wizard::Zone::LinkProxyCallbacks

(

)

References wizard::ProxyWatchNode::AnyUpdate, and wizard::WatchProxy().

RemoveZone()

void wizard::Zone::RemoveZone

(

)

Remove the zone and its anchor from the scenario.

References UnlinkProxyCallbacks().

Referenced by UpdateZone().

UnlinkProxyCallbacks()

void wizard::Zone::UnlinkProxyCallbacks

(

)

Referenced by RemoveZone().

UpdateZone()

void wizard::Zone::UpdateZone

(

WsfPM_ZoneDefinition &

aZone

)

Updates a zone along with it's anchor platform if necessary.

Parameters

aZone

is a proxy Zone node

References WsfPM_ZoneDefinition::cCIRCULAR, WsfPM_ZoneDefinition::cELLIPTICAL, WsfPM_ZoneDefinition::cPOLYGONAL, WsfPM_ZoneDefinition::cSPHERICAL, WsfPM_ZoneDefinition::cTYPE_NOT_SET, WsfPM_ZoneDefinition::GetDefinitionType(), WsfPProxyNode::GetName(), WsfPProxyNode::GetParent(), IsGlobal(), WsfProxy::BasicValue::IsUnset(), WsfPM_ZoneDefinition::LateralAxis(), WsfPM_ZoneDefinition::LongitudinalAxis(), WsfPM_Zone::ParentPlatform(), WsfPM_ZoneDefinition::Points(), WsfPM_ZoneDefinition::ReferencePlatform(), and RemoveZone().

---

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

• lib/source/map/Zone.hpp
• lib/source/map/Zone.cpp