State interface. More...

#include <cutehmi/services/StateInterface.hpp>

Inheritance diagram for cutehmi::services::StateInterface:

Public Member Functions
virtual QAbstractState *	stopped () const =0

virtual QAbstractState *	starting () const =0

virtual QAbstractState *	started () const =0

virtual QAbstractState *	stopping () const =0

virtual QAbstractState *	broken () const =0

virtual QAbstractState *	repairing () const =0

virtual QAbstractState *	evacuating () const =0

virtual QAbstractState *	interrupted () const =0

virtual cutehmi::services::StartedStateInterface *	startedStates () const =0

Q_INVOKABLE QAbstractState *	findState (const QString &name) const
	Find state by its name. More...

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

	QObject (QObject *parent)

virtual	~QObject ()

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (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

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Protected Member Functions
AbstractService *	service () const

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Properties
QAbstractState *	stopped

QAbstractState *	starting

QAbstractState *	started

QAbstractState *	stopping

QAbstractState *	broken

QAbstractState *	repairing

QAbstractState *	evacuating

QAbstractState *	interrupted

cutehmi::services::StartedStateInterface *	startedStates

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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 QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

State interface.

State interface is basically a predefined state machine configuration, which can be utilized and extended by the service.

States and transitions can be customized through Serviceable interface. States passed to the Serviceable are not exactly the same ones as the ones available as StateInterface properties however. Each state comes up with two flavors - persistent and ephemeric. Each ephemeric state has a persistent parent. Ephemeric children can be deleted and recreated. They are the ones which are passed to Servicable functions. This allows the service to be reconfigured from the inside when necessary, while keeping external states and any existing signal-slot connections intact. Typically you should rely on persistent states and don't bother about ephemeric variants, but this information is given to avoid confusion when dealing with Serviceable and noticing that it's using different state objects.

Member Function Documentation

◆ broken()

virtual QAbstractState * cutehmi::services::StateInterface::broken ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ evacuating()

virtual QAbstractState * cutehmi::services::StateInterface::evacuating ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ findState()

QAbstractState * cutehmi::services::StateInterface::findState ( const QString & name ) const

Find state by its name.

States can be given name using QObject::setObjectName() function. Standard states have following names:

"stopped" and "stopped.ephemeric"
"interrupted" and "interrupted.ephemeric"
"starting" and "starting.ephemeric"
"started" and "started.ephemeric"
"stopping" and "stopping.ephemeric"
"broken" and "broken.ephemeric"
"repairing" and "repairing.ephemeric"
"evacuating" and "evacuating.ephemeric"
"started.active" and "started.active.ephemeric"
"started.idling" and "started.idling.ephemeric"
"started.yielding" and "started.yielding.ephemeric".

Parameters

name	state name.

Returns: state.

◆ interrupted()

virtual QAbstractState * cutehmi::services::StateInterface::interrupted ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ repairing()

virtual QAbstractState * cutehmi::services::StateInterface::repairing ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ service()

AbstractService * cutehmi::services::StateInterface::service ( ) const

protected

◆ started()

virtual QAbstractState * cutehmi::services::StateInterface::started ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ startedStates()

virtual cutehmi::services::StartedStateInterface * cutehmi::services::StateInterface::startedStates ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ starting()

virtual QAbstractState * cutehmi::services::StateInterface::starting ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ stopped()

virtual QAbstractState * cutehmi::services::StateInterface::stopped ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

◆ stopping()

virtual QAbstractState * cutehmi::services::StateInterface::stopping ( ) const

pure virtual

Implemented in cutehmi::services::internal::ServiceStateInterface.

Property Documentation

◆ broken

QAbstractState * cutehmi::services::StateInterface::broken

read

◆ evacuating

QAbstractState * cutehmi::services::StateInterface::evacuating

read

◆ interrupted

QAbstractState * cutehmi::services::StateInterface::interrupted

read

◆ repairing

QAbstractState * cutehmi::services::StateInterface::repairing

read

◆ started

QAbstractState * cutehmi::services::StateInterface::started

read

◆ startedStates

cutehmi::services::StartedStateInterface * cutehmi::services::StateInterface::startedStates

read

◆ starting

QAbstractState * cutehmi::services::StateInterface::starting

read

◆ stopped

QAbstractState * cutehmi::services::StateInterface::stopped

read

◆ stopping

QAbstractState * cutehmi::services::StateInterface::stopping

read

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ broken()

◆ evacuating()

◆ findState()

◆ interrupted()

◆ repairing()

◆ service()

◆ started()

◆ startedStates()

◆ starting()

◆ stopped()

◆ stopping()

Property Documentation

◆ broken

◆ evacuating

◆ interrupted

◆ repairing

◆ started

◆ startedStates

◆ starting

◆ stopped

◆ stopping