#include <CoreInterface.h>

Inheritance diagram for hdps::CoreInterface:

Public Member Functions
	CoreInterface ()

virtual void	init ()

virtual void	reset ()=0

virtual bool	isInitialized () const final

virtual Dataset< DatasetImpl >	addDataset (const QString &kind, const QString &dataSetGuiName, const Dataset< DatasetImpl > &parentDataset=Dataset< DatasetImpl >(), const QString &id="")=0

virtual void	removeDataset (Dataset< DatasetImpl > dataset)=0

template<class DatasetType >
Dataset< DatasetType >	addDataset (const QString &kind, const QString &dataSetGuiName, const Dataset< DatasetImpl > &parentDataset=Dataset< DatasetImpl >())

virtual Dataset< DatasetImpl >	createDerivedDataset (const QString &guiName, const Dataset< DatasetImpl > &sourceDataset, const Dataset< DatasetImpl > &parentDataset=Dataset< DatasetImpl >())=0

template<typename DatasetType >
Dataset< DatasetType >	createDerivedDataset (const QString &guiName, const Dataset< DatasetImpl > &sourceDataset, const Dataset< DatasetImpl > &parentDataset=Dataset< DatasetImpl >())

virtual Dataset< DatasetImpl >	createSubsetFromSelection (const Dataset< DatasetImpl > &selection, const Dataset< DatasetImpl > &sourceDataset, const QString &guiName, const Dataset< DatasetImpl > &parentDataset, const bool &visible=true)=0

template<typename DatasetType >
Dataset< DatasetType >	createSubsetFromSelection (const Dataset< DatasetImpl > &selection, const Dataset< DatasetImpl > &sourceDataset, const QString &guiName, const Dataset< DatasetImpl > &parentDataset, const bool &visible=true)

virtual Dataset< DatasetImpl >	requestDataset (const QString &datasetGuid)=0

template<typename DatasetType >
Dataset< DatasetType >	requestDataset (const QString &datasetGuid)

virtual QVector< Dataset< DatasetImpl > >	requestAllDataSets (const QVector< DataType > &dataTypes=QVector< DataType >())=0

virtual Dataset< DatasetImpl >	groupDatasets (const Datasets &datasets, const QString &guiName="")=0

virtual bool	isDatasetGroupingEnabled () const =0

virtual void	setDatasetGroupingEnabled (const bool &datasetGroupingEnabled)=0

virtual AbstractActionsManager &	getActionsManager ()=0

virtual AbstractPluginManager &	getPluginManager ()=0

virtual AbstractEventManager &	getEventManager ()=0

virtual AbstractDataManager &	getDataManager ()=0

virtual AbstractDataHierarchyManager &	getDataHierarchyManager ()=0

virtual AbstractWorkspaceManager &	getWorkspaceManager ()=0

virtual AbstractProjectManager &	getProjectManager ()=0

virtual AbstractSettingsManager &	getSettingsManager ()=0

Protected Member Functions
virtual plugin::RawData &	requestRawData (const QString &datasetName)=0

virtual Dataset< DatasetImpl >	requestSelection (const QString &rawDataName)=0

template<typename DatasetType >
Dataset< DatasetType >	requestSelection (const QString &rawDataName)

Protected Attributes
bool	_initialized

bool	_datasetGroupingEnabled

Friends
class	plugin::RawData

class	DatasetImpl

class	EventListener

Constructor & Destructor Documentation

◆ CoreInterface()

hdps::CoreInterface::CoreInterface ( )

inline

Default constructor

Member Function Documentation

◆ addDataset() [1/2]

template<class DatasetType >

Dataset< DatasetType > hdps::CoreInterface::addDataset	(	const QString &	kind,
		const QString &	dataSetGuiName,
		const Dataset< DatasetImpl > &	parentDataset = `Dataset<DatasetImpl>()`
	)

inline

Requests the plugin manager to create new RawData of the given kind The manager will add the raw data to the core and return the unique name of the data set linked with the raw data

Parameters

kind	Kind of plugin
datasetGuiName	Name of the added dataset in the GUI
parentDataset	Smart pointer to the parent dataset in the data hierarchy (root if smart pointer is not valid)

Returns: Smart pointer to the added dataset

◆ addDataset() [2/2]

virtual Dataset< DatasetImpl > hdps::CoreInterface::addDataset	(	const QString &	kind,
		const QString &	dataSetGuiName,
		const Dataset< DatasetImpl > &	parentDataset = `Dataset< DatasetImpl >()`,
		const QString &	id = `""`
	)

pure virtual

Requests the plugin manager to create new RawData of the given kind The manager will add the raw data to the core and return the unique name of the data set linked with the raw data

Parameters

kind	Kind of plugin
datasetGuiName	Name of the added dataset in the GUI
parentDataset	Smart pointer to the parent dataset in the data hierarchy (root if not valid)
id	Globally unique dataset identifier (use only for deserialization)

Returns: Smart pointer to the added dataset

Implemented in hdps::Core.

◆ createDerivedDataset() [1/2]

template<typename DatasetType >

Dataset< DatasetType > hdps::CoreInterface::createDerivedDataset	(	const QString &	guiName,
		const Dataset< DatasetImpl > &	sourceDataset,
		const Dataset< DatasetImpl > &	parentDataset = `Dataset<DatasetImpl>()`
	)

inline

Creates a dataset derived from a source dataset.

Parameters

guiName	GUI name for the new dataset from the core
sourceDataset	Smart pointer to the source dataset from which this dataset will be derived
parentDataset	Smart pointer to the parent dataset in the data hierarchy (will attach to root in hierarchy if not valid)

Returns: Smart pointer to the created derived dataset

◆ createDerivedDataset() [2/2]

virtual Dataset< DatasetImpl > hdps::CoreInterface::createDerivedDataset	(	const QString &	guiName,
		const Dataset< DatasetImpl > &	sourceDataset,
		const Dataset< DatasetImpl > &	parentDataset = `Dataset< DatasetImpl >()`
	)

pure virtual

Creates a dataset derived from a source dataset.

Parameters

guiName	GUI name for the new dataset from the core
sourceDataset	Smart pointer to the source dataset from which this dataset will be derived
parentDataset	Smart pointer to the parent dataset in the data hierarchy (will attach to source dataset in hierarchy if not valid)

Returns: Smart pointer to the created derived dataset

Implemented in hdps::Core.

◆ createSubsetFromSelection() [1/2]

template<typename DatasetType >

Dataset< DatasetType > hdps::CoreInterface::createSubsetFromSelection	(	const Dataset< DatasetImpl > &	selection,
		const Dataset< DatasetImpl > &	sourceDataset,
		const QString &	guiName,
		const Dataset< DatasetImpl > &	parentDataset,
		const bool &	visible = `true`
	)

inline

Creates a copy of the given selection set, adds the new set to the data manager and notifies all data consumers of the new set

Parameters

selection	Smart pointer to the selection set
sourceDataset	Smart pointer to the source dataset
guiName	GUI name of the subset
parentDataset	Smart pointer to the parent dataset in the data hierarchy (sourceSetName if not valid)
visible	Whether the new dataset is visible in the user interface

Returns: Smart pointer to the created subset

◆ createSubsetFromSelection() [2/2]

virtual Dataset< DatasetImpl > hdps::CoreInterface::createSubsetFromSelection	(	const Dataset< DatasetImpl > &	selection,
		const Dataset< DatasetImpl > &	sourceDataset,
		const QString &	guiName,
		const Dataset< DatasetImpl > &	parentDataset,
		const bool &	visible = `true`
	)

pure virtual

Creates a copy of the given selection set, adds the new set to the data manager and notifies all data consumers of the new set

Parameters

selection	Smart pointer to the selection set
sourceDataset	Smart pointer to the source dataset
guiName	GUI name of the subset
parentDataset	Smart pointer to the parent dataset in the data hierarchy (sourceSetName if not valid)
visible	Whether the new dataset is visible in the user interface

Returns: Smart pointer to the created subset

Implemented in hdps::Core.

◆ getActionsManager()

virtual AbstractActionsManager & hdps::CoreInterface::getActionsManager ( )

pure virtual

Implemented in hdps::Core.

◆ getDataHierarchyManager()

virtual AbstractDataHierarchyManager & hdps::CoreInterface::getDataHierarchyManager ( )

pure virtual

Implemented in hdps::Core.

◆ getDataManager()

virtual AbstractDataManager & hdps::CoreInterface::getDataManager ( )

pure virtual

Implemented in hdps::Core.

◆ getEventManager()

virtual AbstractEventManager & hdps::CoreInterface::getEventManager ( )

pure virtual

Implemented in hdps::Core.

◆ getPluginManager()

virtual AbstractPluginManager & hdps::CoreInterface::getPluginManager ( )

pure virtual

Implemented in hdps::Core.

◆ getProjectManager()

virtual AbstractProjectManager & hdps::CoreInterface::getProjectManager ( )

pure virtual

Implemented in hdps::Core.

◆ getSettingsManager()

virtual AbstractSettingsManager & hdps::CoreInterface::getSettingsManager ( )

pure virtual

Implemented in hdps::Core.

◆ getWorkspaceManager()

virtual AbstractWorkspaceManager & hdps::CoreInterface::getWorkspaceManager ( )

pure virtual

Implemented in hdps::Core.

◆ groupDatasets()

virtual Dataset< DatasetImpl > hdps::CoreInterface::groupDatasets	(	const Datasets &	datasets,
		const QString &	guiName = `""`
	)

pure virtual

Groups datasets into one dataset

Parameters

datasets	Two or more datasets to group
guiName	Name of the created dataset in the GUI (if empty, the user will be prompted for a name)

Returns: Smart pointer to created group dataset

Implemented in hdps::Core.

◆ init()

virtual void hdps::CoreInterface::init ( )

inlinevirtual

Initializes all core managers

Reimplemented in hdps::Core.

◆ isDatasetGroupingEnabled()

virtual bool hdps::CoreInterface::isDatasetGroupingEnabled ( ) const

pure virtual

Get whether dataset grouping is enabled or not

Implemented in hdps::Core.

◆ isInitialized()

virtual bool hdps::CoreInterface::isInitialized ( ) const

inlinefinalvirtual

Get whether the core is initialized or not

Returns: Boolean determining whether the core is initialized or not

◆ removeDataset()

virtual void hdps::CoreInterface::removeDataset ( Dataset< DatasetImpl > dataset )

pure virtual

Removes a single dataset

Parameters

dataset Smart pointer to the dataset to remove

Implemented in hdps::Core.

◆ requestAllDataSets()

virtual QVector< Dataset< DatasetImpl > > hdps::CoreInterface::requestAllDataSets ( const QVector< DataType > & dataTypes = QVector< DataType >() )

pure virtual

Returns all data sets that are present in the core, filtered by data type(s) Returns all data sets in case of an empty filter

Parameters

dataTypes Data types to filter

Returns: Vector of references to datasets

Implemented in hdps::Core.

◆ requestDataset() [1/2]

template<typename DatasetType >

Dataset< DatasetType > hdps::CoreInterface::requestDataset ( const QString & datasetGuid )

inline

Requests a dataset of a specific type from the core by dataset GUID, if no such instance can be found a fatal error is thrown

Parameters

datasetGuid GUID of the dataset

Returns: Smart pointer to the dataset

◆ requestDataset() [2/2]

virtual Dataset< DatasetImpl > hdps::CoreInterface::requestDataset ( const QString & datasetGuid )

pure virtual

Requests a dataset from the core by dataset GUID (if no such instance can be found a fatal error is thrown)

Parameters

datasetGuid GUID of the dataset

Returns: Smart pointer to the dataset

Implemented in hdps::Core.

◆ requestRawData()

virtual plugin::RawData & hdps::CoreInterface::requestRawData ( const QString & datasetName )

protectedpure virtual

Requests an instance of a data type plugin from the core which has the same unique name as the given parameter, if no such instance can be found a fatal error is thrown

Parameters

datasetName Name of the dataset

Implemented in hdps::Core.

◆ requestSelection() [1/2]

template<typename DatasetType >

Dataset< DatasetType > hdps::CoreInterface::requestSelection ( const QString & rawDataName )

inlineprotected

Request a selection from the data manager by its corresponding raw data name.

Parameters

rawdataName Name of the raw data

◆ requestSelection() [2/2]

virtual Dataset< DatasetImpl > hdps::CoreInterface::requestSelection ( const QString & rawDataName )

protectedpure virtual

Request a selection from the data manager by its corresponding raw data name.

Parameters

rawdataName Name of the raw data

Implemented in hdps::Core.

◆ reset()

virtual void hdps::CoreInterface::reset ( )

pure virtual

Resets the entire core implementation

Implemented in hdps::Core.

◆ setDatasetGroupingEnabled()

virtual void hdps::CoreInterface::setDatasetGroupingEnabled ( const bool & datasetGroupingEnabled )

pure virtual

Get whether dataset grouping is enabled or not

Implemented in hdps::Core.

Friends And Related Symbol Documentation

◆ DatasetImpl

friend class DatasetImpl

friend

◆ EventListener

friend class EventListener

friend

◆ plugin::RawData

friend class plugin::RawData

friend

Whether datasets can be grouped or not

Member Data Documentation

◆ _datasetGroupingEnabled

bool hdps::CoreInterface::_datasetGroupingEnabled

protected

Boolean determining whether the core is initialized or not

◆ _initialized

bool hdps::CoreInterface::_initialized

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

◆ CoreInterface()

Member Function Documentation

◆ addDataset() [1/2]

◆ addDataset() [2/2]

◆ createDerivedDataset() [1/2]

◆ createDerivedDataset() [2/2]

◆ createSubsetFromSelection() [1/2]

◆ createSubsetFromSelection() [2/2]

◆ getActionsManager()

◆ getDataHierarchyManager()

◆ getDataManager()

◆ getEventManager()

◆ getPluginManager()

◆ getProjectManager()

◆ getSettingsManager()

◆ getWorkspaceManager()

◆ groupDatasets()

◆ init()

◆ isDatasetGroupingEnabled()

◆ isInitialized()

◆ removeDataset()

◆ requestAllDataSets()

◆ requestDataset() [1/2]

◆ requestDataset() [2/2]

◆ requestRawData()

◆ requestSelection() [1/2]

◆ requestSelection() [2/2]

◆ reset()

◆ setDatasetGroupingEnabled()

Friends And Related Symbol Documentation

◆ DatasetImpl

◆ EventListener

◆ plugin::RawData

Member Data Documentation

◆ _datasetGroupingEnabled

◆ _initialized