HPS::HCA::Model Class Reference

#include <sprk_hca.h>

Public Member Functions

bool Empty ()
 
bool Equals (Model const &other) const
 
void Hide (HPS::Canvas const &in_canvas, int64_t in_node_id)
 
void Highlight (HPS::Canvas const &in_canvas, HighlightOptionsKit const &in_highlight_options, int64_t in_node_id)
 
void Highlight (HPS::Canvas const &in_canvas, HighlightOptionsKit const &in_highlight_options, HPS::Int64Array const &in_node_ids)
 
bool IsHidden (int64_t in_node_id)
 
bool IsHighlighted (int64_t in_node_id)
 
void Isolate (HPS::Canvas const &in_canvas, int64_t in_node_id)
 
 Model ()
 
 Model (HPS::Model const &in_model)
 
 Model (Model const &that)
 
 Model (Model &&that)
 
void OnHighlightUnhighlight ()
 
bool operator!= (Model const &other) const
 
Modeloperator= (Model &&other)
 
bool operator== (Model const &other) const
 
bool RequestNodeProperties (int64_t in_node_id, uint32_t &out_request_id)
 
bool RetrieveNodeProperties (uint32_t in_request_id, int64_t &out_node_id, bool &out_valid, HPS::UTF8Array &out_keys, HPS::UTF8Array &out_values)
 
void Show (HPS::Canvas const &in_canvas, int64_t in_node_id)
 
void ShowAll (HPS::Canvas const &in_canvas)
 
bool ShowIncludePath (HPS::KeyPath &out_key_path)
 
bool ShowInstanceIncReference (InstanceInc const &instance_inc, HPS::KeyArray &out_reference_keys)
 
bool ShowInstanceIncs (int64_t in_node_id, InstanceIncArray &out_instance_incs)
 
bool ShowNode (InstanceInc const &in_instance_inc, int64_t &out_node_id)
 
bool ShowNodeAndIncFromKeyPath (HPS::KeyPath const &in_key_path, int64_t &in_node_id, HPS::HCA::InstanceInc &out_instanceInc)
 
bool ShowNodeChildren (int64_t in_node_id, HPS::Int64Array &out_ids)
 
bool ShowNodeName (int64_t in_node_id, HPS::UTF8 &out_name)
 
bool ShowNodeParent (int64_t in_node_id, int64_t &out_parent_id)
 
bool ShowRootNode (int64_t &out_node_id)
 
void Unhighlight (HPS::Canvas const &in_canvas, int64_t in_node_id)
 
void UnhighlightAll (HPS::Canvas const &in_canvas)
 
bool WaitForLoadToComplete (unsigned int in_timeout_ms=0)
 
void Zoom (HPS::Canvas const &in_canvas, int64_t in_node_id)
 

Friends

class ModelTreeItem
 

Detailed Description

The Model class provides interactions with a HCA Model

Constructor & Destructor Documentation

◆ Model() [1/3]

HPS::HCA::Model::Model ( )

Constructs an uninitialized HCA Model.

Returns
The uninitialized model.

◆ Model() [2/3]

HPS::HCA::Model::Model ( HPS::Model const &  in_model)

Constructs a HCA Model under an existing HPS Model.

Returns
The HCA Model.

◆ Model() [3/3]

HPS::HCA::Model::Model ( Model &&  that)

Move constructs a HCA Model from an existing one.

Returns
The HCA Model.

Member Function Documentation

◆ Empty()

bool HPS::HCA::Model::Empty ( )

Check the state of the Model.

Returns
Returns true if this Model doesn't exist.

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