< Home

< Table of Contents

REFERENCE MANUAL

ComponentPath Class Reference

#include <sprk.h>

Inheritance diagram for ComponentPath:
Sprocket Object

Public Member Functions

ComponentPathAppend (Component const &in_component)
 
ComponentPathAppend (ComponentPath const &in_path)
 
ComponentPathAppend (ComponentArray const &in_components)
 
 ComponentPath ()
 
 ComponentPath (ComponentArray const &in_components)
 
 ComponentPath (size_t in_count, Component const in_components[])
 
 ComponentPath (ComponentPath const &in_that)
 
 ComponentPath (ComponentPath &&in_that)
 
bool Equals (ComponentPath const &in_that) const
 
ComponentArray GetComponents () const
 
KeyPathArray GetKeyPaths () const
 
KeyPathArray GetKeyPaths (Canvas const &in_canvas, size_t in_layer=0) const
 
void Hide (Canvas const &in_canvas, size_t in_layer=0)
 
void Highlight (Canvas const &in_canvas, HighlightOptionsKit const &in_options) const
 
void Highlight (Canvas const &in_canvas, size_t in_layer, HighlightOptionsKit const &in_options) const
 
void Isolate (Canvas const &in_canvas, size_t in_layer=0)
 
Type ObjectType () const
 
bool operator!= (ComponentPath const &in_that) const
 
ComponentPathoperator+= (Component const &in_component)
 
ComponentPathoperator+= (ComponentPath const &in_path)
 
ComponentPathoperator+= (ComponentArray const &in_components)
 
ComponentPathoperator= (ComponentPath &&in_that)
 
ComponentPathoperator= (ComponentPath const &in_that)
 
ComponentPathoperator= (ComponentArray const &in_path)
 
bool operator== (ComponentPath const &in_that) const
 
void Set (ComponentPath const &in_that)
 
ComponentPathSetComponents (ComponentArray const &in_components)
 
ComponentPathSetComponents (size_t in_count, Component const in_components[])
 
void Show (Canvas const &in_canvas, size_t in_layer=0)
 
void Unhighlight (Canvas const &in_canvas, HighlightOptionsKit const &in_options) const
 
void Unhighlight (Canvas const &in_canvas, size_t in_layer, HighlightOptionsKit const &in_options) const
 
virtual ~ComponentPath ()
 
- Public Member Functions inherited from Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Static Public Member Functions

static void Isolate (ComponentPathArray &in_components_to_be_isolated, Canvas const &in_canvas, size_t in_layer=0)
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Additional Inherited Members

- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 

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

ComponentPath::ComponentPath ( )

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

ComponentPath::ComponentPath ( ComponentArray const &  in_components)

Creates a new ComponentPath object based on the supplied path.

Parameters
in_pathAn array of keys arranged from leaf to root.
ComponentPath::ComponentPath ( size_t  in_count,
Component const  in_components[] 
)

Creates a new ComponentPath object based on the supplied path.

Parameters
in_path_countThe number of keys in the array.
in_pathAn array of keys arranged from leaf to root.
ComponentPath::ComponentPath ( ComponentPath const &  in_that)

Copies in_that into this key path.

ComponentPath::ComponentPath ( ComponentPath &&  in_that)

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

Parameters
in_thatAn rvalue reference to a ComponentPath to take the impl from.
virtual ComponentPath::~ComponentPath ( )
virtual

Releases a reference to the database object this object is tied to.

Member Function Documentation

ComponentPath& ComponentPath::Append ( Component const &  in_component)

Appends the supplied Component into this object. Same as operator+= function.

Parameters
in_keyThe Component to be appended to this.
Returns
A reference to this object.
ComponentPath& ComponentPath::Append ( ComponentPath const &  in_path)

Appends the supplied key into this object. Same as operator+= function.

Parameters
in_key_pathThe ComponentPath to be appended to this.
Returns
A reference to this object.
ComponentPath& ComponentPath::Append ( ComponentArray const &  in_components)

Appends the supplied key into this object. Same as operator+= function.

Parameters
in_key_arrayThe ComponentArray to be appended to this.
Returns
A reference to this object.
bool ComponentPath::Equals ( ComponentPath const &  in_that) const

Check if the source ComponentPath is equivalent to this object.

Parameters
in_kitThe source ComponentPath to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
ComponentArray ComponentPath::GetComponents ( ) const

Gets the components defining this ComponentPath.

Returns
The components defining this ComponentPath.
KeyPathArray ComponentPath::GetKeyPaths ( ) const

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.
KeyPathArray ComponentPath::GetKeyPaths ( Canvas const &  in_canvas,
size_t  in_layer = 0 
) const

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

Returns
The KeyPath objects for this component path which are included by the specified Canvas and layer.
Parameters
in_canvasThe Canvas the returned KeyPath objects should reference.
in_layerThe layer under the provided Canvas the returned KeyPath objects should reference.
void ComponentPath::Hide ( Canvas const &  in_canvas,
size_t  in_layer = 0 
)

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

Parameters
in_canvasThe Canvas in which to hide the ComponentPath.
in_layerThe layer under the provided Canvas in which to hide the ComponentPath.
void ComponentPath::Highlight ( Canvas const &  in_canvas,
HighlightOptionsKit const &  in_options 
) const

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

Parameters
in_canvasThe Canvas in which to perform the highlight.
in_optionsThe options to use to perform the highlight.
void ComponentPath::Highlight ( Canvas const &  in_canvas,
size_t  in_layer,
HighlightOptionsKit const &  in_options 
) const

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

Parameters
in_canvasThe Canvas in which to perform the highlight.
in_layerThe layer under the provided Canvas in which to perform the highlight.
in_optionsThe options to use to perform the highlight.
void ComponentPath::Isolate ( Canvas const &  in_canvas,
size_t  in_layer = 0 
)

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

Parameters
in_canvasThe Canvas in which to isolate the ComponentPath.
in_layerThe layer under the provided Canvas in which to isolate the ComponentPath.
Type ComponentPath::ObjectType ( ) const
inlinevirtual

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 Object.

bool ComponentPath::operator!= ( ComponentPath const &  in_that) const

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

Parameters
in_kitThe source ComponentPath to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.
ComponentPath& ComponentPath::operator+= ( Component const &  in_component)

Appends the supplied Component into this object. Same as Append function.

Parameters
in_keyThe key to be appended to this.
Returns
A reference to this object.
ComponentPath& ComponentPath::operator+= ( ComponentPath const &  in_path)

Appends the supplied ComponentPath into this object. Same as Append function.

Parameters
in_key_pathThe ComponentPath to be appended to this.
Returns
A reference to this object.
ComponentPath& ComponentPath::operator+= ( ComponentArray const &  in_components)

Appends the supplied ComponentArray into this object. Same as Append function.

Parameters
in_key_arrayThe ComponentArray to be appended to this.
Returns
A reference to this object.
ComponentPath& ComponentPath::operator= ( ComponentPath &&  in_that)

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

Parameters
in_thatAn rvalue reference to a ComponentPath to take the impl from.
Returns
A reference to this ComponentPath.
ComponentPath& ComponentPath::operator= ( ComponentPath const &  in_that)

Copies the supplied path into this object.

Parameters
in_thatThe source of the copy.
Returns
A reference to this object.
ComponentPath& ComponentPath::operator= ( ComponentArray const &  in_path)

Copies an array of keys into this object.

Parameters
in_pathThe source array, assumed to be arranged from leaf to root.
Returns
A reference to this object.
bool ComponentPath::operator== ( ComponentPath const &  in_that) const

Check if the source ComponentPath is equivalent to this object.

Parameters
in_kitThe source ComponentPath to compare to this object.
Returns
<sp an="" class="code">true if the objects are equivalent, false otherwise.
void ComponentPath::Set ( ComponentPath const &  in_that)

Copies the supplied path into this object.

Parameters
in_thatThe source of the copy.
ComponentPath& ComponentPath::SetComponents ( ComponentArray const &  in_components)

Copies an array of components into this object.

Parameters
in_keysThe source array, assumed to be arranged from leaf to root.
Returns
A reference to this object.
ComponentPath& ComponentPath::SetComponents ( size_t  in_count,
Component const  in_components[] 
)

Copies an array of components into this object.

Parameters
in_countthe number of components in the array.
in_componentsThe source array, assumed to arranged from leaf to root.
Returns
A reference to this object.
void ComponentPath::Show ( Canvas const &  in_canvas,
size_t  in_layer = 0 
)

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

Parameters
in_canvasThe Canvas in which to show the ComponentPath.
in_layerThe layer under the provided Canvas in which to show the ComponentPath.
void ComponentPath::Unhighlight ( Canvas const &  in_canvas,
HighlightOptionsKit const &  in_options 
) const

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

Parameters
in_canvasThe Canvas in which to perform the unhighlight.
in_optionsThe options to use to perform the unhighlight.
void ComponentPath::Unhighlight ( Canvas const &  in_canvas,
size_t  in_layer,
HighlightOptionsKit const &  in_options 
) const

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

Parameters
in_canvasThe Canvas in which to perform the unhighlight.
in_layerThe layer under the provided Canvas 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: