#include <AbstractDataHierarchyManager.h>

Inheritance diagram for hdps::AbstractDataHierarchyManager:

Signals
void	itemAdded (DataHierarchyItem &dataHierarchyItem)

void	itemAboutToBeRemoved (const Dataset< DatasetImpl > &dataset)

void	itemRemoved (const QString &datasetGui)

void	itemLoading (DataHierarchyItem &loadingItem)

void	itemLoaded (DataHierarchyItem &loadedItem)

void	itemSaving (DataHierarchyItem &savingItem)

void	itemSaved (DataHierarchyItem &savedItem)

void	selectedItemsChanged (DataHierarchyItems selectedItems)

Signals inherited from hdps::AbstractManager
void	managerAboutToBeInitialized ()

void	managerInitialized ()

void	managerAboutToBeReset ()

void	managerReset ()

Public Member Functions
	AbstractDataHierarchyManager (QObject *parent=nullptr)

virtual void	addItem (Dataset< DatasetImpl > dataset, Dataset< DatasetImpl > parentDataset, const bool &visible=true)=0

virtual void	removeItem (DataHierarchyItem &dataHierarchyItem)=0

virtual void	removeAllItems ()=0

virtual const DataHierarchyItem &	getItem (const QString &datasetGuid) const =0

virtual DataHierarchyItem &	getItem (const QString &datasetGuid)=0

virtual DataHierarchyItems	getChildren (DataHierarchyItem &dataHierarchyItem, const bool &recursive=true)=0

virtual DataHierarchyItems	getTopLevelItems ()=0

virtual void	selectItems (DataHierarchyItems &selectedItems)=0

virtual void	fromVariantMap (const QVariantMap &variantMap) override=0

virtual QVariantMap	toVariantMap () const override=0

Public Member Functions inherited from hdps::AbstractManager
	AbstractManager (QObject *parent=nullptr, const QString &name="")

virtual void	initialize ()

virtual void	beginReset () final

virtual void	reset ()=0

virtual void	endReset () final

virtual void	beginInitialization () final

virtual void	endInitialization () final

virtual bool	isInitialized () const final

virtual QIcon	getIcon () const

gui::LockingAction &	getLockingAction ()

virtual bool	mayLock () const

virtual bool	mayUnlock () const

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

Additional Inherited Members
Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }

Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

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

Abstract data hierarchy manager

Base abstract data hierarchy manager class for organizing the dataset hierarchy.

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ AbstractDataHierarchyManager()

hdps::AbstractDataHierarchyManager::AbstractDataHierarchyManager ( QObject * parent = nullptr )

inline

Construct data hierarchy manager with parent object

Parameters

parent Pointer to parent object

Member Function Documentation

◆ addItem()

virtual void hdps::AbstractDataHierarchyManager::addItem	(	Dataset< DatasetImpl >	dataset,
		Dataset< DatasetImpl >	parentDataset,
		const bool &	visible = `true`
	)

pure virtual

Add a dataset to the hierarchy

Parameters

dataset	Smart pointer to dataset
parentDataset	Smart pointer to parent dataset (if any)
visible	Whether the dataset is visible in the gui

Implemented in hdps::DataHierarchyManager.

◆ fromVariantMap()

virtual void hdps::AbstractDataHierarchyManager::fromVariantMap ( const QVariantMap & variantMap )

overridepure virtual

Load widget action from variant

Parameters

Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

Implemented in hdps::DataHierarchyManager.

◆ getChildren()

virtual DataHierarchyItems hdps::AbstractDataHierarchyManager::getChildren	(	DataHierarchyItem &	dataHierarchyItem,
		const bool &	recursive = `true`
	)

pure virtual

Get dataset children

Parameters

dataHierarchyItem	Reference to data hierarchy item
recursive	Whether to get all children in a recursive manner

Returns: Children

Implemented in hdps::DataHierarchyManager.

◆ getItem() [1/2]

virtual const DataHierarchyItem & hdps::AbstractDataHierarchyManager::getItem ( const QString & datasetGuid ) const

pure virtual

Get hierarchy item by dataset globally unique identifier

Parameters

datasetGuid Dataset GUID

Returns: Reference to data hierarchy item

Implemented in hdps::DataHierarchyManager.

◆ getItem() [2/2]

virtual DataHierarchyItem & hdps::AbstractDataHierarchyManager::getItem ( const QString & datasetGuid )

pure virtual

Get hierarchy item by dataset globally unique identifier

Parameters

datasetGuid Dataset GUID

Returns: Reference to data hierarchy item

Implemented in hdps::DataHierarchyManager.

◆ getTopLevelItems()

virtual DataHierarchyItems hdps::AbstractDataHierarchyManager::getTopLevelItems ( )

pure virtual

Get top-level items

Returns: Top-level items

Implemented in hdps::DataHierarchyManager.

◆ itemAboutToBeRemoved

void hdps::AbstractDataHierarchyManager::itemAboutToBeRemoved ( const Dataset< DatasetImpl > & dataset )

signal

Signals that a hierarchy item is about to be removed from the hierarchy manager

Parameters

dataset Smart pointer to the about to be removed dataset

◆ itemAdded

void hdps::AbstractDataHierarchyManager::itemAdded ( DataHierarchyItem & dataHierarchyItem )

signal

Signals that a hierarchy item is added to the hierarchy manager

Parameters

dataHierarchyItem Reference to added data hierarchy item

◆ itemLoaded

void hdps::AbstractDataHierarchyManager::itemLoaded ( DataHierarchyItem & loadedItem )

signal

Signals that a data hierarchy item has been loaded

Parameters

loadedItem Reference to the data hierarchy item that has been loaded

◆ itemLoading

void hdps::AbstractDataHierarchyManager::itemLoading ( DataHierarchyItem & loadingItem )

signal

Signals that a data hierarchy item is being loaded

Parameters

loadingItem Reference to the data hierarchy item that is being loaded

◆ itemRemoved

void hdps::AbstractDataHierarchyManager::itemRemoved ( const QString & datasetGui )

signal

Signals that a hierarchy item is removed from the hierarchy manager

Parameters

datasetGui GUID of the removed dataset

◆ itemSaved

void hdps::AbstractDataHierarchyManager::itemSaved ( DataHierarchyItem & savedItem )

signal

Signals that a data hierarchy item has been saved

Parameters

loadedItem Reference to the data hierarchy item that has been saved

◆ itemSaving

void hdps::AbstractDataHierarchyManager::itemSaving ( DataHierarchyItem & savingItem )

signal

Signals that a data hierarchy item is being saved

Parameters

savingItem Reference to the data hierarchy item that is being saved

◆ removeAllItems()

virtual void hdps::AbstractDataHierarchyManager::removeAllItems ( )

pure virtual

Removes all items from the data hierarchy manager in a top-down manner

Implemented in hdps::DataHierarchyManager.

◆ removeItem()

virtual void hdps::AbstractDataHierarchyManager::removeItem ( DataHierarchyItem & dataHierarchyItem )

pure virtual

Removes a data hierarchy item (and its children recursively) from the data hierarchy

Parameters

dataHierarchyItem Reference to data hierarchy item

Implemented in hdps::DataHierarchyManager.

◆ selectedItemsChanged

void hdps::AbstractDataHierarchyManager::selectedItemsChanged ( DataHierarchyItems selectedItems )

signal

Signals that the selected items changed

Parameters

selectedItems Pointers to selected data hierarchy items

◆ selectItems()

virtual void hdps::AbstractDataHierarchyManager::selectItems ( DataHierarchyItems & selectedItems )

pure virtual

Set selected data hierarchy items

Parameters

selectedItems Pointers to selected data hierarchy items

Implemented in hdps::DataHierarchyManager.

◆ toVariantMap()

virtual QVariantMap hdps::AbstractDataHierarchyManager::toVariantMap ( ) const

overridepure virtual

Save widget action to variant

Returns: Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

Implemented in hdps::DataHierarchyManager.

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

D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/AbstractDataHierarchyManager.h

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractDataHierarchyManager()

Member Function Documentation

◆ addItem()

◆ fromVariantMap()

◆ getChildren()

◆ getItem() [1/2]

◆ getItem() [2/2]

◆ getTopLevelItems()

◆ itemAboutToBeRemoved

◆ itemAdded

◆ itemLoaded

◆ itemLoading

◆ itemRemoved

◆ itemSaved

◆ itemSaving

◆ removeAllItems()

◆ removeItem()

◆ selectedItemsChanged

◆ selectItems()

◆ toVariantMap()