BpsSignalsPlugin Class Reference

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

#include <bpssignalsplugin.h>

List of all members.

Public Member Functions
virtual bool	check (BpsDatastore *aDatastore) const =0
	Check if plugin is available for usage, e.g.
virtual BpsConfigWidget *	createConfigWidget (BpsDatastore *aDatastore, QWidget *aParent=0) const =0
	Create the config widget and return a pointer to it.
virtual BpsSignals *	createSignals (BpsDatastore *aDatastore, QObject *aParent=0) const =0
	Create a signals object and return a pointer to it.
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.
static QList< BpsSignalsPlugin * >	plugins (BpsDatastore *aDatastore)
	Get list of all signals plugins available for usage.

---

Detailed Description

Virtual class for signals plugin of BPS Workplace.

Place the dynamic library in the plugins/bpsignals folder.

---

Member Function Documentation

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.

virtual BpsConfigWidget* BpsSignalsPlugin::createConfigWidget	(	BpsDatastore *	aDatastore,
		QWidget *	aParent = 0
	)		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).

virtual BpsSignals* BpsSignalsPlugin::createSignals	(	BpsDatastore *	aDatastore,
		QObject *	aParent = 0
	)		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.

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.

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.

virtual QString BpsSignalsPlugin::signalsId

(

)

const [pure virtual]

Returns:

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

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