En esta página

QScxmlStateMachine Class

La clase QScxmlStateMachine proporciona una interfaz para las máquinas de estados creadas a partir de archivos SCXML. Más información...

Encabezado: #include <QScxmlStateMachine>
CMake: find_package(Qt6 REQUIRED COMPONENTS Scxml)
target_link_libraries(mytarget PRIVATE Qt6::Scxml)
qmake: QT += scxml
En QML: ScxmlStateMachine
Heredan de: QObject

Propiedades

Funciones públicas

QStringList activeStateNames(bool compress = true) const
QBindable<QScxmlDataModel *> bindableDataModel()
QBindable<QVariantMap> bindableInitialValues()
QBindable<bool> bindableInitialized() const
QBindable<QList<QScxmlInvokableService *>> bindableInvokedServices()
QBindable<QScxmlCompiler::Loader *> bindableLoader()
QBindable<QScxmlTableData *> bindableTableData()
void cancelDelayedEvent(const QString &sendId)
QMetaObject::Connection connectToEvent(const QString &scxmlEventSpec, Functor &&functor, Qt::ConnectionType type = Qt::AutoConnection)
QMetaObject::Connection connectToEvent(const QString &scxmlEventSpec, const QObject *context, Functor &&functor, Qt::ConnectionType type = Qt::AutoConnection)
QMetaObject::Connection connectToEvent(const QString &scxmlEventSpec, const QObject *receiver, const char *method, Qt::ConnectionType type = Qt::AutoConnection)
QMetaObject::Connection connectToState(const QString &scxmlStateName, Functor &&functor, Qt::ConnectionType type = Qt::AutoConnection)
QMetaObject::Connection connectToState(const QString &scxmlStateName, 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)
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

Ranuras públicas

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

Señales

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)

Miembros públicos estáticos

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

Funciones protegidas

bool isActive(int stateIndex) const

Descripción detallada

QScxmlStateMachine es una implementación del lenguaje State Chart XML (SCXML).

Se puede acceder a todos los estados definidos en el archivo SCXML como propiedades de QScxmlStateMachine. Estas propiedades son valores booleanos e indican si el estado está activo o inactivo.

Nota: QScxmlStateMachine necesita un ` QEventLoop ` para funcionar correctamente. El bucle de eventos se utiliza para implementar el atributo ` delay ` para los eventos y para programar el procesamiento de una máquina de estados cuando se reciben eventos de máquinas de estados anidadas (o principales).

Documentación de las propiedades

[bindable] dataModel : QScxmlDataModel*

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene el modelo de datos que se utilizará para esta máquina de estados.

Los modelos de datos SCXML se describen en la Especificación SCXML - 5. Modelo de datos y manipulación de datos. Para obtener más información sobre los modelos de datos compatibles, consulte «Cumplimiento con SCXML».

El cambio del modelo de datos una vez que la máquina de estados se ha « initialized » no está especificado en el estándar SCXML y da lugar a un comportamiento indefinido.

Funciones de acceso:

QScxmlDataModel *dataModel() const
void setDataModel(QScxmlDataModel *model)

Señal del notificador:

void dataModelChanged(QScxmlDataModel *model)

Véase también « QScxmlDataModel », « QScxmlNullDataModel » y « QScxmlCppDataModel ».

[bindable] initialValues : QVariantMap

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene los valores iniciales que se utilizarán para configurar el modelo de datos.

Funciones de acceso:

QVariantMap initialValues()
void setInitialValues(const QVariantMap &initialValues)

Señal del notificador:

void initialValuesChanged(const QVariantMap &initialValues)

Véase también QScxmlStateMachine::init() y QScxmlDataModel.

[bindable read-only] initialized : bool

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad indica si la máquina de estados se ha inicializado.

Es « true » si la máquina de estados se ha inicializado; en caso contrario, es « false ».

Funciones de acceso:

bool isInitialized() const

Señal del notificador:

void initializedChanged(bool initialized)

Véase también QScxmlStateMachine::init() y QScxmlDataModel.

[read-only] invoked : const bool

Esta propiedad indica si la máquina de estados se invocó desde una máquina de estados externa.

true cuando la máquina de estados se inició como servicio con el elemento <invoke>, false en los demás casos.

Funciones de acceso:

bool isInvoked() const

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

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene una lista de servicios SCXML que se invocaron desde la máquina de estados principal (posiblemente de forma recursiva).

Funciones de acceso:

QList<QScxmlInvokableService *> invokedServices() const

Señal del notificador:

void invokedServicesChanged(const QList<QScxmlInvokableService *> &invokedServices)

[bindable] loader : QScxmlCompiler::Loader*

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene el cargador que se utiliza actualmente para resolver y cargar los URI de la máquina de estados.

Funciones de acceso:

QScxmlCompiler::Loader *loader() const
void setLoader(QScxmlCompiler::Loader *loader)

Señal del notificador:

void loaderChanged(QScxmlCompiler::Loader *loader)

[read-only] name : const QString

Esta propiedad contiene el nombre de la máquina de estados, tal y como se establece en el atributo «name» de la etiqueta <scxml>.

Funciones de acceso:

QString name() const

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

Esta propiedad contiene la lista de errores de análisis que se produjeron al crear una máquina de estados a partir de un archivo SCXML.

Funciones de acceso:

QList<QScxmlError> parseErrors() const

running : bool

Esta propiedad contiene el estado actual de esta máquina de estados

Funciones de acceso:

bool isRunning() const
void setRunning(bool running)

Señal de notificación:

void runningChanged(bool running)

Véase también start().

[read-only] sessionId : const QString

Esta propiedad contiene el identificador de sesión de la máquina de estados actual.

El identificador de sesión se utiliza para el enrutamiento de mensajes entre máquinas de estados padre e hijo. Si una máquina de estados se inicia mediante un elemento ` <invoke> `, cualquier evento que envíe tendrá el campo ` invokeid ` establecido en el identificador de sesión. La máquina de estados utilizará el origen de un evento (que viene establecido por el atributo «target» o «targetexpr» en un elemento « <send> ») para enviar mensajes a la máquina de estados hija correcta.

Funciones de acceso:

QString sessionId() const

Véase también QScxmlEvent::invokeId().

[bindable] tableData : QScxmlTableData*

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene los datos de la tabla que se utilizan al generar código C++ a partir de un archivo SCXML.

La clase que implementa la máquina de estados utilizará esta propiedad para asignar los datos de la tabla generados. La máquina de estados no asume la propiedad de los datos de la tabla.

Funciones de acceso:

QScxmlTableData *tableData() const
void setTableData(QScxmlTableData *tableData)

Señal del notificador:

void tableDataChanged(QScxmlTableData *tableData)

Documentación de funciones de miembro

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

Recupera una lista con los nombres de todos los estados activos.

Cuando un estado está activo, todos sus estados padres están activos por definición. Cuando compress es true (valor por defecto), los estados padres se filtran y solo se devuelven los estados hoja. Cuando es false, se devuelve la lista completa de estados activos.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

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

Cancela un evento programado con el ` sendId` especificado.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

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

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

Crea una conexión del type dado desde el evento especificado por scxmlEventSpec hasta functor, que puede ser un functor o una función miembro del objeto opcional context.

El functor del receptor debe tomar un QScxmlEvent como parámetro.

A diferencia de las especificaciones de eventos en los documentos SCXML, aquí no se permiten espacios en el scxmlEventSpec. Para conectarse a varios eventos con prefijos diferentes, hay que llamar varias veces a connectToEvent().

Devuelve un identificador de la conexión, que se puede utilizar posteriormente para desconectarse.

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

Crea una conexión de la type especificada desde el evento indicado por scxmlEventSpec hasta la method en el objeto receiver. El method del receptor puede tomar un QScxmlEvent como parámetro. Por ejemplo:

void mySlot(const QScxmlEvent &event);

A diferencia de las especificaciones de eventos en documentos SCXML, aquí no se permiten espacios en el scxmlEventSpec. Para conectarse a varios eventos con prefijos diferentes, hay que llamar a connectToEvent() varias veces.

Devuelve un identificador de la conexión, que se puede utilizar posteriormente para desconectarse.

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

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

Crea una conexión del type dado, desde el estado especificado por scxmlStateName hasta functor, que puede ser un functor o una función miembro del objeto opcional context.

El functor del receptor debe aceptar un argumento booleano que indique si el estado conectado se ha vuelto activo o inactivo.

Devuelve un identificador de la conexión, que se puede utilizar posteriormente para desconectarse.

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

Crea una conexión del type indicado, desde el estado identificado por scxmlStateName hasta el method del objeto receiver. El método method del receptor puede aceptar un argumento booleano que indica si el estado conectado se ha vuelto activo o inactivo. Por ejemplo:

void mySlot(bool active);

Devuelve un identificador de la conexión, que se puede utilizar posteriormente para desconectarse.

QScxmlDataModel *QScxmlStateMachine::dataModel() const

Devuelve el modelo de datos utilizado por la máquina de estados.

Nota: Funcióngetter para la propiedad dataModel.

Véase también setDataModel().

[signal] void QScxmlStateMachine::finished()

Esta señal se emite cuando la máquina de estados alcanza un estado final de nivel superior.

Véase también « running ».

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

Crea una máquina de estados leyendo el archivo QIODevice especificado por data.

Este método siempre devolverá una máquina de estados. Si se producen errores al leer el archivo SCXML fileName, no se podrá iniciar la máquina de estados. Los errores se pueden recuperar llamando al método parseErrors().

Véase también parseErrors().

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

Crea una máquina de estados a partir del archivo SCXML especificado mediante ` fileName`.

Este método siempre devolverá una máquina de estados. Si se producen errores al leer el archivo SCXML, no se podrá iniciar la máquina de estados. Los errores se pueden recuperar llamando al método parseErrors().

Véase también parseErrors().

[slot] bool QScxmlStateMachine::init()

Inicializa la máquina de estados.

La inicialización de la máquina de estados consiste en llamar a ` QScxmlDataModel::setup()`, establecer los valores iniciales de los elementos ` <data> ` y ejecutar las etiquetas ` <script> ` de la etiqueta ` <scxml> `. Los valores iniciales de los datos se obtienen de la propiedad ` initialValues `.

Devuelve « false » si se producen errores de análisis o si falla alguno de los pasos de inicialización. En caso contrario, devuelve « true ».

[invokable] bool QScxmlStateMachine::isActive(const QString &scxmlStateName) const

Devuelve ` true ` si el estado especificado por ` scxmlStateName ` está activo; en caso contrario, devuelve ` false `.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

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

Devuelve « true » si el estado con el ID « stateIndex » está activo.

Este método forma parte de la interfaz de la representación compilada de las máquinas de estados SCXML. Solo debe utilizarse internamente y por máquinas de estados compiladas a partir de documentos SCXML.

[invokable] bool QScxmlStateMachine::isDispatchableTarget(const QString &target) const

Devuelve ` true ` si esta máquina de estados puede enviar un mensaje a ` target `.

Los destinos válidos son:

  • #_parent la máquina de estados principal, si la máquina de estados actual se ha iniciado mediante <invoke>
  • #_internal para la máquina de estados actual
  • #_scxml_sessionid, donde sessionid es el ID de sesión de la máquina de estados actual
  • #_servicename, donde servicename es el ID o el nombre de un servicio iniciado con <invoke> por esta máquina de estados

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

bool QScxmlStateMachine::isRunning() const

Devuelve ` true ` si la máquina de estados está en ejecución; en caso contrario, devuelve ` false `.

Nota: Funcióngetter para la propiedad running.

Véase también setRunning() y runningChanged().

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

Esta señal se emite si se utiliza una etiqueta ` <log> ` en el SCXML. ` label ` es el valor del atributo `label` de la etiqueta ` <log> `. ` msg ` es el valor del atributo `expr ` evaluado de la etiqueta ` <log> `. Si no existe el atributo `expr`, se devolverá una cadena nula.

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

Devuelve un functor que acepta un argumento booleano y llama a la función « functor » especificada si dicho argumento es « true ». La función « functor » especificada no debe aceptar ningún argumento.

Esto resulta útil para envolver manejadores de ` connectToState()` que solo deben ejecutarse al entrar en el estado.

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

Devuelve un functor que acepta un argumento booleano y llama al método method en receiver utilizando QMetaObject::invokeMethod() si dicho argumento es true y receiver aún no ha sido eliminado.

La función method proporcionada no debe aceptar ningún argumento. method es el nombre del método sin adornos, sin estar entre SIGNAL() ni SLOT().

Esto resulta útil para envolver controladores para connectToState() que solo deben ejecutarse al entrar en el estado.

[static] template <typename PointerToMemberFunction> std::function<void (bool)> QScxmlStateMachine::onEntry(const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method)

Devuelve un functor que acepta un argumento booleano y llama a la función method en receiver si dicho argumento es true y el receiver aún no se ha eliminado. La función method proporcionada no debe aceptar ningún argumento.

Esto resulta útil para envolver los controladores de connectToState() que solo deben ejecutarse al entrar en el estado.

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

Devuelve un functor que acepta un argumento booleano y llama a la función functor si dicho argumento es false. La función functor no debe aceptar ningún argumento.

Esto resulta útil para envolver manejadores de ` connectToState()` que solo deben ejecutarse al salir del estado.

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

Devuelve un functor que acepta un argumento booleano y llama al método method en receiver utilizando QMetaObject::invokeMethod() si dicho argumento es false y receiver aún no ha sido eliminado.

La función method especificada no debe aceptar ningún argumento. method es el nombre del método sin más, sin estar entre SIGNAL(...) o SLOT(...).

Esto resulta útil para envolver manejadores de connectToState() que solo deben ejecutarse al salir del estado.

[static] template <typename PointerToMemberFunction> std::function<void (bool)> QScxmlStateMachine::onExit(const typename QtPrivate::FunctionPointer<PointerToMemberFunction>::Object *receiver, PointerToMemberFunction method)

Devuelve un functor que acepta un argumento booleano y llama a la función method pasada en receiver si dicho argumento es false y el receiver aún no se ha eliminado. La función method pasada no debe aceptar ningún argumento.

Esto resulta útil para envolver los controladores de connectToState() que solo deben ejecutarse al salir del estado.

[signal] void QScxmlStateMachine::reachedStableState()

Esta señal se emite cuando la cola de eventos está vacía al final de un paso de macro o cuando se alcanza un estado final.

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

Esta señal se emite cuando se modifica la propiedad « running » con « running » como argumento.

Nota: Señalde notificación para la propiedad ` running`.

void QScxmlStateMachine::setDataModel(QScxmlDataModel *model)

Establece el modelo de datos de esta máquina de estados en model. Existe una relación 1:1 entre las máquinas de estados y los modelos. Una vez establecido el modelo, ya no se puede modificar. Cualquier intento posterior de establecer el modelo mediante este método se ignorará.

Nota: Funciónde asignación para la propiedad dataModel.

Véase también dataModel().

void QScxmlStateMachine::setRunning(bool running)

Inicia la máquina de estados si running es true, o la detiene en caso contrario.

Nota: Funciónde asignación para la propiedad running.

Véase también start(), stop(), isRunning() y runningChanged().

[slot] void QScxmlStateMachine::start()

Inicia esta máquina de estados. Cuando se alcanza un estado final de nivel superior, la máquina emitirá la señal finished().

Nota: Una máquina de estados no funcionará sin un bucle de eventos en ejecución, como el bucle de eventos principal de la aplicación iniciado con QCoreApplication::exec() o QApplication::exec().

Nota: Llamar a start() después de stop() no provocará todavía un restablecimiento completo de su configuración, por lo que se recomienda encarecidamente no hacerlo.

Nota: Al iniciar una máquina finalizada se muestra una advertencia.

Véase también runningChanged(), setRunning(), stop() y finished().

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

Recupera una lista con los nombres de todos los estados.

Cuando ` compress ` es ` true ` (valor por defecto), se filtran los estados que contienen estados secundarios y solo se devuelven los estados hoja. Cuando es ` false`, se devuelve la lista completa de todos los estados.

La lista devuelta no contiene los estados de posibles máquinas de estados anidadas.

Nota: El orden de los nombres de los estados en la lista es el orden en el que aparecían en el documento SCXML.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

[slot] void QScxmlStateMachine::stop()

Detiene esta máquina de estados. La máquina no ejecutará más transiciones de estado. Su propiedad « running » se establece en « false ».

Véanse también runningChanged(), start() y setRunning().

[invokable] void QScxmlStateMachine::submitEvent(QScxmlEvent *event)

Envía el evento SCXML « event » a la cola de eventos interna o externa, en función de la prioridad del evento.

Cuando se establece un retraso, el evento se pondrá en cola para su entrega una vez transcurrido el tiempo de espera. La máquina de estados se hace cargo de event y lo elimina tras su procesamiento.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

[invokable] void QScxmlStateMachine::submitEvent(const QString &eventName)

Un método de utilidad para crear y enviar un evento externo con el nombre « eventName » especificado.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

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

Método de utilidad para crear y enviar un evento externo con el nombre « eventName » y los datos de carga útil « data ».

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.