HPS::HCA::ModelTreeItem Class Referenceabstract

#include <sprk_hca.h>

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

Public Member Functions

virtual ModelTreeItemPtr AddChild (int64_t in_node_id)=0
 
virtual void Assign (ModelTreeItem const &in_that)
 
virtual void Collapse ()
 
bool Equals (ModelTreeItem const &in_that) const
 
virtual void Expand ()
 
ModelTree::ItemType GetItemType () const
 
uint64_t GetNodeId () const
 
UTF8 GetTitle () const
 
ModelTreePtr GetTree () const
 
bool HasChildren () const
 
void Hide ()
 
void Highlight (HighlightOptionsKit const &in_highlight_options)
 
bool IsExpanded () const
 
bool IsHidden () const
 
bool IsHighlighted () const
 
void Isolate ()
 
 ModelTreeItem ()
 
 ModelTreeItem (ModelTreeItem const &in_that)
 
 ModelTreeItem (ModelTreeItem &&in_that)
 
 ModelTreeItem (ModelTreePtr const &in_tree, HCA::Model const &in_hca_model)
 
 ModelTreeItem (ModelTreePtr const &in_tree, int64_t in_node_id)
 
HPS::Type ObjectType () const
 
virtual void OnHighlightUnhighlight ()
 
virtual void OnShowHide ()
 
bool operator!= (ModelTreeItem const &in_that) const
 
ModelTreeItemoperator= (ModelTreeItem const &in_that)
 
ModelTreeItemoperator= (ModelTreeItem &&in_that)
 
bool operator== (ModelTreeItem const &in_that) const
 
bool RequestProperties (uint32_t &out_request_id)
 
void Show ()
 
void ShowAll ()
 
void Unhighlight ()
 
void Zoom ()
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::HCAModelTreeItem
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

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/5]

HPS::HCA::ModelTreeItem::ModelTreeItem ( )

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

◆ ModelTreeItem() [2/5]

HPS::HCA::ModelTreeItem::ModelTreeItem ( ModelTreeItem const &  in_that)

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/5]

HPS::HCA::ModelTreeItem::ModelTreeItem ( ModelTreeItem &&  in_that)

The move constructor creates a ModelTreeItem by transferring the underlying object of the rvalue reference to this ModelTreeItem.

Parameters
in_thatAn rvalue reference to a ModelTreeItem to take the underlying object from.

◆ ModelTreeItem() [4/5]

HPS::HCA::ModelTreeItem::ModelTreeItem ( ModelTreePtr const &  in_tree,
HCA::Model const &  in_hca_model 
)

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

◆ ModelTreeItem() [5/5]

HPS::HCA::ModelTreeItem::ModelTreeItem ( ModelTreePtr const &  in_tree,
int64_t  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.

Member Function Documentation

◆ AddChild()

virtual ModelTreeItemPtr HPS::HCA::ModelTreeItem::AddChild ( int64_t  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 ( ModelTreeItem const &  in_that)
virtual

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 ( )
virtual

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 ( ModelTreeItem const &  in_that) const

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 ( )
virtual

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

ModelTree::ItemType HPS::HCA::ModelTreeItem::GetItemType ( ) const

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_t HPS::HCA::ModelTreeItem::GetNodeId ( ) const

This function will return the HCA node id of this ModelTreeItem

◆ GetTitle()

UTF8 HPS::HCA::ModelTreeItem::GetTitle ( ) const

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

ModelTreePtr HPS::HCA::ModelTreeItem::GetTree ( ) const

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 ( ) const

Indicates whether this ModelTreeItem has any children.

Returns
Whether this ModelTreeItem has any children.

◆ Hide()

void HPS::HCA::ModelTreeItem::Hide ( )

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

◆ Highlight()

void HPS::HCA::ModelTreeItem::Highlight ( HighlightOptionsKit const &  in_highlight_options)

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

◆ IsExpanded()

bool HPS::HCA::ModelTreeItem::IsExpanded ( ) const

Indicates whether this ModelTreeItem is currently expanded.

Returns
Whether this ModelTreeItem is currently expanded.

◆ IsHidden()

bool HPS::HCA::ModelTreeItem::IsHidden ( ) const

Indicates whether this ModelTreeItem is currently hidden.

◆ IsHighlighted()

bool HPS::HCA::ModelTreeItem::IsHighlighted ( ) const

Indicates whether this ModelTreeItem is currently highlighted

◆ Isolate()

void HPS::HCA::ModelTreeItem::Isolate ( )

This function will cause this ModelTreeItem to be isolated

◆ ObjectType()

HPS::Type HPS::HCA::ModelTreeItem::ObjectType ( ) const
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 ( )
virtual

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.

◆ operator!=()

bool HPS::HCA::ModelTreeItem::operator!= ( ModelTreeItem const &  in_that) const

Check if the source ModelTreeItem points to a different impl than this ModelTreeItem.

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

◆ operator=() [1/2]

ModelTreeItem& HPS::HCA::ModelTreeItem::operator= ( ModelTreeItem const &  in_that)

Share the underlying smart-pointer of the ModelTreeItem source.

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

◆ operator=() [2/2]

ModelTreeItem& HPS::HCA::ModelTreeItem::operator= ( ModelTreeItem &&  in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this ModelTreeItem.

Parameters
in_thatAn rvalue reference to a ModelTreeItem to take the underlying object from.
Returns
A reference to this ModelTreeItem.

◆ operator==()

bool HPS::HCA::ModelTreeItem::operator== ( ModelTreeItem const &  in_that) const

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.

◆ RequestProperties()

bool HPS::HCA::ModelTreeItem::RequestProperties ( uint32_t &  out_request_id)

This function requests the properties for the ModelTreeItem.

◆ Show()

void HPS::HCA::ModelTreeItem::Show ( )

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

◆ ShowAll()

void HPS::HCA::ModelTreeItem::ShowAll ( )

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

◆ Unhighlight()

void HPS::HCA::ModelTreeItem::Unhighlight ( )

This function will cause this ModelTreeItem to be unhighlighted.

◆ Zoom()

void HPS::HCA::ModelTreeItem::Zoom ( )

This function will cause this ModelTreeItem to be zoomed


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