< Home

< Table of Contents

REFERENCE MANUAL

HPS.SprocketPath Class Reference
Inheritance diagram for HPS.SprocketPath:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SprocketPath in_that)
 
HPS.Canvas GetCanvas ()
 Returns the Canvas associated with this SprocketPath More...
 
override int GetHashCode ()
 
HPS.KeyPath GetKeyPath ()
 Creates a key path from the model segment up to the canvas window key, including all segments and include keys along the way. More...
 
HPS.Layout GetLayout ()
 Returns the Layout associated with this SprocketPath More...
 
HPS.Model GetModel ()
 Returns the Model associated with this SprocketPath More...
 
HPS.View GetView ()
 Returns the View associated with this SprocketPath More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.SprocketPath in_that)
 
 SprocketPath (HPS.Model in_model, HPS.View in_view, HPS.Layout in_layout, HPS.Canvas in_canvas)
 
 SprocketPath (HPS.Canvas in_canvas, HPS.Layout in_layout, HPS.View in_view, HPS.Model in_model)
 
 SprocketPath (HPS.Canvas in_canvas, ulong in_layer)
 
 SprocketPath (HPS.Canvas in_canvas)
 
 SprocketPath (HPS.SprocketPath that)
 
- Public Member Functions inherited from HPS.Sprocket
 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 bool operator!= (HPS.SprocketPath a, HPS.SprocketPath b)
 
static bool operator== (HPS.SprocketPath a, HPS.SprocketPath 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

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

Member Function Documentation

HPS.Canvas HPS.SprocketPath.GetCanvas ( )

Returns the Canvas associated with this SprocketPath

HPS.KeyPath HPS.SprocketPath.GetKeyPath ( )

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.

Returns
A key path from the model segment to the canvas window key.
HPS.Layout HPS.SprocketPath.GetLayout ( )

Returns the Layout associated with this SprocketPath

HPS.Model HPS.SprocketPath.GetModel ( )

Returns the Model associated with this SprocketPath

HPS.View HPS.SprocketPath.GetView ( )

Returns the View associated with this SprocketPath

override HPS.Type HPS.SprocketPath.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.


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