class HPS::SprocketPath : public HPS::Sprocket

The SprocketPath class is a utility class which can be used to automatically obtain a KeyPath from the Model to the Canvas.

Public Functions

bool Equals(SprocketPath const &in_that) const
Canvas GetCanvas() const

Returns the Canvas associated with this SprocketPath

KeyPath GetKeyPath() const

Creates a key path from the model segment up to the canvas window key, including all segments and include keys along the way. This can be used to facilitate highlighting or gathering of net attributes.


A key path from the model segment to the canvas window key.

Layout GetLayout() const

Returns the Layout associated with this SprocketPath

Model GetModel() const

Returns the Model associated with this SprocketPath

View GetView() const

Returns the View associated with this SprocketPath

inline virtual HPS::Type ObjectType() const

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


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

bool operator!=(SprocketPath const &in_that) const
SprocketPath &operator=(SprocketPath const &in_that)
bool operator==(SprocketPath const &in_that) const
void Set(SprocketPath const &in_that)
SprocketPath(Canvas const &in_canvas, Layout const &in_layout, View const &in_view, Model const &in_model)
SprocketPath(Canvas const &in_canvas, size_t in_layer = 0)
SprocketPath(Model const &in_model, View const &in_view, Layout const &in_layout, Canvas const &in_canvas)
SprocketPath(SprocketPath const &that)

Public Static Attributes

static const HPS::Type staticType = HPS::Type::SprocketPath