More...

Inheritance diagram for HPS.HCA.ModelTreeItem:
HPS.Sprocket HPS.Object

Classes

class  ModelTreeItemUnknown
 

Public Member Functions

abstract HPS.HCA.ModelTreeItem AddChild (Int64 in_node_id)
 This function is used to create a new ModelTreeItem to be the child of this ModelTreeItem. More...
 
virtual void Assign (HPS.HCA.ModelTreeItem in_that)
 Share the underlying smart-pointer of the ModelTreeItem source. More...
 
virtual void Collapse ()
 This function should be invoked when this ModelTreeItem needs to collapse. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always release all children for this ModelTreeItem when invoked. More...
 
override void Dispose ()
 
delegate void DtorDelegate (IntPtr cPtr)
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HCA.ModelTreeItem in_that)
 Check if the source ModelTreeItem points to the same underlying impl as this ModelTreeItem. More...
 
virtual void Expand ()
 This function should be invoked when this ModelTreeItem needs to expand. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always repopulate the children for this ModelTreeItem when invoked. More...
 
override int GetHashCode ()
 
HPS.HCA.ModelTree.ItemType GetItemType ()
 Gets the item type for this ModelTreeItem. This is used to determine what type of data this ModelTreeItem represents in the ModelTree. More...
 
UInt64 GetNodeId ()
 This function will return the HCA node id of this ModelTreeItem More...
 
string GetTitle ()
 Gets the title for this ModelTreeItem. This is the text that should be displayed for this ModelTreeItem in the ModelTree. More...
 
HPS.HCA.ModelTree GetTree ()
 Gets the ModelTree associated with this ModelTreeItem. This provides a means of accessing the derived ModelTree by this ModelTreeItem if necessary. More...
 
bool HasChildren ()
 Indicates whether this ModelTreeItem has any children. More...
 
void Hide ()
 This function will cause this ModelTreeItem to be hidden if it isn't already. More...
 
void Highlight (HPS.HighlightOptionsKit in_highlight_options)
 This function will cause this ModelTreeItem to be highlighted with the options specified. More...
 
bool IsExpanded ()
 Indicates whether this ModelTreeItem is currently expanded. More...
 
bool IsHidden ()
 Indicates whether this ModelTreeItem is currently hidden. More...
 
bool IsHighlighted ()
 Indicates whether this ModelTreeItem is currently highlighted More...
 
void Isolate ()
 This function will cause this ModelTreeItem to be isolated More...
 
 ModelTreeItem ()
 The default constructor creates an uninitialized ModelTreeItem object. The Type() function will return Type.None. More...
 
 ModelTreeItem (HPS.HCA.ModelTreeItem in_that)
 The copy constructor creates a ModelTreeItem object that shares the underlying smart-pointer of the source ModelTreeItem. More...
 
 ModelTreeItem (HPS.HCA.ModelTree in_tree, HPS.HCA.Model in_hca_model)
 This constructor creates a ModelTreeItem suitable for acting as a root in a ModelTree. More...
 
 ModelTreeItem (HPS.HCA.ModelTree in_tree, Int64 in_node_id)
 This constructor creates a ModelTreeItem which is not suitable for acting as a root in a ModelTree, but is suitable to be a ModelTreeItem under the root of the ModelTree. This constructor should be the one invoked in the overridden AddChild function. More...
 
delegate HPS.Type ModelTreeItemDelegate_0 (IntPtr cPtr)
 
delegate void ModelTreeItemDelegate_1 (IntPtr cPtr, IntPtr in_that)
 
delegate void ModelTreeItemDelegate_2 (IntPtr cPtr, IntPtr out_ret, Int64 in_node_id)
 
delegate void ModelTreeItemDelegate_3 (IntPtr cPtr)
 
delegate void ModelTreeItemDelegate_4 (IntPtr cPtr)
 
delegate void ModelTreeItemDelegate_5 (IntPtr cPtr)
 
delegate void ModelTreeItemDelegate_6 (IntPtr cPtr)
 
delegate HPS.Type ModelTreeItemDelegate_7 (IntPtr cPtr)
 
delegate bool ModelTreeItemDelegate_8 (IntPtr cPtr)
 
delegate void ModelTreeItemDelegate_9 (IntPtr cPtr)
 
override HPS.Type ObjectType ()
 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). More...
 
virtual void OnHighlightUnhighlight ()
 This function will be invoked when this tree should update it's highlighted icons. More...
 
virtual void OnShowHide ()
 This function will be invoked when the tree should update it's show hide icons. More...
 
delegate void RemoveCacheItemDelegate (IntPtr cPtr)
 
bool RequestProperties (out UInt32 out_request_id)
 This function requests the properties for the ModelTreeItem. More...
 
void Show ()
 This function will cause this ModelTreeItem to be visible if it isn't already. More...
 
void ShowAll ()
 This function will cause the visibility of this ModelTreeItem to be reset More...
 
void Unhighlight ()
 This function will cause this ModelTreeItem to be unhighlighted. More...
 
void Zoom ()
 This function will cause this ModelTreeItem to be zoomed More...
 
- 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Static Public Member Functions

static bool operator!= (HPS.HCA.ModelTreeItem a, HPS.HCA.ModelTreeItem b)
 
static bool operator== (HPS.HCA.ModelTreeItem a, HPS.HCA.ModelTreeItem b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
virtual bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
virtual bool IsUserDerived ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Protected Attributes

HandleRef sptr
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Static Protected Attributes

static Dictionary< IntPtr, ModelTreeItemcachedObjects = new Dictionary<IntPtr, ModelTreeItem>()
 
static Dictionary< IntPtr, WeakReference > cachedWeakRefs = new Dictionary<IntPtr, WeakReference>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The ModelTreeItem class is a smart pointer which corresponds to an item or node in a tree object in a GUI toolkit, e.g., a TreeViewItem in WPF or an HTREEITEM in MFC. This class must be derived from to facilitate tree creation in the various GUI toolkits. It is used to represent items in a model browser.

Constructor & Destructor Documentation

◆ ModelTreeItem() [1/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( )
inline

The default constructor creates an uninitialized ModelTreeItem object. The Type() function will return Type.None.

◆ ModelTreeItem() [2/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( HPS.HCA.ModelTreeItem  in_that)
inline

The copy constructor creates a ModelTreeItem object that shares the underlying smart-pointer of the source ModelTreeItem.

Parameters
in_thatThe source ModelTreeItem to copy.

◆ ModelTreeItem() [3/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( HPS.HCA.ModelTree  in_tree,
HPS.HCA.Model  in_hca_model 
)
inline

This constructor creates a ModelTreeItem suitable for acting as a root in a ModelTree.

◆ ModelTreeItem() [4/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( HPS.HCA.ModelTree  in_tree,
Int64  in_node_id 
)
inline

This constructor creates a ModelTreeItem which is not suitable for acting as a root in a ModelTree, but is suitable to be a ModelTreeItem under the root of the ModelTree. This constructor should be the one invoked in the overridden AddChild function.

Member Function Documentation

◆ AddChild()

abstract HPS.HCA.ModelTreeItem HPS.HCA.ModelTreeItem.AddChild ( Int64  in_node_id)
pure virtual

This function is used to create a new ModelTreeItem to be the child of this ModelTreeItem.

◆ Assign()

virtual void HPS.HCA.ModelTreeItem.Assign ( HPS.HCA.ModelTreeItem  in_that)
inlinevirtual

Share the underlying smart-pointer of the ModelTreeItem source.

Parameters
in_thatThe ModelTreeItem source of the assignment.
Returns
A reference to this ModelTreeItem.

◆ Collapse()

virtual void HPS.HCA.ModelTreeItem.Collapse ( )
inlinevirtual

This function should be invoked when this ModelTreeItem needs to collapse. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always release all children for this ModelTreeItem when invoked.

◆ Equals()

bool HPS.HCA.ModelTreeItem.Equals ( HPS.HCA.ModelTreeItem  in_that)
inline

Check if the source ModelTreeItem points to the same underlying impl as this ModelTreeItem.

Parameters
in_thatThe source ModelTreeItem to compare to this ModelTreeItem.
Returns
true if the objects reference the same impl, false otherwise.

◆ Expand()

virtual void HPS.HCA.ModelTreeItem.Expand ( )
inlinevirtual

This function should be invoked when this ModelTreeItem needs to expand. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always repopulate the children for this ModelTreeItem when invoked.

◆ GetItemType()

HPS.HCA.ModelTree.ItemType HPS.HCA.ModelTreeItem.GetItemType ( )
inline

Gets the item type for this ModelTreeItem. This is used to determine what type of data this ModelTreeItem represents in the ModelTree.

Returns
The item type for this ModelTreeItem.

◆ GetNodeId()

UInt64 HPS.HCA.ModelTreeItem.GetNodeId ( )
inline

This function will return the HCA node id of this ModelTreeItem

◆ GetTitle()

string HPS.HCA.ModelTreeItem.GetTitle ( )
inline

Gets the title for this ModelTreeItem. This is the text that should be displayed for this ModelTreeItem in the ModelTree.

Returns
The title for this ModelTreeItem.

◆ GetTree()

HPS.HCA.ModelTree HPS.HCA.ModelTreeItem.GetTree ( )
inline

Gets the ModelTree associated with this ModelTreeItem. This provides a means of accessing the derived ModelTree by this ModelTreeItem if necessary.

Returns
The ModelTree associated with this ModelTreeItem.

◆ HasChildren()

bool HPS.HCA.ModelTreeItem.HasChildren ( )
inline

Indicates whether this ModelTreeItem has any children.

Returns
Whether this ModelTreeItem has any children.

◆ Hide()

void HPS.HCA.ModelTreeItem.Hide ( )
inline

This function will cause this ModelTreeItem to be hidden if it isn't already.

◆ Highlight()

void HPS.HCA.ModelTreeItem.Highlight ( HPS.HighlightOptionsKit  in_highlight_options)
inline

This function will cause this ModelTreeItem to be highlighted with the options specified.

◆ IsExpanded()

bool HPS.HCA.ModelTreeItem.IsExpanded ( )
inline

Indicates whether this ModelTreeItem is currently expanded.

Returns
Whether this ModelTreeItem is currently expanded.

◆ IsHidden()

bool HPS.HCA.ModelTreeItem.IsHidden ( )
inline

Indicates whether this ModelTreeItem is currently hidden.

◆ IsHighlighted()

bool HPS.HCA.ModelTreeItem.IsHighlighted ( )
inline

Indicates whether this ModelTreeItem is currently highlighted

◆ Isolate()

void HPS.HCA.ModelTreeItem.Isolate ( )
inline

This function will cause this ModelTreeItem to be isolated

◆ ObjectType()

override HPS.Type HPS.HCA.ModelTreeItem.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.Object.

◆ OnHighlightUnhighlight()

virtual void HPS.HCA.ModelTreeItem.OnHighlightUnhighlight ( )
inlinevirtual

This function will be invoked when this tree should update it's highlighted icons.

◆ OnShowHide()

virtual void HPS.HCA.ModelTreeItem.OnShowHide ( )
inlinevirtual

This function will be invoked when the tree should update it's show hide icons.

◆ RequestProperties()

bool HPS.HCA.ModelTreeItem.RequestProperties ( out UInt32  out_request_id)
inline

This function requests the properties for the ModelTreeItem.

◆ Show()

void HPS.HCA.ModelTreeItem.Show ( )
inline

This function will cause this ModelTreeItem to be visible if it isn't already.

◆ ShowAll()

void HPS.HCA.ModelTreeItem.ShowAll ( )
inline

This function will cause the visibility of this ModelTreeItem to be reset

◆ Unhighlight()

void HPS.HCA.ModelTreeItem.Unhighlight ( )
inline

This function will cause this ModelTreeItem to be unhighlighted.

◆ Zoom()

void HPS.HCA.ModelTreeItem.Zoom ( )
inline

This function will cause this ModelTreeItem to be zoomed


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