QScxmlStateMachine 类

成员函数文档

创建从由 scxmlEventSpec 指定的事件到 functor 的给定 type 的连接，其中 functor 可以是泛型或可选 context 对象的成员函数。

接收器的 functor 必须接受一个 QScxmlEvent 参数。

与 SCXML 文档中的事件规范不同，此处不允许在 scxmlEventSpec 中使用空格。为了连接到具有不同前缀的多个事件，必须多次调用 connectToEvent()。

返回连接处理的句柄，可稍后用于断开连接。

创建从由 scxmlStateName 指定的状态到 functor 的连接，其中 functor 可以是一个函数对象或可选的 context 对象的成员函数。

接收者的 functor 必须接受一个布尔参数，该参数指示所连接的状态是否变得活跃或非活跃。

返回连接处理的句柄，可稍后用于断开连接。

[调用] QStringList QScxmlStateMachine::activeStateNames(bool compress = true) const

获取所有活跃状态的状态名称列表。

当一个状态是活跃的，根据定义，所有其父状态都是活跃的。当 compress 为 true（默认值）时，父状态将被过滤，并且仅返回 叶片状态。当它为 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)

从由 scxmlEventSpec 指定的事件创建到 receiver 对象的 method 的连接。接收者的 method 可以接受一个 QScxmlEvent 作为参数。例如

void mySlot(const QScxmlEvent &event);

与 SCXML 文档中的事件规范不同，此处不允许在 scxmlEventSpec 中使用空格。为了连接到具有不同前缀的多个事件，必须多次调用 connectToEvent()。

返回连接处理的句柄，可稍后用于断开连接。

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

创建一个从由 scxmlStateName 确定的状态到 receiver 对象的 method 的连接，其中 method 可以接受一个布尔参数，该参数指示所连接的状态是否变得活跃或非活跃。例如

void mySlot(bool active);

返回连接处理的句柄，可稍后用于断开连接。

QScxmlDataModel *QScxmlStateMachine::dataModel() const

返回状态机使用的模型。

另见：setDataModel().

[信号] void QScxmlStateMachine::finished()

当状态机到达顶级最终状态时，会发出此信号。

另见：running.

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

通过读取指定的data所述QIODevice创建状态机。

此方法始终返回状态机。如果在读取SCXML文件时发生错误，则无法启动状态机。可以通过调用parseErrors()方法检索错误。

另见：parseErrors.

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

从指定的fileName SCXML文件创建状态机。

此方法始终返回状态机。如果在读取SCXML文件时发生错误，则无法启动状态机。可以通过调用parseErrors()方法检索错误。

另见：parseErrors.

[槽] bool QScxmlStateMachine::init()

初始化状态机。

状态机初始化包括调用QScxmlDataModel::setup()，设置<data>元素的初始值，以及执行<scxml>标签的任何<script>标签。初始数据值来自initialValues属性。

如果在解析过程中发生错误或任何初始化步骤失败，则返回false。否则返回true。

[可调用] bool QScxmlStateMachine::isActive(const QString &scxmlStateName) const

如果scxmlStateName指定的状态是活跃的，则返回true，否则返回false。

[保护] bool QScxmlStateMachine::isActive(int stateIndex) const

如果ID为stateIndex的状态是活跃的，则返回true。

此方法是SCXML状态机编译表示接口的一部分。它应仅在内部使用，并由SCXML文档编译的状态机使用。

[可调用] bool QScxmlStateMachine::isDispatchableTarget(const QString &target) const

如果此状态机可以发送到target的消息，则返回true。

有效的目标有

• #_parent，如果当前状态机通过<invoke>启动，则为父状态机
• #_internal，对于当前状态机
• #_scxml_sessionid，其中 sessionid 是当前状态机的会话ID
• #_servicename，其中 servicename 是通过状态机 <invoke> 启动的服务的ID或名称

bool QScxmlStateMachine::isRunning() const

如果状态机正在运行，则返回 true，否则返回 false。

另请参阅：setRunning() 和 runningChanged。

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

如果SCXML中使用 <log> 标签，则发送此信号。 label 是 <log> 标签的 label 属性的值。 msg 是 <；log> 标签评估的 expr 属性的值。如果没有 expr 属性，则返回空字符串。

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

返回一个接受布尔参数的函子，如果该参数为 true，则将给定的 method 在 receiver 上使用 QMetaObject::invokeMethod() 调用（如果 receiver 尚未删除）。

给定的 method 不应接受任何参数。 method 是普通的方法名称，不是用 SIGNAL() 或 SLOT() 封装。

这对于将处理程序 connectToState 封装起来非常有用，只有当状态被进入时才执行该处理程序。

[静态] 模板 <typename Functor> std::function<void (bool)> QScxmlStateMachine::onEntry(Functor functor)

返回一个接受布尔参数的函子，如果该参数为 true，则调用给定的 functor。给定的 functor 不接受任何参数。

这对于将处理程序 connectToState 封装起来非常有用，只有当状态被进入时才执行该处理程序。

[静态] 模板 <typename PointerToMemberFunction> std::function<

返回一个接受布尔参数的函子，如果该参数为 true 且 receiver 尚未删除，则调用 receiver 上的给定 method。给定的 method 不接受任何参数。

这对于将处理程序 connectToState 封装起来非常有用，只有当状态被进入时才执行该处理程序。

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

返回一个接受布尔参数并在该参数为false且接收者尚未被删除的情况下调用指定方法的仿函数。使用QMetaObject::invokeMethod()通过接收者调用该方法。

给定方法不得接受任何参数。method是方法的纯名称，不包括在SIGNAL(...)或SLOT(...)中。

当状态被离开时，这对于封装connectToState()的处理程序非常有用。

[静态]模板 <typename Functor> std::function<void (bool)> QScxmlStateMachine::onExit(Functor functor)

返回一个接受布尔参数并在该参数为false时调用给定仿函数的仿函数。给定仿函数不得接受任何参数。

当状态被离开时，这对于封装connectToState()的处理程序非常有用。

[静态]模板 <typename PointerToMemberFunction> std::function<void (bool)> QScxmlStateMachine::onExit(const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method)

返回一个接受布尔参数并在该参数为false且接收者尚未被删除的情况下调用给定接收者上指定方法的仿函数。给定方法不得接受任何参数。

当状态被离开时，这对于封装connectToState()的处理程序非常有用。

[信号] void QScxmlStateMachine::reachedStableState()

在宏步骤结束时事件队列为空或达到最终状态时发出此信号。

[信号] void QScxmlStateMachine::runningChanged(bool running)

当将running属性更改时的参数为running时发出此信号。

void QScxmlStateMachine::setDataModel(QScxmlDataModel *model)

为此状态机设置数据模型model。状态机与模型之间有一个1:1的关系。设置模型一次后，您无法再更改它。使用此方法进一步尝试设置模型将被忽略。

另请参阅：dataModel。

void QScxmlStateMachine::setRunning(bool running)

如果running为true，则启动状态机，否则停止。

另请参阅：start()，stop()，isRunning()和runningChanged()。

[槽函数] void QScxmlStateMachine::start()

启动此状态机。机器将重置其配置并转到初始状态。当进入最终顶层状态时，机器将发出finished()信号。

另请参阅runningChanged，setRunning，stop，和 finished。

[可调用] QStringList QScxmlStateMachine::stateNames(bool compress = true) const

获取所有状态的状态名称列表。

当 compress 为 true（默认值），包含子状态的状态将被过滤，只返回 叶状态。当它为 false 时，将返回所有状态的完整列表。

返回的列表不包含可能嵌套的状态机的状态。

[槽函数] 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 作为名称和数据作为有效载荷数据的辅助方法。