< Home

< Table of Contents

REFERENCE MANUAL

HPS.AttributeLockKit Class Reference

The AttributeLockKit class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. More...

Inheritance diagram for HPS.AttributeLockKit:
HPS.Object

Public Member Functions

 AttributeLockKit ()
 Initializes an empty kit. More...
 
 AttributeLockKit (HPS.AttributeLockKit in_kit)
 Copies the kit in_kit into this kit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.AttributeLockKit in_kit)
 Check if the source AttributeLockKit is equivalent to this object. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.AttributeLockKit in_kit)
 Copies the source AttributeLockKit into this object. More...
 
HPS.AttributeLockKit SetLock (HPS.AttributeLock.Type in_type, bool in_state)
 Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments. More...
 
HPS.AttributeLockKit SetLock (HPS.AttributeLock.Type in_type)
 Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments. More...
 
HPS.AttributeLockKit SetLock (HPS.AttributeLock.Type[] in_types, bool[] in_states)
 Applies attribute locks that prevents attributes of the chosen types from being modified in child segments. More...
 
HPS.AttributeLockKit SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type, bool in_state)
 Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More...
 
HPS.AttributeLockKit SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type)
 Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More...
 
HPS.AttributeLockKit SetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types, bool[] in_states)
 Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More...
 
void Show (out HPS.AttributeLockKit out_kit)
 Copies this object into the given AttributeLockKit. More...
 
bool ShowLock (HPS.AttributeLock.Type in_type, out bool out_state)
 Shows the state of a particular attribute lock. More...
 
bool ShowLock (out HPS.AttributeLock.Type[] out_types, out bool[] out_states)
 Shows the state of all attribute locks. More...
 
bool ShowSubsegmentLockOverride (HPS.AttributeLock.Type in_type, out bool out_state)
 Shows the state of a particular subsegment lock override. More...
 
bool ShowSubsegmentLockOverride (out HPS.AttributeLock.Type[] out_types, out bool[] out_states)
 Shows the state of all subsegment lock overrides. More...
 
HPS.AttributeLockKit UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.AttributeLockKit UnsetLock (HPS.AttributeLock.Type in_type)
 Removes an attribute lock setting. More...
 
HPS.AttributeLockKit UnsetLock ()
 Removes an attribute lock setting. More...
 
HPS.AttributeLockKit UnsetLock (HPS.AttributeLock.Type[] in_types)
 Removes a collection of attribute lock settings. More...
 
HPS.AttributeLockKit UnsetSubsegmentLockOverride (HPS.AttributeLock.Type in_type)
 Removes a subsegment lock override setting. More...
 
HPS.AttributeLockKit UnsetSubsegmentLockOverride ()
 Removes a subsegment lock override setting. More...
 
HPS.AttributeLockKit UnsetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types)
 Removes a collection of subsegment lock override settings. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static HPS.AttributeLockKit GetDefault ()
 Creates an AttributeLockKit which contains the default settings. More...
 
static bool operator!= (HPS.AttributeLockKit a, HPS.AttributeLockKit b)
 
static bool operator== (HPS.AttributeLockKit a, HPS.AttributeLockKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The 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 AttributeLockKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

HPS.AttributeLockKit.AttributeLockKit ( )

Initializes an empty kit.

HPS.AttributeLockKit.AttributeLockKit ( HPS.AttributeLockKit  in_kit)

Copies the kit in_kit into this kit.

Member Function Documentation

override bool HPS.AttributeLockKit.Empty ( )
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.

bool HPS.AttributeLockKit.Equals ( HPS.AttributeLockKit  in_kit)

Check if the source AttributeLockKit is equivalent to this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_attribute_lock_kit" kindref="compound">AttributeLockKit</ref> to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.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.
override HPS.Type HPS.AttributeLockKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

void HPS.AttributeLockKit.Set ( HPS.AttributeLockKit  in_kit)

Copies the source AttributeLockKit into this object.

Parameters
in_kitThe source object to copy.
HPS.AttributeLockKit HPS.AttributeLockKit.SetLock ( HPS.AttributeLock.Type  in_type,
bool  in_state 
)

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.

Attribute lock default value

HPS.AttributeLockKit HPS.AttributeLockKit.SetLock ( HPS.AttributeLock.Type  in_type)

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.
Returns
A reference to this object.

Attribute lock default value

HPS.AttributeLockKit HPS.AttributeLockKit.SetLock ( HPS.AttributeLock.Type[]  in_types,
bool[]  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.
Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type,
bool  in_state 
)

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.
HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type)

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.
Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride ( HPS.AttributeLock.Type[]  in_types,
bool[]  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.

Returns
A reference to this object.
void HPS.AttributeLockKit.Show ( out HPS.AttributeLockKit  out_kit)

Copies this object into the given AttributeLockKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_attribute_lock_kit" kindref="compound">AttributeLockKit</ref> to populate with the contents of this object.
bool HPS.AttributeLockKit.ShowLock ( HPS.AttributeLock.Type  in_type,
out bool  out_state 
)

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.
bool HPS.AttributeLockKit.ShowLock ( out HPS.AttributeLock.Type[]  out_types,
out bool[]  out_states 
)

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.
bool HPS.AttributeLockKit.ShowSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type,
out bool  out_state 
)

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.
bool HPS.AttributeLockKit.ShowSubsegmentLockOverride ( out HPS.AttributeLock.Type[]  out_types,
out bool[]  out_states 
)

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.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock ( HPS.AttributeLock.Type  in_type)

Removes an attribute lock setting.

Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock ( )

Removes an attribute lock setting.

Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock ( HPS.AttributeLock.Type[]  in_types)

Removes a collection of attribute lock settings.

Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type)

Removes a subsegment lock override setting.

Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride ( )

Removes a subsegment lock override setting.

Returns
A reference to this object.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride ( HPS.AttributeLock.Type[]  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: