Класс QStateMachine

Класс QStateMachine предоставляет иерархическую конечный автомат. Подробнее...

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

Примечание: Все функции в этом классе являются перевходовыми.

Примечание: Эти функции также безопасные для потоков:

• postEvent()
• postDelayedEvent()
• cancelDelayedEvent()
• postDelayedEvent()

Типы

Свойства

• анимирован : bool
• строкаОшибки : QString
• глобальнаяПолитикаВосстановления : QState::RestorePolicy
• запущен : bool

Открытые функции

Переопределенные открытые функции

Открытые слоты

Сигналы

Переопределенные защищенные функции

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

QStateMachine базируется на понятиях и обозначениях Statecharts. QStateMachine является частью Qt State Machine Framework.

Конечный автомат управляет набором состояний (классы, наследующие от QAbstractState) и переходами (потомки QAbstractTransition) между этими состояниями; эти состояния и переходы определяют граф состояний. После построения графа состояний конечный автомат может его выполнить. Алгоритм выполнения QStateMachine основан на алгоритме State Chart XML (SCXML). Обзор фреймворка предоставляет несколько графов состояний и код для их построения.

Используйте функцию добавитьСостояние(), чтобы добавить верхнеуровневое состояние в конечный автомат. Состояния удаляются с помощью функции удалитьСостояние(). Удаление состояний во время работы автомата не рекомендуется.

Перед запуском автомата необходимо установить начальное состояние. Начальное состояние — это состояние, в которое автомат входит при запуске. Затем вы можете запустить конечный автомат. Сигнал запущен() генерируется при входе в начальное состояние.

Автомат работает на основе событий и имеет собственный цикл обработки событий. События публикуются в автомате через послатьСобытие(). Обратите внимание, что это означает, что он выполняется асинхронно и не будет продвигаться без работающего цикла обработки событий. Обычно вам не нужно публиковать события в автомат напрямую, поскольку переходы Qt, например, QEventTransition и его подклассы, обрабатывают это. Но для пользовательских переходов, запускаемых событиями, послатьСобытие() полезно.

Автомат обрабатывает события и выполняет переходы до тех пор, пока не будет достигнуто верхнеуровневое конечное состояние; в этом случае автомат генерирует сигнал завершен(). Также можно остановить автомат явно. В этом случае генерируется сигнал остановлен().

Следующий фрагмент кода демонстрирует конечный автомат, который завершается при нажатии кнопки:

QPushButton button;

QStateMachine machine;
QState *s1 = new QState();
s1->assignProperty(&button, "text", "Click me");

QFinalState *s2 = new QFinalState();
s1->addTransition(&button, &QPushButton::clicked, s2);

machine.addState(s1);
machine.addState(s2);
machine.setInitialState(s1);
machine.start();

В этом примере кода используется QState, который наследует от QAbstractState. Класс QState предоставляет состояние, которое можно использовать для задания свойств и вызова методов объектов QObject при входе или выходе из состояния. Он также содержит удобные функции для добавления переходов, например, QSignalTransition как в этом примере. Дополнительные сведения см. в описании класса QState.

Если возникает ошибка, машина будет искать состояние ошибки, и если оно доступно, перейдет в это состояние. Типы возможных ошибок описаны в перечислении Error. После входа в состояние ошибки тип ошибки можно получить с помощью error(). Выполнение графа состояний не остановится при входе в состояние ошибки. Если состояние ошибки не применимо к ошибочному состоянию, машина прекратит выполнение, и сообщение об ошибке будет выведено в консоль.

См. также QAbstractState, QAbstractTransition, QState и Обзор Qt State Machine.

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

перечисление QStateMachine::Error

Это перечисление определяет ошибки, которые могут возникнуть в машине состояний во время выполнения. Когда машина состояний сталкивается с невосстановимой ошибкой во время выполнения, она установит код ошибки, возвращаемый error(), сообщение об ошибке, возвращаемое errorString(), и перейдет в состояние ошибки, основываясь на контексте ошибки.

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

перечисление QStateMachine::EventPriority

Это перечисление определяет приоритет события, размещенного в машине состояний с помощью postEvent().

События с высоким приоритетом обрабатываются перед событиями с обычным приоритетом.

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

QStateMachine::QStateMachine(QObject *parent = nullptr)

Конструирует новую машину состояний с заданным parent.

[signal, since 5.4] void QStateMachine::runningChanged(bool running)

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

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

Эта функция была добавлена в Qt 5.4.

См. также QStateMachine::running.

[slot] void QStateMachine::start()

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

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

[private signal] void QStateMachine::started()

Этот сигнал излучается при входе машины состояний в ее начальное состояние (QStateMachine::initialState).

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

См. также QStateMachine::finished() и QStateMachine::start().

[slot] void QStateMachine::stop()

Останавливает эту машину состояний. Машина состояний прекратит обработку событий и затем излучит сигнал stopped().

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

[private signal] void QStateMachine::stopped()

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

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

См. также QStateMachine::stop() и QStateMachine::finished().

[virtual] QStateMachine::~QStateMachine()

Уничтожает эту машину состояний.

void QStateMachine::addDefaultAnimation(QAbstractAnimation *animation)

Добавляет анимацию по умолчанию animation, которая будет учитываться для любого перехода.

void QStateMachine::addState(QAbstractState *state)

Добавляет заданное состояние в эту машину состояний. Состояние становится состоянием верхнего уровня, и машина состояний берет на себя владение состоянием.

Если состояние уже находится в другой машине, оно сначала будет удалено из старой машины, а затем добавлено в эту машину.

См. также removeState() и setInitialState().

bool QStateMachine::cancelDelayedEvent(int id)

Отменяет отложенное событие, идентифицируемое заданным id. Идентификатор должен быть значением, возвращённым вызовом postDelayedEvent(). Возвращает true если событие было успешно отменено, в противном случае возвращает false.

Примечание: Эта функция является потокобезопасной.

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

void QStateMachine::clearError()

Очищает строку ошибки и код ошибки состояния машины.

QSet<QAbstractState *> QStateMachine::configuration() const

Возвращает максимальный согласованный набор состояний (включая параллельные и конечные состояния), в котором в данный момент находится эта машина состояний. Если состояние s находится в конфигурации, то всегда верно, что родитель s также находится в c. Однако следует отметить, что сама машина не является явным членом конфигурации.

QList<QAbstractAnimation *> QStateMachine::defaultAnimations() const

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

QStateMachine::Error QStateMachine::error() const

Возвращает код ошибки последней ошибки, произошедшей в машине состояний.

QString QStateMachine::errorString() const

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

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

[override virtual protected] bool QStateMachine::event(QEvent *e)

Переопределяет: QState::event(QEvent *e).

[override virtual] bool QStateMachine::eventFilter(QObject *watched, QEvent *event)

Переопределяет: QObject::eventFilter(QObject *watched, QEvent *event).

QState::RestorePolicy QStateMachine::globalRestorePolicy() const

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

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

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

bool QStateMachine::isAnimated() const

Возвращает значение, определяющее, включены ли анимации для этой машины состояний.

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

[override virtual protected] void QStateMachine::onEntry(QEvent *event)

Переопределяет: QState::onEntry(QEvent *event).

Эта функция вызовет start() для запуска машины состояний.

[override virtual protected] void QStateMachine::onExit(QEvent *event)

Переопределяет: QState::onExit(QEvent *event).

Эта функция вызовет stop() для остановки машины состояний и последующего вывода сигнала stopped().

int QStateMachine::postDelayedEvent(QEvent *event, int delay)

Отправляет данное event на обработку этой машиной состояний с заданной задержкой в миллисекундах delay. Возвращает идентификатор, связанный с отложенным событием, или -1, если событие не могло быть отправлено.

Функция возвращает результат немедленно. По истечении задержки событие будет добавлено в очередь событий машины состояний для обработки. Машина состояний принимает владение событием и удаляет его после обработки.

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

Примечание: Эта функция является потокобезопасной.

См. также cancelDelayedEvent() и postEvent().

[since 5.15] int QStateMachine::postDelayedEvent(QEvent *event, std::chrono::milliseconds delay)

Это перегруженная функция.

Отправляет данное event на обработку этой машиной состояний с заданной задержкой в миллисекундах delay. Возвращает идентификатор, связанный с отложенным событием, или -1, если событие не могло быть отправлено.

Функция возвращает результат немедленно. По истечении задержки событие будет добавлено в очередь событий машины состояний для обработки. Машина состояний принимает владение событием и удаляет его после обработки.

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

Примечание: Эта функция является потокобезопасной.

Функция была введена в Qt 5.15.

См. также cancelDelayedEvent() и postEvent().

void QStateMachine::postEvent(QEvent *event, QStateMachine::EventPriority priority = NormalPriority)

Отправляет данное event с заданным priority на обработку этой машиной состояний.

Функция возвращает результат немедленно. Событие добавляется в очередь событий машины состояний. События обрабатываются в порядке отправки. Машина состояний принимает владение событием и удаляет его после обработки.

Отправлять события можно только когда машина состояний запущена или при её запуске.

Примечание: Эта функция является потокобезопасной.

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

void QStateMachine::removeDefaultAnimation(QAbstractAnimation *animation)

Удаляет animation из списка анимаций по умолчанию.

void QStateMachine::removeState(QAbstractState *state)

Удаляет данное state из этой машины состояний. Машина состояний освобождает владение состоянием.

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

void QStateMachine::setAnimated(bool enabled)

Устанавливает, включены ли анимации для этой машины состояний.

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

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

void QStateMachine::setGlobalRestorePolicy(QState::RestorePolicy restorePolicy)

Устанавливает политику восстановления машины состояний в restorePolicy. Политика восстановления по умолчанию — QState::DontRestoreProperties.

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

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