Класс QScxmlEvent

Класс QScxmlEvent представляет событие для Qt SCXML-машины состояний. Подробнее...

Заголовок:	#include <QScxmlEvent>
qmake:	QT += scxml
С момента:	Qt 5.7

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

Типы

Перечисление ТипСобытия { СобытиеПлатформы, ВнутреннееСобытие, ВнешнееСобытие }

Свойства

данные : QVariant
задержка : int
событиеОшибки : const bool
сообщениеОбОшибке : QString
типСобытия : ТипСобытия
идентификаторВызова : QString

имя : QString
источник : QString
типИсточника : QString
типScxml : const QString
идентификаторОтправки : QString

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

…

	QScxmlEvent()
	QScxmlEvent(const QScxmlEvent &other)
	~QScxmlEvent()
void	очистить()
QVariant	данные() const
int	задержка() const
QString	сообщениеОбОшибке() const
ТипСобытия	типСобытия() const
QString	идентификаторВызова() const
bool	являетсяСобытиемОшибки() const
QString	имя() const

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

Класс QScxmlEvent — это событие для машины состояний Qt SCXML.

Переходы в SCXML управляются событиями. Большинство событий генерируются с помощью элементов <raise> и <send> в приложении. Машина состояний автоматически генерирует некоторые обязательные события, такие как ошибки.

Дополнительную информацию см. в Спецификации SCXML — 5.10.1 Внутренняя структура событий. Дополнительную информацию о том, чем API Qt SCXML отличается от спецификации, см. в Соответствии SCXML.

См. также QScxmlStateMachine.

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

enum QScxmlEvent::EventType

Этот перечисление определяет тип события SCXML:

Константа	Значение	Описание
`QScxmlEvent::PlatformEvent`	`0`	Событие, сгенерированное внутри машины состояний. Например, ошибки.
`QScxmlEvent::InternalEvent`	`1`	Событие, сгенерированное элементом `<raise>`.
`QScxmlEvent::ExternalEvent`	`2`	Событие, сгенерированное элементом `<send>`.

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

data : QVariant

Это свойство содержит данные, включённые отправителем.

Когда <param> элементы используются в <send> элементе, данные будут содержать QVariantMap, где ключ — атрибут name, а значение взято из атрибута expr или location.

Когда используется <content> элемент, данные будут содержать единственный элемент со значением атрибута expr <content> элемента или данными дочернего <content> элемента.

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

QVariant	data() const
void	setData(const QVariant &data)

delay : int

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

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

int	delay() const
void	setDelay(int delayInMiliSecs)

errorEvent : const bool

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

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

bool	isErrorEvent() const

errorMessage : QString

Это свойство содержит сообщение об ошибке для события ошибки или пустой QString.

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

QString	errorMessage() const
void	setErrorMessage(const QString &message)

eventType : EventType

Это свойство содержит тип события.

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

EventType	eventType() const
void	setEventType(const EventType &type)

invokeId : QString

Это свойство содержит ID вызванной машины состояний, если событие сгенерировано ею.

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

QString	invokeId() const
void	setInvokeId(const QString &invokeid)

name : QString

Это свойство содержит имя события.

Если событие сгенерировано внутри документа SCXML, это свойство содержит значение атрибута event, указанного внутри <raise> или <send> элемента.

Если событие создано в коде C++ и передано в QScxmlStateMachine, значение этого свойства сопоставляется со значением атрибута event, указанного внутри <transition> элемента в документе SCXML.

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

QString	name() const
void	setName(const QString &name)

origin : QString

Это свойство содержит URI, указывающий на источник события SCXML.

Источник эквивалентен атрибуту target элемента <send>.

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

QString	origin() const
void	setOrigin(const QString &origin)

originType : QString

Это свойство содержит тип источника события SCXML.

Тип источника эквивалентен атрибуту type элемента <send>.

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

QString	originType() const
void	setOriginType(const QString &origintype)

scxmlType : const QString

Это свойство содержит тип события.

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

QString scxmlType() const

sendId : QString

Это свойство содержит ID события.

ID используется элементом <cancel> для идентификации события, которое нужно отменить.

Примечание: Машина состояний генерирует уникальный ID, если атрибут id не указан в элементе <send> . Сгенерированный ID можно получить через это свойство.

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

QString	sendId() const
void	setSendId(const QString &sendid)

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

QScxmlEvent::QScxmlEvent()

Создаёт новое внешнее событие SCXML.

QScxmlEvent::QScxmlEvent(const QScxmlEvent &other)

Создаёт копию other.

QScxmlEvent::~QScxmlEvent()

Удаляет событие SCXML.

void QScxmlEvent::clear()

Очищает содержимое события.

QVariant QScxmlEvent::data() const

Возвращает данные, включённые отправителем.

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

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

int QScxmlEvent::delay() const

Возвращает задержку в миллисекундах, после которой это событие должно быть доставлено после обработки элемента <send>.

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

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

QString QScxmlEvent::errorMessage() const

Если это событие ошибки, возвращает сообщение об ошибке. В противном случае возвращает пустой QString.

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

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

EventType QScxmlEvent::eventType() const

Возвращает тип этого события.

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

См. также setEventType() и QScxmlEvent::EventType.

QString QScxmlEvent::invokeId() const

Если это событие сгенерировано вызванной машиной состояний, возвращает ID элемента <invoke>. В противном случае возвращает пустое значение.

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

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

bool QScxmlEvent::isErrorEvent() const

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

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

QString QScxmlEvent::name() const

Возвращает имя события.

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

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

QString QScxmlEvent::origin() const

Возвращает URI, указывающий на источник события SCXML.

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

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

QString QScxmlEvent::originType() const

Возвращает тип источника события SCXML.

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

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

QString QScxmlEvent::scxmlType() const

Возвращает тип события.

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

QString QScxmlEvent::sendId() const

Возвращает идентификатор события.

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

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

void QScxmlEvent::setData(const QVariant &data)

Устанавливает данные полезной нагрузки в data.

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

См. также QScxmlEvent::data.

void QScxmlEvent::setDelay(int delayInMiliSecs)

Устанавливает задержку в миллисекундах как значение delayInMiliSecs.

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

См. также QScxmlEvent::delay.

void QScxmlEvent::setErrorMessage(const QString &message)

Если это событие об ошибке, message устанавливается как сообщение об ошибке.

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

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

void QScxmlEvent::setEventType(const EventType &type)

Устанавливает тип события на type.

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

См. также QScxmlEvent::eventType и QScxmlEvent::EventType.

void QScxmlEvent::setInvokeId(const QString &invokeid)

Устанавливает идентификатор вызываемой машины состояний в invokeid.

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

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

void QScxmlEvent::setName(const QString &name)

Устанавливает имя события на name.

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

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

void QScxmlEvent::setOrigin(const QString &origin)

Устанавливает источник события SCXML в origin.

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

См. также QScxmlEvent::origin.

void QScxmlEvent::setOriginType(const QString &origintype)

Устанавливает тип источника события SCXML в origintype.

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

См. также QScxmlEvent::originType.

void QScxmlEvent::setSendId(const QString &sendid)

Устанавливает идентификатор sendid для этого события.

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

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

QScxmlEvent &QScxmlEvent::operator=(const QScxmlEvent &other)

Присваивает other этому событию SCXML и возвращает ссылку на это событие SCXML.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qscxmlevent.html