Класс QScxmlStateMachine

Класс QScxmlStateMachine предоставляет интерфейс к автоматам состояний, созданным из файлов SCXML. Подробнее...

Заголовок:	#include <QScxmlStateMachine>
CMake:	find_package(Qt6 COMPONENTS Scxml REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Scxml)
qmake:	QT += scxml
С версии:	Qt 5.7
Создаётся из:	ScxmlStateMachine
Наследует:	QObject

Список всех членов, включая наследуемые

Свойства

dataModel : QScxmlDataModel*
initialValues : QVariantMap
initialized : bool
invoked : const bool
invokedServices : QList<QScxmlInvokableService*>
loader : QScxmlCompiler::Loader*

name : const QString
parseErrors : const QList<QScxmlError>
running : bool
sessionId : const QString
tableData : QScxmlTableData*

Общедоступные функции

QStringList	activeStateNames(bool compress = true) const
void	cancelDelayedEvent(const QString &sendId)
QMetaObject::Connection	connectToEvent(const QString &scxmlEventSpec, const QObject *receiver, const char *method, Qt::ConnectionType type = Qt::AutoConnection)
QMetaObject::Connection	connectToEvent(const QString &scxmlEventSpec, const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method, Qt::ConnectionType type = Qt::AutoConnection)
typename std::enable_if<!QtPrivate::FunctionPointer<Functor>::IsPointerToMemberFunction && !std::is_same<const char *, Functor>::value, QMetaObject::Connection>::type	connectToEvent(const QString &scxmlEventSpec, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)
typename std::enable_if<!QtPrivate::FunctionPointer<Functor>::IsPointerToMemberFunction && !std::is_same<const char *, Functor>::value, QMetaObject::Connection>::type	connectToEvent(const QString &scxmlEventSpec, const QObject *context, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)
QMetaObject::Connection	connectToState(const QString &scxmlStateName, const QObject *receiver, const char *method, Qt::ConnectionType type = Qt::AutoConnection)
QMetaObject::Connection	connectToState(const QString &scxmlStateName, const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method, Qt::ConnectionType type = Qt::AutoConnection)
typename std::enable_if<!QtPrivate::FunctionPointer<Functor>::IsPointerToMemberFunction && !std::is_same<const char *, Functor>::value, QMetaObject::Connection>::type	connectToState(const QString &scxmlStateName, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)
typename std::enable_if<!QtPrivate::FunctionPointer<Functor>::IsPointerToMemberFunction && !std::is_same<const char *, Functor>::value, QMetaObject::Connection>::type	connectToState(const QString &scxmlStateName, const QObject *context, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)
QScxmlDataModel *	dataModel() const
QVariantMap	initialValues()
QList<QScxmlInvokableService *>	invokedServices() const
bool	isActive(const QString &scxmlStateName) const
bool	isDispatchableTarget(const QString &target) const
bool	isInitialized() const
bool	isInvoked() const
bool	isRunning() const
QScxmlCompiler::Loader *	loader() const
QString	name() const
QList<QScxmlError>	parseErrors() const
QString	sessionId() const
void	setDataModel(QScxmlDataModel *model)
void	setInitialValues(const QVariantMap &initialValues)
void	setLoader(QScxmlCompiler::Loader *loader)
void	setRunning(bool running)
void	setTableData(QScxmlTableData *tableData)
QStringList	stateNames(bool compress = true) const
void	submitEvent(QScxmlEvent *event)
void	submitEvent(const QString &eventName)
void	submitEvent(const QString &eventName, const QVariant &data)
QScxmlTableData *	tableData() const

Общедоступные слоты

bool	init()
void	start()
void	stop()

Сигналы

void	dataModelChanged(QScxmlDataModel *model)
void	finished()
void	initialValuesChanged(const QVariantMap &initialValues)
void	initializedChanged(bool initialized)
void	invokedServicesChanged(const QList<QScxmlInvokableService > &invokedServices*)
void	loaderChanged(QScxmlCompiler::Loader *loader)
void	log(const QString &label, const QString &msg)
void	reachedStableState()
void	runningChanged(bool running)
void	tableDataChanged(QScxmlTableData *tableData)

Статические публичные члены

QScxmlStateMachine *	fromData(QIODevice *data, const QString &fileName = QString())
QScxmlStateMachine *	fromFile(const QString &fileName)
std::function<void (bool)>	onEntry(const QObject *receiver, const char *method)
std::function<void (bool)>	onEntry(Functor functor)
std::function<void (bool)>	onEntry(const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method)
std::function<void (bool)>	onExit(const QObject *receiver, const char *method)
std::function<void (bool)>	onExit(Functor functor)
std::function<void (bool)>	onExit(const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method)

Защищенные функции

bool	isActive(int stateIndex) const

Подробное описание

QScxmlStateMachine — это реализация State Chart XML (SCXML).

Все состояния, определённые в файле SCXML, доступны как свойства QScxmlStateMachine. Эти свойства — булевы значения, указывающие, активное состояние или нет.

Примечание: QScxmlStateMachine требует QEventLoop для корректной работы. Внутри цикла обработки событий реализована функция delay для обработки событий, и планирование работы машины состояний происходит при поступлении событий из вложенных (или родительских) машин состояний.

Документация свойств

`[bindable]` dataModel : QScxmlDataModel*

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство содержит модель данных, которая будет использоваться для этой машины состояний.

Модели данных SCXML описаны в Спецификация SCXML - 5 Модель данных и манипулирование данными. Дополнительную информацию о поддерживаемых моделях данных см. в Соответствии SCXML.

Изменение модели данных, когда машина состояний уже initialized не указано в стандарте SCXML и приводит к неопределённому поведению.

См. также QScxmlDataModel, QScxmlNullDataModel и QScxmlCppDataModel.

`[bindable]` initialValues : QVariantMap

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство содержит начальные значения, которые будут использоваться для настройки модели данных.

См. также QScxmlStateMachine::init() и QScxmlDataModel.

`[bindable read-only]` initialized : bool

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство указывает, была ли инициализирована машина состояний.

Это true, если машина состояний была инициализирована, false в противном случае.

См. также QScxmlStateMachine::init() и QScxmlDataModel.

`[read-only]` invoked : const bool

Это свойство указывает, была ли машина состояний вызвана из внешней машины состояний.

true когда машина состояний была запущена как служба с элементом <invoke>, false в противном случае.

Функции доступа:

bool	isInvoked() const

`[bindable read-only]` invokedServices : QList<QScxmlInvokableService*>

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство содержит список SCXML-служб, которые были вызваны из основной машины состояний (возможно, рекурсивно).

`[bindable]` loader : QScxmlCompiler::Loader*

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство содержит загрузчик, который в данный момент используется для разрешения и загрузки URI для машины состояний.

`[read-only]` name : const QString

Это свойство содержит имя машины состояний, заданное атрибутом name тега <scxml>.

Функции доступа:

QString name() const

`[read-only]` parseErrors : const QList<QScxmlError>

Это свойство содержит список ошибок разбора, возникших при создании машины состояний из файла SCXML.

Функции доступа:

QList<QScxmlError> parseErrors() const

running : bool

Это свойство содержит состояние выполнения этой машины состояний.

Функции доступа:

bool	isRunning() const
void	setRunning(bool running)

Сигнал уведомления:

void	runningChanged(bool running)

См. также start().

`[read-only]` sessionId : const QString

Это свойство содержит идентификатор сеанса текущей машины состояний.

Идентификатор сеанса используется для маршрутизации сообщений между родительской и дочерней машинами состояний. Если машина состояний запускается с помощью элемента <invoke>, любые отправляемые ею события будут иметь поле invokeid со значением идентификатора сеанса. Машина состояний будет использовать источник события (который устанавливается атрибутом target или targetexpr в элементе <send> для отправки сообщений в соответствующую дочернюю машину состояний.

Функции доступа:

QString sessionId() const

См. также QScxmlEvent::invokeId().

`[bindable]` tableData : QScxmlTableData*

Примечание: Это свойство поддерживает привязки QProperty.

Это свойство содержит данные таблицы, которые используются при генерации C++ из файла SCXML.

Класс, реализующий машину состояний, будет использовать это свойство для присвоения сгенерированных данных таблицы. Машина состояний не предполагает владения данными таблицы.

Документация членов-функций

`[signal]` void QScxmlStateMachine::finished()

Этот сигнал излучается, когда машина состояний достигает конечного состояния верхнего уровня.

См. также running.

`[slot]` bool QScxmlStateMachine::init()

Инициализирует машину состояний.

Инициализация машины состояний включает в себя вызов QScxmlDataModel::setup(), установку начальных значений для <data> элементов и выполнение любых <script> тегов тега <scxml>. Начальные значения данных берутся из свойства initialValues.

Возвращает false если произошли ошибки разбора или любой из шагов инициализации завершился неудачей. Возвращает true в противном случае.

`[signal]` void QScxmlStateMachine::log(const QString &label, const QString &msg)

Этот сигнал излучается, если используется тег <log> в SCXML. label - значение атрибута label тега <log>. msg - значение вычисленного атрибута expr тега <log>. Если атрибут expr отсутствует, будет возвращена пустая строка.

`[signal]` void QScxmlStateMachine::reachedStableState()

Этот сигнал излучается, когда очередь событий пуста в конце макрошага или когда достигнуто конечное состояние.

`[signal]` void QScxmlStateMachine::runningChanged(bool running)

Этот сигнал излучается при изменении свойства running с running в качестве аргумента.

Примечание: Сигнал уведомления для свойства running.

`[slot]` void QScxmlStateMachine::start()

Запускает эту машину состояний. Машина сбросит свою конфигурацию и перейдет в начальное состояние. При входе в конечное состояние верхнего уровня машина излучит сигнал finished().

Примечание: Машина состояний не будет работать без работающего цикла событий, например, основного цикла событий приложения, запущенного с помощью QCoreApplication::exec() или QApplication::exec().

См. также runningChanged(), setRunning(), stop() и finished().

`[slot]` void QScxmlStateMachine::stop()

Останавливает эту машину состояний. Машина не будет выполнять дальнейшие переходы состояний. Свойство running устанавливается в значение false.

См. также runningChanged(), start() и setRunning().

`[invokable]` QStringList QScxmlStateMachine::activeStateNames(bool compress = true) const

Возвращает список имён активных состояний.

Когда состояние активно, все его родительские состояния также активны по определению. Если compress имеет значение true (по умолчанию), родительские состояния будут отфильтрованы, и будут возвращены только листовые состояния. Если compress имеет значение false, будет возвращён полный список активных состояний.

Примечание: К этой функции можно обратиться через систему метаобъектов и из QML. См. Q_INVOKABLE.

`[invokable]` void QScxmlStateMachine::cancelDelayedEvent(const QString &sendId)

Отменяет отложенное событие со значением sendId.

Примечание: Данная функция может вызываться через метаобъектную систему и из QML. См. Q_INVOKABLE.

QMetaObject::Connection QScxmlStateMachine::connectToEvent(const QString &scxmlEventSpec, const QObject **receiver*, const char **method, Qt::ConnectionType type* = Qt::AutoConnection)

Создаёт соединение указанного типа type от события, заданного scxmlEventSpec, к методу method в объекте receiver. Метод method объекта receiver может принимать QScxmlEvent в качестве параметра. Например:

void mySlot(const QScxmlEvent &event);

В отличие от спецификаций событий в SCXML-документах, пробелы в scxmlEventSpec здесь недопустимы. Для подключения к нескольким событиям с разными префиксами, необходимо вызывать connectToEvent() несколько раз.