BpsSignalsPlugin Class Reference

Virtual class for signals plugin of BPS Workplace. More...

#include <bpssignalsplugin.h>

Public Member Functions
virtual bool	check (BpsDatastore *aDatastore) const =0
	Check if plugin is available for usage, e.g. More...
virtual BpsConfigWidget *	createConfigWidget (BpsDatastore *aDatastore, QWidget *aParent=nullptr) const =0
	Create the config widget and return a pointer to it. More...
virtual BpsSignals *	createSignals (BpsDatastore *aDatastore, QObject *aParent=nullptr) const =0
	Create a signals object and return a pointer to it. More...
virtual QString	signalsId () const =0
virtual QString	signalsName () const =0
virtual	~BpsSignalsPlugin ()
	Virtual destructor.

Static Public Member Functions
static BpsSignalsPlugin *	plugin (BpsDatastore *aDatastore, const QString &aId)
	Find the available signals plugin with the given ID. More...
static QList< BpsSignalsPlugin * >	plugins (BpsDatastore *aDatastore)
	Get list of all signals plugins available for usage. More...

Related Functions
(Note that these are not member functions.)
#define	BpsSignalsPlugin_IID   "com.ibk-software.BPS2.BpsSignalsPlugin/1.0"
	IID of the plugin.

Detailed Description

Virtual class for signals plugin of BPS Workplace.

Place the dynamic library in the plugins/bpsignals folder.

Member Function Documentation

check()

virtual bool BpsSignalsPlugin::check ( BpsDatastore *  aDatastore ) const

pure virtual

Check if plugin is available for usage, e.g.

it is licensed.

Parameters

aDatastore

The datastore to use.

Returns

True when signals plugin is available, false when not.

createConfigWidget()

virtual BpsConfigWidget* BpsSignalsPlugin::createConfigWidget ( BpsDatastore *  aDatastore, QWidget *  aParent = nullptr  ) const

pure virtual

Create the config widget and return a pointer to it.

The widget is owned by the caller.

Parameters

aDatastore	The datastore to use.
aParent	The parent widget.

Returns

Pointer to the new widget, or 0 if signals plugin is not available for use (see check).

createSignals()

virtual BpsSignals* BpsSignalsPlugin::createSignals ( BpsDatastore *  aDatastore, QObject *  aParent = nullptr  ) const

pure virtual

Create a signals object and return a pointer to it.

Parameters

aDatastore	The datastore to use.
aParent	The parent object.

Returns

Pointer to the new object, or 0 if signals plugin is not available for use, the settings parameters are invalid, or the signals can not be opened.

plugin()

static BpsSignalsPlugin* BpsSignalsPlugin::plugin ( BpsDatastore *  aDatastore, const QString &  aId  )

static

Find the available signals plugin with the given ID.

Parameters

aDatastore	The datastore to use.
aId	The signals ID, for example "mtsics" or "bit650".

Returns

The plugin, or 0 if no signals plugin with this id was found or it is not available for use.

plugins()

static QList<BpsSignalsPlugin*> BpsSignalsPlugin::plugins ( BpsDatastore *  aDatastore )

static

Get list of all signals plugins available for usage.

Parameters

aDatastore

The datastore to use.

Returns

List of available signals plugins.

signalsId()

virtual QString BpsSignalsPlugin::signalsId ( ) const

pure virtual

Returns

The signals ID, for example "mtsics" or "bit650".

signalsName()

virtual QString BpsSignalsPlugin::signalsName ( ) const

pure virtual

Returns

The signals name in current language, for example "ICPDAS"

---

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

• bpssignalsplugin.h