WsfPM_Zone Class Reference
#include <WsfPM_Zone.hpp>
Inheritance diagram for WsfPM_Zone:
Collaboration diagram for WsfPM_Zone:
Public Types | |
| enum | ZoneType { cZONE_SET , cZONE_DEFINITION } |
| using | Point = UtVec2d |
Public Member Functions | |
| 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. | |
| virtual ut::optional< UtColor > | GetFillColor () const |
| virtual ut::optional< UtColor > | GetLineColor () const |
| 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
◆ Point
| using WsfPM_Zone::Point = UtVec2d |
Member Enumeration Documentation
◆ ZoneType
| enum WsfPM_Zone::ZoneType |
Constructor & Destructor Documentation
◆ WsfPM_Zone() [1/2]
|
inline |
◆ WsfPM_Zone() [2/2]
|
inline |
References WsfPProxyNode::WsfPProxyNode().
Member Function Documentation
◆ GetFillColor()
|
virtual |
Reimplemented in WsfPM_ZoneDefinition.
References ColorProxyUtil::GetColor(), WsfPM_ZoneDefinition::GetFillColor(), GetSourceZone(), and IsDefinition().
◆ GetLineColor()
|
virtual |
Reimplemented in WsfPM_ZoneDefinition.
References ColorProxyUtil::GetColor(), WsfPM_ZoneDefinition::GetLineColor(), GetSourceZone(), and IsDefinition().
◆ GetReferencingZones()
| std::vector< WsfPM_Zone > WsfPM_Zone::GetReferencingZones | ( | ) | const |
Returns a list of zones that reference this zone.
References WsfPM_ObjectMapT< TYPE >::GetAllValuesT(), WsfPProxyNode::GetName(), WsfPProxyNode::IsValid(), WsfPM_Root::platforms(), WsfPM_ZoneDefinition::ReferenceZone(), WsfPProxyNode::Root(), WsfPM_Zone(), and WsfPM_Root::zones().
◆ GetSourceZone()
| WsfPM_Zone WsfPM_Zone::GetSourceZone | ( | ) | const |
References WsfPProxyNode::GetInherited(), WsfPProxyNode::IsOfBasicType(), WsfPM_Zone(), and WsfPProxyNode::WsfPProxyNode().
Referenced by GetFillColor(), and GetLineColor().
◆ GetUsingZoneSets()
| std::vector< WsfPM_ZoneSet > WsfPM_Zone::GetUsingZoneSets | ( | ) | const |
Returns a list of zone sets that use this zone.
References WsfPM_ObjectMapT< TYPE >::GetAllValuesT(), WsfPProxyNode::GetName(), WsfPProxyNode::IsValid(), ParentPlatform(), ParentPlatformNode(), WsfPProxyNode::Root(), WsfPM_Zone(), WsfPM_Platform::Zone(), and WsfPM_Root::zones().
◆ IsDefinition()
|
inline |
References WsfPProxyValue::GetType(), WsfPProxyNode::GetValue(), and WsfPProxyType::mTypeName.
Referenced by GetFillColor(), and GetLineColor().
◆ IsZoneSet()
|
inline |
References WsfPProxyValue::GetType(), WsfPProxyNode::GetValue(), and WsfPProxyType::mTypeName.
◆ ParentPlatform()
| std::string WsfPM_Zone::ParentPlatform | ( | ) | const |
Returns the name of the parent platform, or "Global Zones" if there is no parent platform.
References WsfPM_ObjectMap::Exists(), WsfPProxyNode::GetPath(), WsfPM_Root::platforms(), WsfPProxyNode::Root(), and WsfPProxyPath::ToString().
Referenced by GetUsingZoneSets(), ParentPlatformNode(), WsfPM_ZoneDefinition::ReferenceZoneNode(), and wizard::Zone::UpdateZone().
◆ ParentPlatformNode()
| WsfPM_Platform WsfPM_Zone::ParentPlatformNode | ( | ) | const |
Returns the platform proxy node representing this zone's parent platform.
References WsfPM_ObjectMap::Find(), WsfPProxyNode::IsValid(), ParentPlatform(), WsfPM_Root::platforms(), and WsfPProxyNode::Root().
Referenced by WsfPM_ZoneDefinition::AnchorPlatformNode(), GetUsingZoneSets(), WsfPM_ZoneDefinition::Heading(), and WsfPM_ZoneDefinition::Position().
◆ Rename()
| bool WsfPM_Zone::Rename | ( | std::string | aNewName | ) |
References WsfPM_ObjectMap::CanMove(), WsfPProxyNode::GetName(), WsfPProxyNode::GetParent(), WsfPProxyNode::GetPath(), WsfPProxyNode::GetProxy(), WsfPProxyNode::Invalidate(), WsfPProxyNode::IsA_StructTypeOf(), WsfPM_ObjectMap::Move(), WsfPProxyNode::mPath, WsfPProxy::RecordObjectRename(), WsfPProxyNode::Root(), WsfPProxyNode::WsfPProxyNode(), WsfPM_Platform::Zone(), and WsfPM_Root::zones().
The documentation for this class was generated from the following files: