hdps::plugin::PluginFactory Class Reference

#include <PluginFactory.h>

Inheritance diagram for hdps::plugin::PluginFactory:

Public Member Functions
	PluginFactory (Type type)
QString	getKind () const
void	setKind (const QString &kind)
Type	getType () const
virtual void	initialize ()
virtual bool	hasHelp ()
virtual gui::TriggerAction &	getTriggerHelpAction () final
QString	getGuiName () const
void	setGuiName (const QString &guiName)
QString	getVersion () const
void	setVersion (const QString &version)
virtual QIcon	getIcon (const QColor &color=Qt::black) const
virtual Plugin *	produce ()=0
virtual bool	mayProduce () const final
virtual hdps::DataTypes	supportedDataTypes () const
virtual gui::PluginTriggerAction &	getPluginTriggerAction ()
virtual gui::PluginTriggerActions	getPluginTriggerActions (const Datasets &datasets) const
virtual gui::PluginTriggerActions	getPluginTriggerActions (const DataTypes &dataTypes) const
std::uint32_t	getNumberOfInstances () const
void	setNumberOfInstances (std::uint32_t numberOfInstances)
std::uint32_t	getMaximumNumberOfInstances () const
void	setMaximumNumberOfInstances (std::uint32_t maximumNumberOfInstances)

Static Protected Member Functions
static QStringList	getDatasetTypesAsStringList (const Datasets &datasets)
static bool	areAllDatasetsOfTheSameType (const Datasets &datasets, const DataType &dataType)
static std::uint16_t	getNumberOfDatasetsForType (const Datasets &datasets, const DataType &dataType)

Constructor & Destructor Documentation

PluginFactory()

hdps::plugin::PluginFactory::PluginFactory

(

Type

type

)

Constructor

Parameters

type	The plugin type

Member Function Documentation

areAllDatasetsOfTheSameType()

bool hdps::plugin::PluginFactory::areAllDatasetsOfTheSameType ( const Datasets &  datasets, const DataType &  dataType  )

staticprotected

Determine whether all datasets are of the same data type

Parameters

datasets	Sequence of input datasets (order in which they were selected in the data hierarchy)
dataType	Type of data

Returns

Whether each dataset is of the same data type

getDatasetTypesAsStringList()

QStringList hdps::plugin::PluginFactory::getDatasetTypesAsStringList ( const Datasets &  datasets )

staticprotected

Get sequence of input datasets as a string list

Parameters

datasets

Sequence of input datasets (order in which they were selected in the data hierarchy)

Returns

String list of input dataset types

getGuiName()

QString hdps::plugin::PluginFactory::getGuiName

(

)

const

Get the menu name of the plugin

getIcon()

QIcon hdps::plugin::PluginFactory::getIcon ( const QColor &  color = Qt::black ) const

virtual

Get plugin icon

Parameters

color

Icon color for flat (font) icons

Returns

Icon

Reimplemented in hdps::plugin::AnalysisPluginFactory, hdps::plugin::LoaderPluginFactory, DataHierarchyPluginFactory, DataPropertiesPluginFactory, ImageDataFactory, LoggingPluginFactory, ActionsPluginFactory, hdps::plugin::TransformationPluginFactory, hdps::plugin::ViewPluginFactory, and hdps::plugin::WriterPluginFactory.

getKind()

QString hdps::plugin::PluginFactory::getKind

(

)

const

Get plugin kind

Returns

Plugin kind

getMaximumNumberOfInstances()

std::uint32_t hdps::plugin::PluginFactory::getMaximumNumberOfInstances

(

)

const

Get maximum number of allowed plugin instances

getNumberOfDatasetsForType()

std::uint16_t hdps::plugin::PluginFactory::getNumberOfDatasetsForType ( const Datasets &  datasets, const DataType &  dataType  )

staticprotected

Get number of datasets for dataType

Parameters

dataType

Data type

Returns

Number of datasets of datasetType

getNumberOfInstances()

std::uint32_t hdps::plugin::PluginFactory::getNumberOfInstances

(

)

const

Get number of plugin instances currently loaded

getPluginTriggerAction()

hdps::gui::PluginTriggerAction & hdps::plugin::PluginFactory::getPluginTriggerAction ( )

virtual

Get the trigger action that produces an instance of the plugin

Returns

Reference to a trigger action that produces an instance of the plugin

getPluginTriggerActions() [1/2]

virtual gui::PluginTriggerActions hdps::plugin::PluginFactory::getPluginTriggerActions ( const Datasets &  datasets ) const

inlinevirtual

Get plugin trigger actions given datasets

Parameters

datasets

Vector of input datasets

Returns

Vector of plugin trigger actions

Reimplemented in hdps::plugin::LoaderPluginFactory.

getPluginTriggerActions() [2/2]

virtual gui::PluginTriggerActions hdps::plugin::PluginFactory::getPluginTriggerActions ( const DataTypes &  dataTypes ) const

inlinevirtual

Get plugin trigger actions given dataTypes

Parameters

datasetTypes

Vector of input data types

Returns

Vector of plugin trigger actions

Reimplemented in hdps::plugin::LoaderPluginFactory.

getTriggerHelpAction()

hdps::gui::TriggerAction & hdps::plugin::PluginFactory::getTriggerHelpAction ( )

finalvirtual

Get trigger action that shows help in some form (will be added to help menu, and if it is a view plugin also to the tab toolbar)

Returns

Reference to show help trigger action (maybe nullptr if the plugin does not provide any help)

getType()

hdps::plugin::Type hdps::plugin::PluginFactory::getType

(

)

const

Get the plugin type

Returns

Plugin type

getVersion()

QString hdps::plugin::PluginFactory::getVersion

(

)

const

Get the plugin version

hasHelp()

bool hdps::plugin::PluginFactory::hasHelp ( )

virtual

Get whether the plugin has help information or not

Returns

Boolean determining whether the plugin has help information or not

initialize()

void hdps::plugin::PluginFactory::initialize ( )

virtual

Perform post-construction initialization

mayProduce()

bool hdps::plugin::PluginFactory::mayProduce ( ) const

finalvirtual

Get whether a plugin may be produced

Returns

Boolean determining whether a plugin may be produced

produce()

virtual Plugin * hdps::plugin::PluginFactory::produce ( )

pure virtual

Produces the plugin

Returns

Pointer to the produced plugin

Implemented in DataHierarchyPluginFactory, DataPropertiesPluginFactory, ImageDataFactory, LoggingPluginFactory, ActionsPluginFactory, hdps::plugin::AnalysisPluginFactory, hdps::plugin::LoaderPluginFactory, hdps::plugin::RawDataFactory, hdps::plugin::TransformationPluginFactory, hdps::plugin::ViewPluginFactory, and hdps::plugin::WriterPluginFactory.

setGuiName()

void hdps::plugin::PluginFactory::setGuiName

(

const QString &

guiName

)

Set the GUI name of the plugin

Parameters

guiName

GUI name of the plugin

setKind()

void hdps::plugin::PluginFactory::setKind

(

const QString &

kind

)

Set plugin kind

Parameters

kind	Plugin kind

setMaximumNumberOfInstances()

void hdps::plugin::PluginFactory::setMaximumNumberOfInstances

(

std::uint32_t

maximumNumberOfInstances

)

Set maximum number of allowed plugin instances

Parameters

maximumNumberOfInstances

Maximum number of allowed plugin instances

setNumberOfInstances()

void hdps::plugin::PluginFactory::setNumberOfInstances

(

std::uint32_t

numberOfInstances

)

Set number of plugin instances currently loaded

Parameters

numberOfInstances

Number of plugin instances currently loaded

setVersion()

void hdps::plugin::PluginFactory::setVersion

(

const QString &

version

)

Set the plugin version

Parameters

version

Plugin version

supportedDataTypes()

virtual hdps::DataTypes hdps::plugin::PluginFactory::supportedDataTypes ( ) const

inlinevirtual

Get the data types that the plugin supports

Returns

Supported data types

---

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

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