CuteHMI - Services (CuteHMI.Services.3)
cutehmi::services::Service Class Reference

Service. More...

#include <cutehmi/services/Service.hpp>

Inheritance diagram for cutehmi::services::Service:
cutehmi::services::AbstractService QQmlParserStatus QObject CuteHMI::Services::Service

Signals

void serviceableChanged ()
 
- Signals inherited from cutehmi::services::AbstractService
void stopTimeoutChanged ()
 
void startTimeoutChanged ()
 
void repairTimeoutChanged ()
 
void shutdownTimeoutChanged ()
 
void nameChanged ()
 
void statusChanged ()
 
void started ()
 
void stopped ()
 
void activated ()
 
void initialized ()
 This signal is emitted, when service has performed all the initialization tasks and it is ready to be started. More...
 

Public Member Functions

 Service (QObject *parent=nullptr)
 
 ~Service () override
 
void setServiceable (QVariant serviceable)
 Set serviced object. More...
 
QVariant serviceable () const
 Get serviced object. More...
 
void classBegin () override
 
void componentComplete () override
 
- Public Member Functions inherited from cutehmi::services::AbstractService
 ~AbstractService () override
 
int shutdownTimeout () const
 
void setShutdownTimeout (int shutdownTimeout)
 Set shutdown timeout. More...
 
int stopTimeout () const
 
void setStopTimeout (int stopTimeout)
 Set stop timeout. More...
 
int startTimeout () const
 
void setStartTimeout (int startTimeout)
 Set start timeout. More...
 
int repairTimeout () const
 
void setRepairTimeout (int repairTimeout)
 Set repair timeout. More...
 
QString name () const
 
void setName (const QString &name)
 
QString status () const
 
cutehmi::services::StateInterfacestates () const
 Get state interface. More...
 
QQmlListProperty< cutehmi::services::AbstractServiceControllerdefaultControllerList ()
 
QQmlListProperty< cutehmi::services::AbstractServiceControllercontrollerList ()
 
Q_INVOKABLE void appendController (cutehmi::services::AbstractServiceController *controller)
 
Q_INVOKABLE void clearControllers ()
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () 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)
 
QThreadthread () 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)
 
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
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
 
virtual void classBegin ()=0
 
virtual void componentComplete ()=0
 

Properties

QVariant serviceable
 
- Properties inherited from cutehmi::services::AbstractService
int shutdownTimeout
 
int stopTimeout
 
int startTimeout
 
int repairTimeout
 
QString name
 
QString status
 
cutehmi::services::StateInterfacestates
 
QQmlListProperty< cutehmi::services::AbstractServiceControllerdefaultControllers
 
QQmlListProperty< cutehmi::services::AbstractServiceControllercontrollers
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Public Slots inherited from cutehmi::services::AbstractService
void start ()
 
void stop ()
 
void activate ()
 
- 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
 
- Static Public Attributes inherited from cutehmi::services::AbstractService
static constexpr int INITIAL_SHUTDOWN_TIMEOUT = 180000
 
static constexpr int INITIAL_STOP_TIMEOUT = 30000
 
static constexpr int INITIAL_START_TIMEOUT = 30000
 
static constexpr int INITIAL_REPAIR_TIMEOUT = 30000
 
static constexpr const char * INITIAL_NAME = "Unnamed Service"
 
- Protected Types inherited from cutehmi::services::AbstractService
typedef QList< AbstractServiceController * > ControllersContainer
 
- Protected Slots inherited from cutehmi::services::AbstractService
void setStatus (const QString &status)
 
- Protected Member Functions inherited from cutehmi::services::AbstractService
 AbstractService (StateInterface *stateInterface, const QString &status, QObject *parent=nullptr, const ControllersContainer *defaultControllers=&DefaultControllers())
 Constructor. More...
 
const ControllersContainercontrollers () const
 
ControllersContainercontrollers ()
 
- Protected Member Functions inherited from QObject
QObjectsender () 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)
 
- Static Protected Member Functions inherited from cutehmi::services::AbstractService
static const ControllersContainerDefaultControllers ()
 

Detailed Description

Service.

Service object acts as a container that wraps any Serviceable instance and makes it accessible through QObject properties defined by it. This approach decouples state interface API from the rest of QObject allowing classes to implement interface, without disturbing their, perhaps more natural, hierarchy (class may inherit only after a single QObject).

Constructor & Destructor Documentation

◆ Service()

cutehmi::services::Service::Service ( QObject parent = nullptr)

◆ ~Service()

cutehmi::services::Service::~Service ( )
override

Member Function Documentation

◆ classBegin()

void cutehmi::services::Service::classBegin ( )
overridevirtual

Implements QQmlParserStatus.

◆ componentComplete()

void cutehmi::services::Service::componentComplete ( )
overridevirtual

Implements QQmlParserStatus.

◆ serviceable()

QVariant cutehmi::services::Service::serviceable ( ) const

Get serviced object.

Returns
serviced object. QVariant wraps Serviceable * pointer.

◆ serviceableChanged

void cutehmi::services::Service::serviceableChanged ( )
signal

◆ setServiceable()

void cutehmi::services::Service::setServiceable ( QVariant  serviceable)

Set serviced object.

Object must implement Serviceable interface. Whole communication between service and serviceable is accomplished through state interface. State interface can not be accessed directly. Instead, serviceable is asked to configure states of the service via Serviceable interface.

Parameters
serviceableserviceable object to be maintained by this service. Object must implement Serviceable interface.

Property Documentation

◆ serviceable

QVariant cutehmi::services::Service::serviceable
readwrite