QScxmlInvokableService Class | Qt SCXML 5.9

Qt 5.9 | Qt SCXML | C++ Classes | QScxmlInvokableService

Qt 5.9.4 Reference Documentation

# QScxmlInvokableService Class

The QScxmlInvokableService class is the base class for services called from state machines. More...

Header: | #include <QScxmlInvokableService>
qmake: | QT += scxml
Since: | Qt 5.8
Inherits: | QObject

- List of all members, including inherited members

## Properties

- id : const QString
- name : const QString
- parentStateMachine : QScxmlStateMachine * const

- 1 property inherited from QObject

## Public Functions

| QScxmlInvokableService(QScxmlStateMachine *parentStateMachine, QScxmlInvokableServiceFactory *parent)
virtual QString | id() const = 0
virtual QString | name() const = 0
QScxmlStateMachine * | parentStateMachine() const
virtual void | postEvent(QScxmlEvent *event) = 0
virtual bool | start() = 0

- 32 public functions inherited from QObject

### Additional Inherited Members

- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

The QScxmlInvokableService class is the base class for services called from state machines.

The services are called from state machines via the mechanism described in SCXML Specification - 6.4 <invoke>. This class represents an actual instance of an invoked service.

## Property Documentation

### id : const QString

This property holds the ID of the invokable service.

The ID is specified by the `id` attribute of the `<invoke>` element.

Access functions:

virtual QString | id() const = 0

### name : const QString

This property holds the name of the service being invoked.

Access functions:

virtual QString | name() const = 0

### parentStateMachine : QScxmlStateMachine * const

This property holds the SCXML state machine that invoked the service.

Access functions:

QScxmlStateMachine * | parentStateMachine() const

## Member Function Documentation

### QScxmlInvokableService::QScxmlInvokableService(QScxmlStateMachine *parentStateMachine, QScxmlInvokableServiceFactory *parent)

Default constructs an instance of QScxmlInvokableService.

### `[pure virtual]` void QScxmlInvokableService::postEvent(QScxmlEvent *event)

Sends an event to the service.

### `[pure virtual]` bool QScxmlInvokableService::start()

Starts the invokable service. Returns `true` on success, or `false` if the invocation fails.