Класс QScxmlStateMachine

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

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

Свойства

• 1 свойство унаследовано от QObject

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

• 32 общедоступных функций, унаследованных от QObject

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

• 1 общедоступный слот, унаследованный от QObject

Сигналы

• 2 сигнала унаследованы от QObject

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

• 11 статических публичных членов унаследовано от QObject

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

• 9 защищенных функций унаследовано от QObject

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

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

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

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

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

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

[protected] QScxmlStateMachine::QScxmlStateMachine(const QMetaObject *metaObject, QObject *parent = nullptr)

Инициализирует экземпляр QScxmlStateMachine.

[protected] QScxmlStateMachine::QScxmlStateMachine(QScxmlStateMachinePrivate &dd, QObject *parent = nullptr)

Конструктор копирования.

QStringList QScxmlStateMachine::activeStateNames(bool compress = true) const

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

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

void QScxmlStateMachine::cancelDelayedEvent(const QString &sendId)

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

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() несколько раз.

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

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

Создаёт соединение заданного типа type от события, заданного scxmlEventSpec, к методу method в объекте receiver.

Метод method объекта receiver должен принимать QScxmlEvent в качестве параметра.

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

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

QMetaObject::Connection QScxmlStateMachine::connectToEvent(const QString &scxmlEventSpec, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)

Создаёт соединение заданного типа type от события, заданного scxmlEventSpec, к functor.

Functor должен принимать QScxmlEvent в качестве параметра.

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

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

QMetaObject::Connection QScxmlStateMachine::connectToEvent(const QString &scxmlEventSpec, const QObject *context, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)

Создаёт соединение заданного типа type от события, заданного scxmlEventSpec, к functor, используя context в качестве контекста.

Functor должен принимать QScxmlEvent в качестве параметра.

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

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

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

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

void mySlot(bool active);

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

QMetaObject::Connection QScxmlStateMachine::connectToState(const QString &scxmlStateName, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type = Qt::AutoConnection)

Создаёт соединение заданного типа type от состояния, заданного scxmlStateName, к методу method в объекте receiver.

Метод method объекта receiver должен принимать булевый аргумент, указывающий, стало ли подключенное состояние активным или неактивным.

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

QMetaObject::Connection QScxmlStateMachine::connectToState(const QString &scxmlStateName, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)

Создаёт соединение заданного типа type от состояния, заданного scxmlStateName, к functor.

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

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

QMetaObject::Connection QScxmlStateMachine::connectToState(const QString &scxmlStateName, const QObject *context, Functor functor, Qt::ConnectionType type = Qt::AutoConnection)

Создаёт соединение заданного типа type от состояния, заданного scxmlStateName, к functor, используя context в качестве контекста.

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

Возвращает дескриптор соединения, который можно использовать для последующего разъединения.

QScxmlDataModel *QScxmlStateMachine::dataModel() const

Возвращает используемую модель данных для автомата состояний.

Примечание: Функция-геттер для свойства dataModel.

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

[signal] void QScxmlStateMachine::finished()

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

См. также running.

[static] QScxmlStateMachine *QScxmlStateMachine::fromData(QIODevice *data, const QString &fileName = QString())

Создаёт автомат состояний путём чтения из QIODevice, заданного data.

Этот метод всегда возвращает автомат состояний. Если при чтении SCXML-файла fileName возникнут ошибки, автомат состояний не может быть запущен. Ошибки можно получить, вызвав метод parseErrors().

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

[static] QScxmlStateMachine *QScxmlStateMachine::fromFile(const QString &fileName)

Создаёт автомат состояний из SCXML-файла, указанного fileName.

Этот метод всегда возвращает автомат состояний. Если при чтении SCXML-файла возникнут ошибки, автомат состояний не может быть запущен. Ошибки можно получить, вызвав метод parseErrors().

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

[slot] bool QScxmlStateMachine::init()

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

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

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

bool QScxmlStateMachine::isActive(const QString &scxmlStateName) const

Возвращает true, если состояние, заданное scxmlStateName, активно, false, в противном случае.

[protected] bool QScxmlStateMachine::isActive(int stateIndex) const

Возвращает true, если состояние с идентификатором stateIndex активно.

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

bool QScxmlStateMachine::isDispatchableTarget(const QString &target) const

Возвращает true если сообщение в target может быть обработано этим автоматом состояний.

Допустимые значения target:

• #_parent для родительского автомата состояний, если текущий автомат запущен <invoke>
• #_internal для текущего автомата состояний
• #_scxml_sessionid, где sessionid — идентификатор сессии текущего автомата состояний
• #_servicename, где servicename — идентификатор или имя сервиса, запущенного с <invoke> этим автоматом состояний

bool QScxmlStateMachine::isRunning() const

Возвращает true если автомат состояний работает, false в противном случае.

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

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

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

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

[static] std::function<void( bool ) > QScxmlStateMachine::onEntry(const QObject *receiver, const char *method)

Возвращает функтор, принимающий булево значение и вызывающий заданный метод method на receiver с помощью QMetaObject::invokeMethod() если это значение true и receiver ещё не удалён.

Заданный method не должен принимать никаких аргументов. method — просто имя метода, не заключённое в SIGNAL() или SLOT().

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

[static] std::function<void( bool ) > QScxmlStateMachine::onEntry(Functor functor)

Возвращает функтор, принимающий булево значение и вызывающий заданный functor если это значение true. Заданный functor не должен принимать никаких аргументов.

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

[static] std::function<void( bool ) > QScxmlStateMachine::onEntry(const QObject *receiver, PointerToMemberFunction method)

Возвращает функтор, принимающий булево значение и вызывающий заданный method на receiver если это значение true и receiver ещё не удалён. Заданный method не должен принимать никаких аргументов.

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

[static] std::function<void( bool ) > QScxmlStateMachine::onExit(const QObject *receiver, const char *method)

Возвращает функтор, принимающий булево значение и вызывающий заданный метод method на receiver с помощью QMetaObject::invokeMethod() если это значение false и receiver ещё не удалён.

Заданный method не должен принимать никаких аргументов. method — просто имя метода, не заключённое в SIGNAL(...) или SLOT(...).

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

[static] std::function<void( bool ) > QScxmlStateMachine::onExit(Functor functor)

Возвращает функтор, принимающий булево значение и вызывающий заданный functor если это значение false. Заданный functor не должен принимать никаких аргументов.

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

[static] std::function<void( bool ) > QScxmlStateMachine::onExit(const QObject *receiver, PointerToMemberFunction method)

Возвращает функтор, принимающий булево значение и вызывающий заданный method на receiver если это значение false и receiver ещё не удалён. Заданный method не должен принимать никаких аргументов.

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

[signal] void QScxmlStateMachine::reachedStableState()

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

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

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

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

void QScxmlStateMachine::setDataModel(QScxmlDataModel *model)

Устанавливает модель данных для этого автомата состояний в model. Существует взаимно-однозначное соответствие между автоматами состояний и моделями. После установки модели её нельзя изменить. Попытки установки модели с помощью этого метода будут проигнорированы.

Примечание: Функция-сеттер для свойства dataModel.

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

void QScxmlStateMachine::setRunning(bool running)

Запускает автомат состояний, если running — true, или останавливает его в противном случае.

Примечание: Функция-сеттер для свойства running.

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

[slot] void QScxmlStateMachine::start()

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

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

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

QStringList QScxmlStateMachine::stateNames(bool compress = true) const

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

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

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

Примечание: Порядок имён состояний в списке — это порядок, в котором состояния встречались в документе SCXML.

[slot] void QScxmlStateMachine::stop()

Останавливает этот автомат состояний. Автомат не будет выполнять дальнейшие переходы состояний. Его свойство running устанавливается в false.

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

void QScxmlStateMachine::submitEvent(QScxmlEvent *event)

Отправляет событие SCXML event во внутреннюю или внешнюю очередь событий в зависимости от приоритета события.

Если установлена задержка, событие будет помещено в очередь на доставку после истечения таймаута. Автомат состояний берёт владение event и удаляет его после обработки.

void QScxmlStateMachine::submitEvent(const QString &eventName)

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

void QScxmlStateMachine::submitEvent(const QString &eventName, const QVariant &data)

Утилитарный метод для создания и отправки внешнего события с указанным именем eventName в качестве имени и данными data в качестве полезной нагрузки.