< Home

< Table of Contents

REFERENCE MANUAL

HPS.ComponentPath Class Reference

The ComponentPath contains an array of keys, organized from leaf to root. More...

Inheritance diagram for HPS.ComponentPath:
HPS.Sprocket HPS.Object

Public Member Functions

HPS.ComponentPath Append (HPS.Component in_component)
 Appends the supplied Component into this object. More...
 
HPS.ComponentPath Append (HPS.ComponentPath in_path)
 Appends the supplied key into this object. More...
 
HPS.ComponentPath Append (HPS.Component[] in_components)
 Appends the supplied key into this object. More...
 
 ComponentPath ()
 Creates an uninitialized key path that refers to no database objects. More...
 
 ComponentPath (HPS.Component[] in_components)
 Creates a new ComponentPath object based on the supplied path. More...
 
 ComponentPath (HPS.ComponentPath in_that)
 Copies in_that into this key path. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ComponentPath in_that)
 Check if the source ComponentPath is equivalent to this object. More...
 
HPS.Component[] GetComponents ()
 Gets the components defining this ComponentPath. More...
 
override int GetHashCode ()
 
HPS.KeyPath[] GetKeyPaths ()
 Gets the KeyPath objects corresponding to this ComponentPath. More...
 
HPS.KeyPath[] GetKeyPaths (HPS.Canvas in_canvas, ulong in_layer)
 Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer. More...
 
HPS.KeyPath[] GetKeyPaths (HPS.Canvas in_canvas)
 Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer. More...
 
void Hide (HPS.Canvas in_canvas, ulong in_layer)
 Hides this ComponentPath under the given Canvas in the specified layer. More...
 
void Hide (HPS.Canvas in_canvas)
 Hides this ComponentPath under the given Canvas in the specified layer. More...
 
void Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options)
 Highlights this ComponentPath with the provided options under the given Canvas in layer zero. More...
 
void Highlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options)
 Highlights this ComponentPath with the provided options under the given Canvas in the specified layer. More...
 
void Isolate (HPS.Canvas in_canvas, ulong in_layer)
 Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. More...
 
void Isolate (HPS.Canvas in_canvas)
 Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.ComponentPath in_that)
 Copies the supplied path into this object. More...
 
HPS.ComponentPath SetComponents (HPS.Component[] in_components)
 Copies an array of components into this object. More...
 
void Show (HPS.Canvas in_canvas, ulong in_layer)
 Shows this ComponentPath under the given Canvas in the specified layer. More...
 
void Show (HPS.Canvas in_canvas)
 Shows this ComponentPath under the given Canvas in the specified layer. More...
 
void Unhighlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options)
 Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero. More...
 
void Unhighlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options)
 Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
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 void Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas, ulong in_layer)
 
static void Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas)
 
static bool operator!= (HPS.ComponentPath a, HPS.ComponentPath b)
 
static bool operator== (HPS.ComponentPath a, HPS.ComponentPath 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.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ComponentPath contains an array of keys, organized from leaf to root.

It allows the user to perform a number of queries along that path including accumulating net attributes and converting coordinates.

Constructor & Destructor Documentation

HPS.ComponentPath.ComponentPath ( )

Creates an uninitialized key path that refers to no database objects.

HPS.ComponentPath.ComponentPath ( HPS.Component[]  in_components)

Creates a new ComponentPath object based on the supplied path.

HPS.ComponentPath.ComponentPath ( HPS.ComponentPath  in_that)

Copies in_that into this key path.

Member Function Documentation

HPS.ComponentPath HPS.ComponentPath.Append ( HPS.Component  in_component)

Appends the supplied Component into this object.

Same as operator+= function.

Returns
A reference to this object.
HPS.ComponentPath HPS.ComponentPath.Append ( HPS.ComponentPath  in_path)

Appends the supplied key into this object.

Same as operator+= function.

Returns
A reference to this object.
HPS.ComponentPath HPS.ComponentPath.Append ( HPS.Component[]  in_components)

Appends the supplied key into this object.

Same as operator+= function.

Returns
A reference to this object.
bool HPS.ComponentPath.Equals ( HPS.ComponentPath  in_that)

Check if the source ComponentPath is equivalent to this object.

Returns
true if the objects are equivalent, false otherwise.
HPS.Component [] HPS.ComponentPath.GetComponents ( )

Gets the components defining this ComponentPath.

Returns
The components defining this ComponentPath.
HPS.KeyPath [] HPS.ComponentPath.GetKeyPaths ( )

Gets the KeyPath objects corresponding to this ComponentPath.

These key paths will include all possible paths which include the path components and all Canvas, Layout and View paths which include the Model which contains the path components.

Returns
All KeyPath objects for this component path.
HPS.KeyPath [] HPS.ComponentPath.GetKeyPaths ( HPS.Canvas  in_canvas,
ulong  in_layer 
)

Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> the returned KeyPath objects should reference.
in_layerThe layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> the returned KeyPath objects should reference.
Returns
The KeyPath objects for this component path which are included by the specified Canvas and layer.
HPS.KeyPath [] HPS.ComponentPath.GetKeyPaths ( HPS.Canvas  in_canvas)

Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> the returned KeyPath objects should reference.
Returns
The KeyPath objects for this component path which are included by the specified Canvas and layer.
void HPS.ComponentPath.Hide ( HPS.Canvas  in_canvas,
ulong  in_layer 
)

Hides this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to hide the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
in_layerThe layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to hide the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
void HPS.ComponentPath.Hide ( HPS.Canvas  in_canvas)

Hides this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to hide the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
void HPS.ComponentPath.Highlight ( HPS.Canvas  in_canvas,
HPS.HighlightOptionsKit  in_options 
)

Highlights this ComponentPath with the provided options under the given Canvas in layer zero.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the highlight.
in_optionsThe options to use to perform the highlight.
void HPS.ComponentPath.Highlight ( HPS.Canvas  in_canvas,
ulong  in_layer,
HPS.HighlightOptionsKit  in_options 
)

Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the highlight.
in_layerThe layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the highlight.
in_optionsThe options to use to perform the highlight.
void HPS.ComponentPath.Isolate ( HPS.Canvas  in_canvas,
ulong  in_layer 
)

Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to isolate the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
in_layerThe layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to isolate the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
void HPS.ComponentPath.Isolate ( HPS.Canvas  in_canvas)

Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to isolate the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
override HPS.Type HPS.ComponentPath.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.ComponentPath.Set ( HPS.ComponentPath  in_that)

Copies the supplied path into this object.

Parameters
in_thatThe source of the copy.
HPS.ComponentPath HPS.ComponentPath.SetComponents ( HPS.Component[]  in_components)

Copies an array of components into this object.

Returns
A reference to this object.
void HPS.ComponentPath.Show ( HPS.Canvas  in_canvas,
ulong  in_layer 
)

Shows this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to show the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
in_layerThe layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to show the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
void HPS.ComponentPath.Show ( HPS.Canvas  in_canvas)

Shows this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to show the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>.
void HPS.ComponentPath.Unhighlight ( HPS.Canvas  in_canvas,
HPS.HighlightOptionsKit  in_options 
)

Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the unhighlight.
in_optionsThe options to use to perform the unhighlight.
void HPS.ComponentPath.Unhighlight ( HPS.Canvas  in_canvas,
ulong  in_layer,
HPS.HighlightOptionsKit  in_options 
)

Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.

Parameters
in_canvasThe <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the unhighlight.
in_layerThe layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the unhighlight.
in_optionsThe options to use to perform the unhighlight.

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