wizard::ZoneSet Class Reference

#include <ZoneSet.hpp>

Public Member Functions
	ZoneSet (const ZoneSet &aRhs)=delete
	ZoneSet (const WsfPM_Zone &aZone)
	~ZoneSet ()=default
void	UpdateZoneSet (const WsfPM_Zone &aZone)
void	RemoveZoneSet ()
	Visually removes the zone from the map display.
std::vector< Zone * >	GetZonesWithReferencePlatform (const std::string &aRefPlatName) const
bool	SubzoneReferencesPlatform (const std::string &aRefPlatName) const
Zone *	GetZoneByAttachment (const wkf::AttachmentZone *aAttachmentZone) const
std::string	GetZoneSetName () const
	Returns the name of the zone/zone set.
std::string	GetParentPlatformName () const
	Returns the name of the parent platform of this zone/zone set.
WsfPM_Zone	GetZoneSetNode () const
	Returns the node corresponding to this zone/zone set.
bool	IsGlobal () const
	Returns whether this zone/zone set is defined globally (i.e., not on a platform).

Constructor & Destructor Documentation

ZoneSet() [1/2]

wizard::ZoneSet::ZoneSet ( const ZoneSet & aRhs )

delete

References ZoneSet().

Referenced by ZoneSet().

ZoneSet() [2/2]

wizard::ZoneSet::ZoneSet

(

const WsfPM_Zone &

aZone

)

~ZoneSet()

wizard::ZoneSet::~ZoneSet ( )

default

References GetZoneByAttachment(), GetZonesWithReferencePlatform(), RemoveZoneSet(), SubzoneReferencesPlatform(), and UpdateZoneSet().

Member Function Documentation

GetParentPlatformName()

std::string wizard::ZoneSet::GetParentPlatformName ( ) const

inline

Returns the name of the parent platform of this zone/zone set.

GetZoneByAttachment()

wizard::Zone * wizard::ZoneSet::GetZoneByAttachment

(

const wkf::AttachmentZone *

aAttachmentZone

)

const

Finds a zone by checking attachment equality.

Parameters

aAttachmentZone

is an attachment zone to use as an equality check

Returns

a non-owning pointer to the corresponding zone, or nullptr if there is no zone

Referenced by ~ZoneSet().

GetZoneSetName()

std::string wizard::ZoneSet::GetZoneSetName ( ) const

inline

Returns the name of the zone/zone set.

GetZoneSetNode()

WsfPM_Zone wizard::ZoneSet::GetZoneSetNode ( ) const

inline

Returns the node corresponding to this zone/zone set.

GetZonesWithReferencePlatform()

std::vector< wizard::Zone * > wizard::ZoneSet::GetZonesWithReferencePlatform

(

const std::string &

aRefPlatName

)

const

Finds all subzones with the given reference platform.

Parameters

aRefPlatName

is the name of a platform

Returns

a vector containing zones that have the given platform as a reference platform

Referenced by ~ZoneSet().

IsGlobal()

bool wizard::ZoneSet::IsGlobal ( ) const

inline

Returns whether this zone/zone set is defined globally (i.e., not on a platform).

RemoveZoneSet()

void wizard::ZoneSet::RemoveZoneSet

(

)

Visually removes the zone from the map display.

Referenced by UpdateZoneSet(), and ~ZoneSet().

SubzoneReferencesPlatform()

bool wizard::ZoneSet::SubzoneReferencesPlatform

(

const std::string &

aRefPlatName

)

const

Returns whether any subzone uses the given platform as a reference platform.

Parameters

aRefPlatName

is the name of a platform

Returns

whether any subzone uses the given platform as a reference platform

Referenced by ~ZoneSet().

UpdateZoneSet()

void wizard::ZoneSet::UpdateZoneSet

(

const WsfPM_Zone &

aZone

)

Visually updates the zone set to match the given zone node.

Parameters

aZone

is the zone proxy node to refer to when updating the zone

References RemoveZoneSet().

Referenced by ~ZoneSet().

---

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

• ZoneSet.hpp
• ZoneSet.cpp