BpsSignals Class Reference

Signals interface. More...

#include <bpssignals.h>

Inheritance diagram for BpsSignals:

Signals
void	error (const QString &aMessage)
	Combined failure signal from setOutputsError() and readInputsError(). More...
void	ok ()
	Combined success signal from setOutputsOk() and readInputsOk().
void	readInputsError (const QString &aMessage)
	Signal emitted after reading the inputs with readInputs() has failed. More...
void	readInputsOk (const BpsSignalsMap &aInputs)
	Signal emitted after reading the inputs wit readInputs() has completed successfully. More...
void	setOutputsError (const QString &aMessage)
	Signal emitted after setting the outputs with setOutputs() has failed. More...
void	setOutputsOk (const BpsSignalsMap &aOutputs)
	Signal emitted after setting the outputs with setOutputs() has completed successfully. More...

Public Member Functions
	BpsSignals (QObject *aParent=0)
QMap< QString, QString >	config () const
virtual int	inputsCount () const =0
BpsSignalsMap	keepOutputs () const
virtual int	outputsCount () const =0
virtual void	readInputs ()=0
	Request to read the inputs. More...
void	setConfig (const QMap< QString, QString > &aConfig)
	Set the signals configuration. More...
void	setKeepOutputs (const BpsSignalsMap &aOutputs=BpsSignalsMap())
	Set state of outputs after destruction. More...
virtual void	setOutputs (const BpsSignalsMap &aOutputs)=0
	Request to set outputs on/off. More...
virtual	~BpsSignals ()
	Virtual default destructor.
Public Member Functions inherited from QObject
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
	QObject (QObject *parent)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)
Properties inherited from QObject
	objectName

Detailed Description

Signals interface.

Signals interfaces operate similar as a thread, where commands are given by request calls, and results are returned as signals. Background operations are however implemented with QTimer, so the requesting thread must have an event queue. Overlapped requests are not supported, subsequent requests should be made only after the previous has been answered by a signal.

Constructor & Destructor Documentation

BpsSignals()

BpsSignals::BpsSignals

(

QObject *

aParent = 0

)

Parameters

aParent

The parent object.

Member Function Documentation

config()

QMap<QString,QString> BpsSignals::config

(

)

const

Returns

The signals configuration with lowercase keys, and trimmed keys and values.

See also

Bps::lowerKeyStringMap().

error

void BpsSignals::error ( const QString &  aMessage )

signal

Combined failure signal from setOutputsError() and readInputsError().

Parameters

aMessage

Information about the failure reason (for example "Timeout", "Device not open" etc.)

inputsCount()

virtual int BpsSignals::inputsCount ( ) const

pure virtual

Returns

Number of inputs supported.

keepOutputs()

BpsSignalsMap BpsSignals::keepOutputs

(

)

const

Returns

State of outputs at destruction. Default is a empty map, meaning all outputs are cleared.

outputsCount()

virtual int BpsSignals::outputsCount ( ) const

pure virtual

Returns

Number of outputs supported.

readInputs()

virtual void BpsSignals::readInputs ( )

pure virtual

Request to read the inputs.

The result is reported by the inputs signal.

readInputsError

void BpsSignals::readInputsError ( const QString &  aMessage )

signal

Signal emitted after reading the inputs with readInputs() has failed.

Parameters

aMessage

The error message to display.

readInputsOk

void BpsSignals::readInputsOk ( const BpsSignalsMap &  aInputs )

signal

Signal emitted after reading the inputs wit readInputs() has completed successfully.

Parameters

aInputs

Map of the logical input numbers and states (true = on, false = off).

setConfig()

void BpsSignals::setConfig

(

const QMap< QString, QString > &

aConfig

)

Set the signals configuration.

This should be done before making requests.

Parameters

aConfig

The signals configuration, usually the values in Central System Settings/Terminals/TERMINAL/Packlines/LINENO/Scales.

setKeepOutputs()

void BpsSignals::setKeepOutputs

(

const BpsSignalsMap &

aOutputs = BpsSignalsMap()

)

Set state of outputs after destruction.

The ability to keep outputs set at a certain state after destruction depends on the hardware and and the plugin implemention.

Parameters

aOutputs

Map of the logical output numbers and states to set (true = on, false = off). Outputs not listed in the map are cleared.

setOutputs()

virtual void BpsSignals::setOutputs ( const BpsSignalsMap &  aOutputs )

pure virtual

Request to set outputs on/off.

Parameters

aOutputs

Map of the logical output numbers and states to set (true = on, false = off). Outputs not listed in the map are left unchanged.

setOutputsError

void BpsSignals::setOutputsError ( const QString &  aMessage )

signal

Signal emitted after setting the outputs with setOutputs() has failed.

Parameters

aMessage

The error message to display.

setOutputsOk

void BpsSignals::setOutputsOk ( const BpsSignalsMap &  aOutputs )

signal

Signal emitted after setting the outputs with setOutputs() has completed successfully.

Parameters

aOutputs

Map of the logical output numbers and states hey are set now (true = on, false = off).

---

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

• bpssignals.h