Inheritance diagram for HPS.HCA.Model:

Public Member Functions

virtual void Dispose ()
 
bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HCA.Model other)
 
override int GetHashCode ()
 
void Hide (HPS.Canvas in_canvas, Int64 in_node_id)
 
void Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_highlight_options, Int64 in_node_id)
 
void Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_highlight_options, Int64[] in_node_ids)
 
bool IsHidden (Int64 in_node_id)
 
bool IsHighlighted (Int64 in_node_id)
 
void Isolate (HPS.Canvas in_canvas, Int64 in_node_id)
 
 Model ()
 
 Model (HPS.Model in_model)
 
 Model (HPS.HCA.Model that)
 
void OnHighlightUnhighlight ()
 
bool RequestNodeProperties (Int64 in_node_id, out UInt32 out_request_id)
 
bool RetrieveNodeProperties (UInt32 in_request_id, UInt32 in_timeout_ms, out Int64 out_node_id, out bool out_valid, out string[] out_keys, out string[] out_values)
 
void Show (HPS.Canvas in_canvas, Int64 in_node_id)
 
void ShowAll (HPS.Canvas in_canvas)
 
bool ShowNodeChildren (Int64 in_node_id, out Int64[] out_ids)
 
bool ShowNodeFromKeyPath (HPS.KeyPath in_key_path, out Int64 out_node_id)
 
bool ShowNodeName (Int64 in_node_id, out string out_name)
 
bool ShowNodeParent (Int64 in_node_id, out Int64 out_parent_id)
 
bool ShowRootNode (out Int64 out_node_id)
 
void Unhighlight (HPS.Canvas in_canvas, Int64 in_node_id)
 
void UnhighlightAll (HPS.Canvas in_canvas)
 
void Zoom (HPS.Canvas in_canvas, Int64 in_node_id)
 

Static Public Member Functions

static bool operator!= (HPS.HCA.Model a, HPS.HCA.Model b)
 
static bool operator== (HPS.HCA.Model a, HPS.HCA.Model b)
 

Protected Member Functions

virtual void deleteCptr ()
 

Protected Attributes

bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The Model class provides interactions with a HCAModel

Constructor & Destructor Documentation

◆ Model() [1/3]

HPS.HCA.Model.Model ( )
inline

Constructs an uninitialized HCA.Model.

◆ Model() [2/3]

HPS.HCA.Model.Model ( HPS.Model  in_model)
inline

Constructs a HCA.Model under an existing HPS.Model.

Parameters
in_modelthe HPS.Model under which to create an HCA.Model.

◆ Model() [3/3]

HPS.HCA.Model.Model ( HPS.HCA.Model  that)
inline

Copy constructor. This constructor creates an HCA.Model which shares the same resources of the source HCA.Model.

Member Function Documentation

◆ Empty()

bool HPS.HCA.Model.Empty ( )
inline

Checks the state of the Model.

Returns
true if this Model is uninitialized, false otherwise.

◆ Equals()

bool HPS.HCA.Model.Equals ( HPS.HCA.Model  other)
inline

Check if the source Model is equivalent to this Model.

Parameters
otherThe source Model to compare to this Model.
Returns
true if the objects are equivalent, false otherwise.

◆ Hide()

void HPS.HCA.Model.Hide ( HPS.Canvas  in_canvas,
Int64  in_node_id 
)
inline

Hides the specified node under the given Canvas. This makes the selected node invisible. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to hide the node.
in_node_idThe ID of the node to be hidden

◆ Highlight() [1/2]

void HPS.HCA.Model.Highlight ( HPS.Canvas  in_canvas,
HPS.HighlightOptionsKit  in_highlight_options,
Int64  in_node_id 
)
inline

Highlights the specified node under the given Canvas, using the options provided. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to highlight the node.
in_highlight_optionsThe options to be used when highlighting in_node_id.
in_node_idThe ID of the node to be highlighted

◆ Highlight() [2/2]

void HPS.HCA.Model.Highlight ( HPS.Canvas  in_canvas,
HPS.HighlightOptionsKit  in_highlight_options,
Int64 []  in_node_ids 
)
inline

Highlights the specified nodes under the given Canvas, using the options provided. All specified nodes will be highlighted using the same options. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to highlight the nodes.
in_highlight_optionsThe options to be used when highlighting in_node_ids.
in_node_idsan array of node IDs to be highlighted

◆ IsHidden()

bool HPS.HCA.Model.IsHidden ( Int64  in_node_id)
inline

Checks whether the given node is currently Hidden as a result of a Hide or Isolate operation. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_node_idThe ID of the node to examine.
Returns
true if the node is hidden, false otherwise.

◆ IsHighlighted()

bool HPS.HCA.Model.IsHighlighted ( Int64  in_node_id)
inline

Checks whether the given node is currently highlighted. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_node_idThe ID of the node to examine.
Returns
true if the node is highlighted, false otherwise.

◆ Isolate()

void HPS.HCA.Model.Isolate ( HPS.Canvas  in_canvas,
Int64  in_node_id 
)
inline

Shows only the specified node and hides the rest. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to isolate the node.
in_node_idThe ID of the node to isolate.

◆ OnHighlightUnhighlight()

void HPS.HCA.Model.OnHighlightUnhighlight ( )
inline

This convenience function performs the HCA.ModelTreeItem.OnHighlightUnhighlight function on the root item of the Model Tree See the description of HCA.ModelTreeItem.OnHighlightUnhighlight for more information.

◆ RequestNodeProperties()

bool HPS.HCA.Model.RequestNodeProperties ( Int64  in_node_id,
out UInt32  out_request_id 
)
inline

Requests properties for the specified node. throws HPS.InvalidObjectException is the Model is uninitialized. When the request has been fulfilled, an event of type HCA.RequestIdEvent will be injected to the Database's Event Dispatcher. Registering a handler to HCA.RequestIdEvent will allow the user to know when this request has completed. The value of HCA.RequestIdEvent.request_id object will match out_requested_id, returned by this function.

Parameters
in_node_idthe ID for the node whose properties should be collected.
out_request_idan ID which uniquely identifies this request
Returns
true if the node's properties were gathered successfully, false otherwise.

◆ RetrieveNodeProperties()

bool HPS.HCA.Model.RetrieveNodeProperties ( UInt32  in_request_id,
UInt32  in_timeout_ms,
out Int64  out_node_id,
out bool  out_valid,
out string []  out_keys,
out string []  out_values 
)
inline

Retrieves previously requested properties throws HPS.InvalidObjectException is the Model is uninitialized. Before retrieving properties, you should request them, using RequestNodeProperties. This function waits for the requested property to become available If your model's properties are not changing, it is sufficient to call RequestNodeProperties just once for each node ID of interest. Each property is returned as a pair or key and value. The out_keys and out_values parameters are two parallel arrays containing respectively the key and value of each property.

Parameters
in_request_ida unique ID representing a request for properties. This value is obtained through a call to RequestNodeProperties.
in_timeout_msthe maximum amount of time to wait while trying to retrieve the node properties, specified in milliseconds. Passing 0 means that the function will wait indefinitely until it can retrieve the properties.
out_node_idthe ID of the node for which properties are being returned.
out_validwhether the returned properties are valid.
out_keysthe property keys. Each entry in this array corresponds to the entry at the same index in the out_values array.
out_valuesthe property values. Each entry in this array corresponds to the entry at the same index in the out_keys array.
Returns
true if the node's properties were retrieved successfully, false otherwise.

◆ Show()

void HPS.HCA.Model.Show ( HPS.Canvas  in_canvas,
Int64  in_node_id 
)
inline

Shows the specified node under the given Canvas. This makes the selected node visible. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to show the node.
in_node_idThe ID of the node to be shown

◆ ShowAll()

void HPS.HCA.Model.ShowAll ( HPS.Canvas  in_canvas)
inline

Shows all nodes in the model, under the specified Canvas. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to show the nodes.

◆ ShowNodeChildren()

bool HPS.HCA.Model.ShowNodeChildren ( Int64  in_node_id,
out Int64 []  out_ids 
)
inline

Shows the IDs of the children of the requested node. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_node_idthe ID for the node whose children should be shown
out_idsan array of IDs representing the children of in_node_id.
Returns
true if the node's children were found successfully, false otherwise.

◆ ShowNodeFromKeyPath()

bool HPS.HCA.Model.ShowNodeFromKeyPath ( HPS.KeyPath  in_key_path,
out Int64  out_node_id 
)
inline

Given a KeyPath, the associated node ID is returned.

Parameters
in_key_paththe key path for which a node ID is being requested
out_node_idthe node ID that corresponds to in_key_path
Returns
true if the node ID is associated to in_key_path, false otherwise.

◆ ShowNodeName()

bool HPS.HCA.Model.ShowNodeName ( Int64  in_node_id,
out string  out_name 
)
inline

Shows the name for the requested node. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_node_idthe ID for the node whose name should be shown
out_namethe name of in_node_id, in the UTF8 locale. Might be an empty UTF8 object.
Returns
true if the node name was found successfully, false otherwise.

◆ ShowNodeParent()

bool HPS.HCA.Model.ShowNodeParent ( Int64  in_node_id,
out Int64  out_parent_id 
)
inline

Shows the ID of the parent of the requested node. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_node_idthe ID for the node whose parent should be shown
out_parent_idthe ID representing the parent of in_node_id. Might be an empty array
Returns
true if the node's parent was found successfully, false otherwise.

◆ ShowRootNode()

bool HPS.HCA.Model.ShowRootNode ( out Int64  out_node_id)
inline

Shows the node ID for the root node of the Model. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
out_node_idthe node ID for the root node of the Model.
Returns
true if the root node ID was found, false otherwise.

◆ Unhighlight()

void HPS.HCA.Model.Unhighlight ( HPS.Canvas  in_canvas,
Int64  in_node_id 
)
inline

Unhighlights the specified node under the given Canvas. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to unhighlight the node.
in_node_idThe ID of the node to be unhighlighted

◆ UnhighlightAll()

void HPS.HCA.Model.UnhighlightAll ( HPS.Canvas  in_canvas)
inline

Unhighlights all nodes in the model, under the specified Canvas. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to unhighlight the nodes.

◆ Zoom()

void HPS.HCA.Model.Zoom ( HPS.Canvas  in_canvas,
Int64  in_node_id 
)
inline

Smoothly zooms the camera to focus on the specified node. The transition lasts half a second. throws HPS.InvalidObjectException is the Model is uninitialized.

Parameters
in_canvasThe Canvas in which to zoom to the node.
in_node_idThe ID of the node to zoom to.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_hca/source/cs/HPS.HCA.cs