BPS C++ API  2.24.4
BpsRfidPlugin Class Referenceabstract

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

#include <bpsrfidplugin.h>

Public Member Functions

virtual bool check (BpsDatastore *aDatastore) const =0
 Check if plugin is available for usage, e.g. More...
 
virtual BpsConfigWidgetcreateConfigWidget (BpsDatastore *aDatastore, QWidget *aParent=nullptr) const =0
 Create the config widget and return a pointer to it. More...
 
virtual BpsRfidcreateRfid (BpsDatastore *aDatastore, QObject *aParent=nullptr) const =0
 Create a RFID object and return a pointer to it. More...
 
virtual QString rfidId () const =0
 
virtual QString rfidName () const =0
 
virtual ~BpsRfidPlugin ()
 Virtual destructor.
 

Static Public Member Functions

static BpsRfidPluginplugin (BpsDatastore *aDatastore, const QString &aId)
 Find the available RFID plugin with the given ID. More...
 
static QList< BpsRfidPlugin * > plugins (BpsDatastore *aDatastore)
 Get list of all RFID plugins available for usage. More...
 

Related Functions

(Note that these are not member functions.)

#define BpsRfidPlugin_IID   "com.ibk-software.BPS2.BpsRfidPlugin/1.0"
 IID of the plugin.
 

Detailed Description

Virtual class for RFID plugin of BPS Workplace.

Place the dynamic library in the plugins/bpsrfid folder.

Member Function Documentation

◆ check()

virtual bool BpsRfidPlugin::check ( BpsDatastore aDatastore) const
pure virtual

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

it is licensed.

Parameters
aDatastoreThe datastore to use.
Returns
True when RFID plugin is available, false when not.

◆ createConfigWidget()

virtual BpsConfigWidget* BpsRfidPlugin::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
aDatastoreThe datastore to use.
aParentThe parent widget.
Returns
Pointer to the new widget, or 0 if RFID plugin is not available for use (see check).

◆ createRfid()

virtual BpsRfid* BpsRfidPlugin::createRfid ( BpsDatastore aDatastore,
QObject aParent = nullptr 
) const
pure virtual

Create a RFID object and return a pointer to it.

Parameters
aDatastoreThe datastore to use.
aParentThe parent object.
Returns
Pointer to the new object, or 0 if RFID plugin is not available for use, the settings parameters are invalid, or the RFID interface can not be opened.

◆ plugin()

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

Find the available RFID plugin with the given ID.

Parameters
aDatastoreThe datastore to use.
aIdThe RFID ID, for example "rodataos".
Returns
The plugin, or 0 if no RFID plugin with this id was found or it is not available for use.

◆ plugins()

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

Get list of all RFID plugins available for usage.

Parameters
aDatastoreThe datastore to use.
Returns
List of available RFID plugins.

◆ rfidId()

virtual QString BpsRfidPlugin::rfidId ( ) const
pure virtual
Returns
The RFID identifier, for example "rodataos".

◆ rfidName()

virtual QString BpsRfidPlugin::rfidName ( ) const
pure virtual
Returns
The RFID name in current language, for example "Rodata GMOS"

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