#include <hps.h>

Inheritance diagram for HPS::AttributeLockKit:
HPS::Kit HPS::Object

Public Member Functions

 AttributeLockKit ()
 
 AttributeLockKit (AttributeLockKit const &in_kit)
 
 AttributeLockKit (AttributeLockKit &&in_that)
 
bool Empty () const
 
bool Equals (AttributeLockKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (AttributeLockKit const &in_kit) const
 
AttributeLockKitoperator= (AttributeLockKit &&in_that)
 
AttributeLockKitoperator= (AttributeLockKit const &in_kit)
 
bool operator== (AttributeLockKit const &in_kit) const
 
void Set (AttributeLockKit const &in_kit)
 
AttributeLockKitSetLock (AttributeLock::Type in_type, bool in_state=true)
 
AttributeLockKitSetLock (AttributeLockTypeArray const &in_types, BoolArray const &in_states)
 
AttributeLockKitSetSubsegmentLockOverride (AttributeLock::Type in_type, bool in_state=true)
 
AttributeLockKitSetSubsegmentLockOverride (AttributeLockTypeArray const &in_types, BoolArray const &in_states)
 
void Show (AttributeLockKit &out_kit) const
 
bool ShowLock (AttributeLock::Type in_type, bool &out_state) const
 
bool ShowLock (AttributeLockTypeArray &out_types, BoolArray &out_states) const
 
bool ShowSubsegmentLockOverride (AttributeLock::Type in_type, bool &out_state) const
 
bool ShowSubsegmentLockOverride (AttributeLockTypeArray &out_types, BoolArray &out_states) const
 
AttributeLockKitUnsetEverything ()
 
AttributeLockKitUnsetLock (AttributeLock::Type in_type=AttributeLock::Type::Everything)
 
AttributeLockKitUnsetLock (AttributeLockTypeArray const &in_types)
 
AttributeLockKitUnsetSubsegmentLockOverride (AttributeLock::Type in_type=AttributeLock::Type::Everything)
 
AttributeLockKitUnsetSubsegmentLockOverride (AttributeLockTypeArray const &in_types)
 
virtual ~AttributeLockKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static AttributeLockKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::AttributeLockKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The HPS::AttributeLockKit class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. This control is used to set and unset attribute locks at the segment level. Calling HPS::AttributeLockKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ AttributeLockKit() [1/3]

HPS::AttributeLockKit::AttributeLockKit ( )

Initializes an empty kit.

◆ AttributeLockKit() [2/3]

HPS::AttributeLockKit::AttributeLockKit ( AttributeLockKit const &  in_kit)

Copies the kit in_kit into this kit.

◆ AttributeLockKit() [3/3]

HPS::AttributeLockKit::AttributeLockKit ( AttributeLockKit &&  in_that)

The move constructor creates a AttributeLockKit by transferring the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a AttributeLockKit to take the impl from.

◆ ~AttributeLockKit()

virtual HPS::AttributeLockKit::~AttributeLockKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::AttributeLockKit::Empty ( ) const
virtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::AttributeLockKit::Equals ( AttributeLockKit const &  in_kit) const

Check if the source AttributeLockKit is equivalent to this object.

Parameters
in_kitThe source AttributeLockKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static AttributeLockKit HPS::AttributeLockKit::GetDefault ( )
static

Creates an AttributeLockKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
An AttributeLockKit with the default settings.

◆ ObjectType()

HPS::Type HPS::AttributeLockKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Kit.

◆ operator!=()

bool HPS::AttributeLockKit::operator!= ( AttributeLockKit const &  in_kit) const

Check if the source AttributeLockKit is not equivalent to this object.

Parameters
in_kitThe source AttributeLockKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

AttributeLockKit& HPS::AttributeLockKit::operator= ( AttributeLockKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a AttributeLockKit to take the impl from.
Returns
A reference to this AttributeLockKit.

◆ operator=() [2/2]

AttributeLockKit& HPS::AttributeLockKit::operator= ( AttributeLockKit const &  in_kit)

Copies the source AttributeLockKit into this object.

Parameters
in_kitThe source AttributeLockKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::AttributeLockKit::operator== ( AttributeLockKit const &  in_kit) const

Check if the source AttributeLockKit is equivalent to this object.

Parameters
in_kitThe source AttributeLockKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::AttributeLockKit::Set ( AttributeLockKit const &  in_kit)

Copies the source AttributeLockKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetLock() [1/2]

AttributeLockKit& HPS::AttributeLockKit::SetLock ( AttributeLock::Type  in_type,
bool  in_state = true 
)

Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.

Parameters
in_typeThe type of attribute to lock or unlock.
in_stateWhether the attribute should be locked.
Returns
A reference to this object.
See also
Attribute lock default value

◆ SetLock() [2/2]

AttributeLockKit& HPS::AttributeLockKit::SetLock ( AttributeLockTypeArray const &  in_types,
BoolArray const &  in_states 
)

Applies attribute locks that prevents attributes of the chosen types from being modified in child segments.

Parameters
in_typesAn array of attribute types that should be locked or unlocked.
in_statesAn array of bools with each one indicating whether the corresponding type in in_types should be locked.
Returns
A reference to this object.

◆ SetSubsegmentLockOverride() [1/2]

AttributeLockKit& HPS::AttributeLockKit::SetSubsegmentLockOverride ( AttributeLock::Type  in_type,
bool  in_state = true 
)

Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. This method designates a particular lock as a "super lock" that cannot be overridden by subsegments.

Parameters
in_typeThe type of attribute lock that should be ignored in subsegments.
in_stateWhether the attribute lock should override locks in subsegments.
Returns
A reference to this object.

◆ SetSubsegmentLockOverride() [2/2]

AttributeLockKit& HPS::AttributeLockKit::SetSubsegmentLockOverride ( AttributeLockTypeArray const &  in_types,
BoolArray const &  in_states 
)

Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. This method designates a collection of locks as a "super locks" that cannot be overridden by subsegments.

Parameters
in_typesAn array of types of attribute locks that should be ignored in subsegments.
in_statesAn array of bools with each one indicating whether the corresponding attribute lock in in_types should override locks in subsegments.
Returns
A reference to this object.

◆ Show()

void HPS::AttributeLockKit::Show ( AttributeLockKit out_kit) const

Copies this object into the given AttributeLockKit.

Parameters
out_kitThe AttributeLockKit to populate with the contents of this object.

◆ ShowLock() [1/2]

bool HPS::AttributeLockKit::ShowLock ( AttributeLock::Type  in_type,
bool &  out_state 
) const

Shows the state of a particular attribute lock.

Parameters
in_typeThe type of attribute lock to be queried.
out_stateWhether the attribute is locked.
Returns
true if the setting is valid, false otherwise.

◆ ShowLock() [2/2]

bool HPS::AttributeLockKit::ShowLock ( AttributeLockTypeArray out_types,
BoolArray out_states 
) const

Shows the state of all attribute locks.

Parameters
out_typesAn array of types that have an attribute lock setting.
out_statesAn array of bools with each indicating whether the corresponding entry in in_types is locked.
Returns
true if the setting is valid, false otherwise.

◆ ShowSubsegmentLockOverride() [1/2]

bool HPS::AttributeLockKit::ShowSubsegmentLockOverride ( AttributeLock::Type  in_type,
bool &  out_state 
) const

Shows the state of a particular subsegment lock override.

Parameters
in_typeThe type of attribute lock to be queried.
out_stateWhether the attribute lock will override locks in subsegments.
Returns
true if the setting is valid, false otherwise.

◆ ShowSubsegmentLockOverride() [2/2]

bool HPS::AttributeLockKit::ShowSubsegmentLockOverride ( AttributeLockTypeArray out_types,
BoolArray out_states 
) const

Shows the state of all subsegment lock overrides.

Parameters
out_typesAn array of types that have a subsegment lock override setting.
out_statesAn array of bools with each indicating whether the corresponding entry in in_types is will be ignored in subsegments.
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

AttributeLockKit& HPS::AttributeLockKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetLock() [1/2]

AttributeLockKit& HPS::AttributeLockKit::UnsetLock ( AttributeLock::Type  in_type = AttributeLock::Type::Everything)

Removes an attribute lock setting.

Returns
A reference to this object.

◆ UnsetLock() [2/2]

AttributeLockKit& HPS::AttributeLockKit::UnsetLock ( AttributeLockTypeArray const &  in_types)

Removes a collection of attribute lock settings.

Returns
A reference to this object.

◆ UnsetSubsegmentLockOverride() [1/2]

AttributeLockKit& HPS::AttributeLockKit::UnsetSubsegmentLockOverride ( AttributeLock::Type  in_type = AttributeLock::Type::Everything)

Removes a subsegment lock override setting.

Returns
A reference to this object.

◆ UnsetSubsegmentLockOverride() [2/2]

AttributeLockKit& HPS::AttributeLockKit::UnsetSubsegmentLockOverride ( AttributeLockTypeArray const &  in_types)

Removes a collection of subsegment lock override settings.

Returns
A reference to this object.

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