hdps::DataHierarchyItem Class Reference

#include <DataHierarchyItem.h>

Inheritance diagram for hdps::DataHierarchyItem:

Public Types
enum class	TaskStatus {   Undefined = -1 , Idle , Running , Finished ,   Aborted }
Public Types inherited from hdps::gui::WidgetAction
enum class	Scope { Private , Public }
enum class	HighlightOption { None , Moderate , Strong }
enum class	ConfigurationFlag {   VisibleInMenu = 0x00001 , InternalUseOnly = 0x00002 , NoLabelInGroup = 0x00004 , ForceCollapsedInGroup = 0x00008 ,   ForceExpandedInGroup = 0x00010 , User = 0x00100 , Default = 0 }
enum	ConnectionContextFlag { Api = 0x00008 , Gui = 0x00010 , ApiAndGui = Api | Gui }
	‍** Describes the connection context options *‍/ More...
enum class	ConnectionPermissionFlag {   None = 0x00000 , PublishViaApi = 0x00001 , PublishViaGui = 0x00002 , PublishViaApiAndGui = PublishViaApi | PublishViaGui ,   ConnectViaApi = 0x00008 , ConnectViaGui = 0x00010 , ConnectViaApiAndGui = ConnectViaApi | ConnectViaGui , DisconnectViaApi = 0x00040 ,   DisconnectViaGui = 0x00080 , DisconnectViaApiAndGui = DisconnectViaApi | DisconnectViaGui , ForceNone = 0x00100 , All = PublishViaApiAndGui | ConnectViaApiAndGui | DisconnectViaApiAndGui ,   Default = All }
Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }

Signals
void	taskDescriptionChanged (const QString &taskDescription)
void	taskProgressChanged (const float &taskProgress)
void	selectionChanged (const bool &selected)
void	actionAdded (hdps::gui::WidgetAction &widgetAction)
void	iconChanged ()
void	datasetNameChanged (const QString &datasetName)
void	lockedChanged (bool locked)
void	visibilityChanged (bool visibility)
void	expandedChanged (bool expanded)
void	loading ()
void	loaded ()
void	saving ()
void	saved ()
Signals inherited from hdps::gui::WidgetAction
void	idChanged (const QString &id)
void	sortIndexChanged (std::int32_t sortIndex)
void	stretchChanged (std::int32_t stretch)
void	forceHiddenChanged (bool forceHidden)
void	forceDisabledChanged (bool forceDisabled)
void	highlightingChanged (const HighlightOption &highlightOption)
void	isPublishedChanged (const bool &isPublished)
void	isConnectedChanged (const bool &isConnected)
void	actionConnected (WidgetAction *action)
void	actionDisconnected (WidgetAction *action)
void	connectionPermissionsChanged (std::int32_t connectionPermissions)
void	configurationFlagToggled (const ConfigurationFlag &configurationFlag, bool set)
void	configurationChanged (std::int32_t configuration)
void	scopeChanged (const Scope &scope)
void	textChanged (const QString &text)
void	locationChanged (const QString &location)

Public Member Functions
	DataHierarchyItem (QObject *parent, Dataset< DatasetImpl > dataset, Dataset< DatasetImpl > parentDataset, const bool &visible=true, const bool &selected=false)
	~DataHierarchyItem ()=default
DataHierarchyItem &	getParent () const
bool	hasParent () const
DataHierarchyItems	getChildren (const bool &recursive=false) const
std::uint32_t	getNumberOfChildren () const
bool	hasChildren () const
void	setVisible (bool visible)
bool	isSelected () const
void	setSelected (const bool &selected)
void	select ()
void	deselect ()
void	addChild (DataHierarchyItem &child)
Dataset< DatasetImpl >	getDataset ()
template<typename DatasetType >
Dataset< DatasetType >	getDataset () const
Dataset< DatasetImpl > &	getDatasetReference ()
template<typename DatasetType >
Dataset< DatasetType > &	getDatasetReference () const
DataType	getDataType () const
void	addAction (hdps::gui::WidgetAction &widgetAction)
hdps::gui::WidgetActions	getActions () const
QMenu *	getContextMenu (QWidget *parent=nullptr) override
void	populateContextMenu (QMenu *contextMenu)
bool	getLocked () const
void	setLocked (const bool &locked)
bool	isExpanded () const
void	setExpanded (bool expanded)
QString	getTaskName () const
void	setTaskName (const QString &taskName)
TaskStatus	getTaskStatus () const
QString	getTaskDescription () const
void	setTaskDescription (const QString &taskDescription)
float	getTaskProgress () const
void	setTaskProgress (float taskProgress)
void	setNumberOfSubTasks (float numberOfSubTasks)
void	setSubTaskFinished (float subTaskIndex)
bool	isIdle () const
bool	isRunning () const
bool	isFinished () const
bool	isAborted () const
void	setTaskIdle ()
void	setTaskRunning ()
void	setTaskFinished ()
void	setTaskAborted ()
QIcon	getIcon () const
void	setIcon (const QIcon &icon)
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
Public Member Functions inherited from hdps::gui::WidgetAction
	WidgetAction (QObject *parent, const QString &title)
	~WidgetAction ()
virtual WidgetAction *	getParentAction () const final
virtual WidgetActions	getParentActions () const final
virtual WidgetActions	getChildren () const final
virtual bool	isRoot () const final
virtual bool	isLeaf () const final
virtual QWidget *	createWidget (QWidget *parent) override final
virtual QWidget *	createCollapsedWidget (QWidget *parent) const final
virtual QWidget *	createLabelWidget (QWidget *parent, const std::int32_t &widgetFlags=0x00001) const final
QWidget *	createWidget (QWidget *parent, const std::int32_t &widgetFlags)
virtual std::int32_t	getSortIndex () const final
virtual void	setSortIndex (const std::int32_t &sortIndex) final
virtual std::int32_t	getStretch () const final
virtual void	setStretch (const std::int32_t &stretch) final
virtual bool	getForceHidden () const final
virtual void	setForceHidden (bool forceHidden) final
virtual bool	isVisible () const final
virtual bool	getForceDisabled () const final
virtual void	setForceDisabled (bool forceDisabled) final
virtual bool	isEnabled () const final
void	setText (const QString &text)
virtual QString	getLocation () const
virtual std::int32_t	getDefaultWidgetFlags () const final
virtual void	setDefaultWidgetFlags (const std::int32_t &widgetFlags) final
virtual void	setDefaultWidgetFlag (const std::int32_t &widgetFlags, bool unset=false) final
virtual HighlightOption	getHighlighting () const final
virtual bool	isHighlighted () const final
virtual void	setHighlighting (const HighlightOption &highlighting) final
virtual void	setHighlighted (bool highlighted) final
virtual void	highlight () final
virtual void	unHighlight () final
virtual Scope	getScope () const final
virtual bool	isPrivate () const final
virtual bool	isPublic () const final
virtual bool	isPublished () const final
virtual bool	isConnected () const final
virtual bool	mayConnectToPublicAction (const WidgetAction *publicAction) const final
virtual bool	publish (const QString &name="", bool allowDuplicateName=false) final
virtual WidgetAction *	getPublicAction () final
virtual WidgetAction *	getPublicCopy () const final
virtual const WidgetActions	getConnectedActions () const final
virtual WidgetActions &	getConnectedActions () final
virtual bool	mayPublish (ConnectionContextFlag connectionContextFlags) const final
virtual bool	mayConnect (ConnectionContextFlag connectionContextFlags) const final
virtual bool	mayDisconnect (ConnectionContextFlag connectionContextFlags) const final
virtual std::int32_t	getConnectionPermissions () const final
virtual bool	isConnectionPermissionFlagSet (ConnectionPermissionFlag connectionPermissionsFlag) final
virtual void	setConnectionPermissionsFlag (ConnectionPermissionFlag connectionPermissionsFlag, bool unset=false, bool recursive=false) final
virtual void	setConnectionPermissions (std::int32_t connectionPermissions, bool recursive=false) final
virtual void	setConnectionPermissionsToNone (bool recursive=false) final
virtual void	setConnectionPermissionsToForceNone (bool recursive=false) final
virtual void	setConnectionPermissionsToAll (bool recursive=false) final
virtual void	cacheConnectionPermissions (bool recursive=false) final
virtual void	restoreConnectionPermissions (bool recursive=false) final
virtual void	startDrag () final
virtual bool	isResettable () const final
virtual void	reset () final
virtual void	setSettingsPrefix (const QString &settingsPrefix, const bool &load=true) final
virtual void	setSettingsPrefix (plugin::Plugin *plugin, const QString &settingsPrefix, const bool &load=true) final
virtual QString	getSettingsPrefix () const
virtual void	loadFromSettings () final
virtual void	saveToSettings () final
virtual QVector< WidgetAction * >	findChildren (const QString &searchString, bool recursive=true) const final
virtual QSize	getPopupSizeHint () const final
virtual void	setPopupSizeHint (const QSize &popupSizeHint) final
virtual std::int32_t	getConfiguration () const final
virtual bool	isConfigurationFlagSet (ConfigurationFlag configurationFlag) const final
virtual void	setConfigurationFlag (ConfigurationFlag configurationFlag, bool unset=false, bool recursive=false) final
virtual void	setConfiguration (std::int32_t configuration, bool recursive=false) final
virtual QString	getTypeString (bool humanFriendly=false) const final
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
virtual void	cacheState (const QString &name="cache") final
virtual void	restoreState (const QString &name="cache", bool remove=true) final
virtual void	setStudioMode (bool studioMode, bool recursive=true) final
Public Member Functions inherited from hdps::util::Serializable
	Serializable (const QString &serializationName="")
virtual QString	getId () const final
virtual void	setId (const QString &id) final
virtual QString	getSerializationName () const final
virtual void	setSerializationName (const QString &serializationName) final
virtual void	fromParentVariantMap (const QVariantMap &parentVariantMap)
virtual void	insertIntoVariantMap (QVariantMap &variantMap) const final
virtual void	fromJsonDocument (const QJsonDocument &jsonDocument) final
virtual QJsonDocument	toJsonDocument () const final
virtual void	fromJsonFile (const QString &filePath="") final
virtual void	toJsonFile (const QString &filePath="") final
virtual void	makeUnique () final

Static Public Member Functions
static void	getParents (DataHierarchyItem &dataHierarchyItem, DataHierarchyItems &parents)
Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

Protected Member Functions
void	setParent (DataHierarchyItem &parent)
Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final
virtual void	connectToPublicAction (WidgetAction *publicAction, bool recursive)
virtual void	connectToPublicActionByName (const QString &publicActionName) final
virtual void	disconnectFromPublicAction (bool recursive)
virtual QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags)

Protected Attributes
Dataset< DatasetImpl >	_dataset
DataHierarchyItem *	_parent
DataHierarchyItems	_children
bool	_selected
bool	_expanded
QString	_taskDescription
float	_taskProgress
QBitArray	_subTasks
QString	_taskName
TaskStatus	_taskStatus
QTimer	_taskDescriptionTimer
QTimer	_taskProgressTimer
QIcon	_icon
hdps::gui::WidgetActions	_actions

Static Protected Attributes
static constexpr std::uint32_t	TASK_UPDATE_TIMER_INTERVAL = 100
static constexpr std::uint32_t	MESSAGE_DISAPPEAR_INTERVAL = 1500

Friends
class	DataHierarchyManager
class	DataManager

Additional Inherited Members
Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString >	scopeNames
Static Protected Member Functions inherited from hdps::util::Serializable
static void	fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)
static void	fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)
static QVariantMap	toVariantMap (const Serializable *serializable)
static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)
static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)

Detailed Description

Data hierarchy item class

Represents a dataset as an item in a dataset hierarchy

Author

Thomas Kroes

Member Enumeration Documentation

TaskStatus

enum class hdps::DataHierarchyItem::TaskStatus

strong

Task status enumeration

Enumerator
Undefined
Idle	Task status is undefined
Running	Task is idle
Finished	An Task is currently running
Aborted	Task has finished successfully Task has been aborted

Constructor & Destructor Documentation

DataHierarchyItem()

hdps::DataHierarchyItem::DataHierarchyItem	(	QObject *	parent,
		Dataset< DatasetImpl >	dataset,
		Dataset< DatasetImpl >	parentDataset,
		const bool &	visible = true,
		const bool &	selected = false
	)

Constructor

Parameters

parent	Pointer to parent object
dataset	Smart pointer to dataset
parentDataset	Smart pointer to parent dataset (if any)
visible	Whether the dataset is visible
selected	Whether the dataset is selected

~DataHierarchyItem()

hdps::DataHierarchyItem::~DataHierarchyItem ( )

default

Destructor

Member Function Documentation

actionAdded

void hdps::DataHierarchyItem::actionAdded ( hdps::gui::WidgetAction &  widgetAction )

signal

Signals that a widget action was added

Parameters

widgetAction

Widget action that was added

addAction()

void hdps::DataHierarchyItem::addAction

(

hdps::gui::WidgetAction &

widgetAction

)

Add action

addChild()

void hdps::DataHierarchyItem::addChild

(

DataHierarchyItem &

child

)

Add a child

Parameters

child

Reference to child data hierarchy item

datasetNameChanged

void hdps::DataHierarchyItem::datasetNameChanged ( const QString &  datasetName )

signal

Signals that the dataset name changed

Parameters

datasetName

New name of the dataset

deselect()

void hdps::DataHierarchyItem::deselect

(

)

De-selects the hierarchy item

expandedChanged

void hdps::DataHierarchyItem::expandedChanged ( bool  expanded )

signal

Signals that the expansion status changed

Parameters

expanded

Whether the item is expanded or not

fromVariantMap()

void hdps::DataHierarchyItem::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load widget action from variant

Parameters

Variant

representation of the widget action

Reimplemented from hdps::util::Serializable.

getActions()

WidgetActions hdps::DataHierarchyItem::getActions

(

)

const

Returns list of shared action widgets

getChildren()

DataHierarchyItems hdps::DataHierarchyItem::getChildren

(

const bool &

recursive = false

)

const

Gets the names of the children name

Parameters

recursive

Recursive

getContextMenu()

QMenu * hdps::DataHierarchyItem::getContextMenu ( QWidget *  parent = nullptr )

overridevirtual

Get the context menu

Parameters

parent

Parent widget

Returns

Context menu

Reimplemented from hdps::gui::WidgetAction.

getDataset() [1/2]

Dataset< DatasetImpl > hdps::DataHierarchyItem::getDataset

(

)

Get the dataset

getDataset() [2/2]

template<typename DatasetType >

Dataset< DatasetType > hdps::DataHierarchyItem::getDataset ( ) const

inline

Get the dataset

getDatasetReference() [1/2]

Dataset< hdps::DatasetImpl > & hdps::DataHierarchyItem::getDatasetReference

(

)

Get reference to dataset smart pointer

Returns

Reference to dataset smart pointer

getDatasetReference() [2/2]

template<typename DatasetType >

Dataset< DatasetType > & hdps::DataHierarchyItem::getDatasetReference ( ) const

inline

Get reference to dataset smart pointer of a specific type

Returns

Reference to dataset smart pointer of a specific type

getDataType()

DataType hdps::DataHierarchyItem::getDataType

(

)

const

Get the dataset type

getIcon()

QIcon hdps::DataHierarchyItem::getIcon

(

)

const

Get icon

getLocked()

bool hdps::DataHierarchyItem::getLocked

(

)

const

Get locked status

getNumberOfChildren()

std::uint32_t hdps::DataHierarchyItem::getNumberOfChildren

(

)

const

Gets the number of children

getParent()

DataHierarchyItem & hdps::DataHierarchyItem::getParent

(

)

const

Get reference to parent hierarchy item

getParents()

void hdps::DataHierarchyItem::getParents ( DataHierarchyItem &  dataHierarchyItem, DataHierarchyItems &  parents  )

static

Walks up the hierarchy of the data hierarchy item and returns all parents

Parameters

dataHierarchyItem	Item to fetch the parents for
parents	Item parents

getTaskDescription()

QString hdps::DataHierarchyItem::getTaskDescription

(

)

const

Gets the task description

getTaskName()

QString hdps::DataHierarchyItem::getTaskName

(

)

const

Get task name

getTaskProgress()

float hdps::DataHierarchyItem::getTaskProgress

(

)

const

Gets the task progress [0, 1]

getTaskStatus()

hdps::DataHierarchyItem::TaskStatus hdps::DataHierarchyItem::getTaskStatus

(

)

const

Get task status

hasChildren()

bool hdps::DataHierarchyItem::hasChildren

(

)

const

Establishes whether the item has any children

hasParent()

bool hdps::DataHierarchyItem::hasParent

(

)

const

Returns whether the data hierarchy item has a parent

iconChanged

void hdps::DataHierarchyItem::iconChanged ( )

signal

Signals that the set icon has changed

isAborted()

bool hdps::DataHierarchyItem::isAborted

(

)

const

isExpanded()

bool hdps::DataHierarchyItem::isExpanded

(

)

const

Get expanded status

Returns

Boolean indicating whether the item is expanded or not

isFinished()

bool hdps::DataHierarchyItem::isFinished

(

)

const

isIdle()

bool hdps::DataHierarchyItem::isIdle

(

)

const

Convenience functions for status checking

isRunning()

bool hdps::DataHierarchyItem::isRunning

(

)

const

isSelected()

bool hdps::DataHierarchyItem::isSelected

(

)

const

Gets whether the hierarchy item is selected

loaded

void hdps::DataHierarchyItem::loaded ( )

signal

Signals that the data hierarchy item has been loaded

loading

void hdps::DataHierarchyItem::loading ( )

signal

Signals that the data hierarchy item is being loaded

lockedChanged

void hdps::DataHierarchyItem::lockedChanged ( bool  locked )

signal

Signals that the locked status changed

Parameters

locked

Locked

populateContextMenu()

void hdps::DataHierarchyItem::populateContextMenu

(

QMenu *

contextMenu

)

Populates existing menu with actions menus

Parameters

contextMenu

Context menu to populate

saved

void hdps::DataHierarchyItem::saved ( )

signal

Signals that the data hierarchy item has been saved

saving

void hdps::DataHierarchyItem::saving ( )

signal

Signals that the data hierarchy item is being saved

select()

void hdps::DataHierarchyItem::select

(

)

Selects the hierarchy item

selectionChanged

void hdps::DataHierarchyItem::selectionChanged ( const bool &  selected )

signal

Signals that the item got selected

Parameters

selected

Whether the item is selected

setExpanded()

void hdps::DataHierarchyItem::setExpanded

(

bool

expanded

)

Set expanded status

Parameters

expanded

Whether the dataset is expanded

setIcon()

void hdps::DataHierarchyItem::setIcon

(

const QIcon &

icon

)

Set icon

Parameters

icon

Icon

setLocked()

void hdps::DataHierarchyItem::setLocked

(

const bool &

locked

)

Set locked status

Parameters

locked

Whether the dataset is locked

setNumberOfSubTasks()

void hdps::DataHierarchyItem::setNumberOfSubTasks

(

float

numberOfSubTasks

)

Set the number of sub tasks

Parameters

numberOfSubTasks

Number of sub tasks

setParent()

void hdps::DataHierarchyItem::setParent ( DataHierarchyItem &  parent )

protected

Set reference to parent hierarchy item

setSelected()

void hdps::DataHierarchyItem::setSelected

(

const bool &

selected

)

Sets the item selection status

Parameters

selected

Whether the hierarchy item is selected

setSubTaskFinished()

void hdps::DataHierarchyItem::setSubTaskFinished

(

float

subTaskIndex

)

Flag sub task as finished

Parameters

subTaskIndex

Index of the sub task

setTaskAborted()

void hdps::DataHierarchyItem::setTaskAborted

(

)

setTaskDescription()

void hdps::DataHierarchyItem::setTaskDescription

(

const QString &

taskDescription

)

Sets the task description

Parameters

taskDescription

Task description [0, 1]

setTaskFinished()

void hdps::DataHierarchyItem::setTaskFinished

(

)

setTaskIdle()

void hdps::DataHierarchyItem::setTaskIdle

(

)

Set task status

setTaskName()

void hdps::DataHierarchyItem::setTaskName

(

const QString &

taskName

)

Set task name

Parameters

taskName

Name of the task

setTaskProgress()

void hdps::DataHierarchyItem::setTaskProgress

(

float

taskProgress

)

Sets the task progress

Parameters

taskProgress

Task progress

setTaskRunning()

void hdps::DataHierarchyItem::setTaskRunning

(

)

setVisible()

void hdps::DataHierarchyItem::setVisible

(

bool

visible

)

Set visibility

Parameters

visible

Whether the data hierarchy item is visible or not

taskDescriptionChanged

void hdps::DataHierarchyItem::taskDescriptionChanged ( const QString &  taskDescription )

signal

Signals that the task description changed

Parameters

taskDescription

Task description

taskProgressChanged

void hdps::DataHierarchyItem::taskProgressChanged ( const float &  taskProgress )

signal

Signals that the task progress changed

Parameters

taskProgress

Task progress

toVariantMap()

QVariantMap hdps::DataHierarchyItem::toVariantMap ( ) const

overridevirtual

Save widget action to variant

Returns

Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

visibilityChanged

void hdps::DataHierarchyItem::visibilityChanged ( bool  visibility )

signal

Signals that the visibility status changed

Parameters

visibility

Visibility

Friends And Related Symbol Documentation

DataHierarchyManager

friend class DataHierarchyManager

friend

Widget actions

DataManager

friend class DataManager

friend

Member Data Documentation

_actions

hdps::gui::WidgetActions hdps::DataHierarchyItem::_actions

protected

Icon

_children

DataHierarchyItems hdps::DataHierarchyItem::_children

protected

Pointer to parent data hierarchy item

_dataset

Dataset<DatasetImpl> hdps::DataHierarchyItem::_dataset

protected

_expanded

bool hdps::DataHierarchyItem::_expanded

protected

Whether the hierarchy item is selected

_icon

QIcon hdps::DataHierarchyItem::_icon

protected

Task progress timer which prevents excessive GUI updates

_parent

DataHierarchyItem* hdps::DataHierarchyItem::_parent

protected

Smart pointer to dataset

_selected

bool hdps::DataHierarchyItem::_selected

protected

Pointers to child items (if any)

_subTasks

QBitArray hdps::DataHierarchyItem::_subTasks

protected

Task progress

_taskDescription

QString hdps::DataHierarchyItem::_taskDescription

protected

Whether the item is expanded or not (when it has children)

_taskDescriptionTimer

QTimer hdps::DataHierarchyItem::_taskDescriptionTimer

protected

Status of the current task

_taskName

QString hdps::DataHierarchyItem::_taskName

protected

Sub-tasks bit array

_taskProgress

float hdps::DataHierarchyItem::_taskProgress

protected

Task description

_taskProgressTimer

QTimer hdps::DataHierarchyItem::_taskProgressTimer

protected

Task description timer which prevents excessive successive GUI updates

_taskStatus

TaskStatus hdps::DataHierarchyItem::_taskStatus

protected

Name of the current task

MESSAGE_DISAPPEAR_INTERVAL

constexpr std::uint32_t hdps::DataHierarchyItem::MESSAGE_DISAPPEAR_INTERVAL = 1500

staticconstexprprotected

Single shot message disappear timer interval

TASK_UPDATE_TIMER_INTERVAL

constexpr std::uint32_t hdps::DataHierarchyItem::TASK_UPDATE_TIMER_INTERVAL = 100

staticconstexprprotected

Single shot task update timer interval

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/DataHierarchyItem.h
• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/DataHierarchyItem.cpp