QScxmlStateMachine Class

Documentación de funciones miembro

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

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

Cuando un estado está activo, todos sus estados padre están activos por definición. Cuando compress es true (el valor predeterminado), los estados padre se filtrarán y sólo se devolverán los estados hoja. Cuando es false, se devuelve la lista completa de estados activos.

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

Cancela un evento retrasado con la dirección sendId especificada.

Crea una conexión del type dado desde el evento especificado por scxmlEventSpec a 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 documentos SCXML, aquí no se permiten espacios en scxmlEventSpec. Para conectarse a varios eventos con prefijos diferentes, connectToEvent() debe llamarse varias veces.

Devuelve un "handle" a la conexión, que puede ser utilizado más tarde para desconectarse.

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

Crea una conexión del type especificado desde el evento especificado por scxmlEventSpec al 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 scxmlEventSpec. Para conectarse a varios eventos con prefijos diferentes, connectToEvent() debe llamarse varias veces.

Devuelve un "handle" a la conexión, que puede utilizarse posteriormente para desconectarse.

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

El functor del receptor debe tomar un argumento booleano que indique si el estado conectado se volvió activo o inactivo.

Devuelve un "handle" a la conexión, que puede ser utilizado 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 dado desde el estado identificado por scxmlStateName al method en el objeto receiver. El method del receptor puede tomar un argumento booleano que indica si el estado conectado pasó a ser activo o inactivo. Por ejemplo:

void mySlot(bool active);

Devuelve un "handle" a la conexión, que puede utilizarse posteriormente para desconectarse.

QScxmlDataModel *QScxmlStateMachine::dataModel() const

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

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 de QIODevice especificado por data.

Este método siempre devolverá una máquina de estados. Si se producen errores durante la lectura del archivo SCXML, fileName, la máquina de estados no podrá iniciarse. Los errores pueden recuperarse 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 por fileName.

Este método siempre devolverá una máquina de estados. Si se producen errores durante la lectura del archivo SCXML, la máquina de estados no podrá iniciarse. Los errores pueden recuperarse 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 de <data> y ejecutar cualquier etiqueta <script> de la etiqueta <scxml>. Los valores iniciales de los datos se toman 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, false en caso contrario.

[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 estado SCXML. Sólo debe utilizarse internamente y por máquinas de estado compiladas a partir de documentos SCXML.

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

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

Los destinos válidos son

• #_parent para la máquina de estado padre si la máquina de estado actual es iniciada por <invoke>
• #_internal para la máquina de estado actual
• #_scxml_sessioniddonde sessionid es el ID de sesión de la máquina de estado actual
• #_servicename, donde servicename es el ID o nombre de un servicio iniciado con <invoke> por esta máquina de estado

bool QScxmlStateMachine::isRunning() const

Devuelve true si la máquina de estados está funcionando, false en caso contrario.

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 hay atributo expr, se devuelve 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 al functor dado si ese argumento es true. El functor dado no debe aceptar ningún argumento.

Esto es útil para envolver manejadores para connectToState() que sólo deben ejecutarse cuando se entra 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 method dado en receiver usando QMetaObject::invokeMethod() si ese argumento es true y receiver no ha sido borrado, todavía.

El method dado no debe aceptar ningún argumento. method es el nombre plano del método, no encerrado en SIGNAL() o SLOT().

Esto es útil para envolver manejadores para connectToState() que sólo deben ejecutarse cuando se entra 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 al method dado en receiver si ese argumento es true y el receiver no ha sido borrado, todavía. El method dado no debe aceptar ningún argumento.

Esto es útil para envolver manejadores para connectToState() que sólo deben ejecutarse cuando se entra 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 al functor dado si ese argumento es false. El functor dado no debe aceptar ningún argumento.

Esto es útil para envolver manejadores para connectToState() que sólo deben ejecutarse cuando se abandona el 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 method dado en receiver usando QMetaObject::invokeMethod() si ese argumento es false y receiver no ha sido borrado, todavía.

El method dado no debe aceptar ningún argumento. method es el nombre plano del método, no encerrado en SIGNAL(...) o SLOT(...).

Esto es útil para envolver manejadores para connectToState() que sólo deben ejecutarse cuando se abandona el 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 al method dado en receiver si ese argumento es false y el receiver no ha sido borrado, todavía. El method dado no debe aceptar ningún argumento.

Esto es útil para envolver manejadores para connectToState() que sólo deben ejecutarse cuando se deja el 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.

void QScxmlStateMachine::setDataModel(QScxmlDataModel *model)

Establece el modelo de datos para esta máquina de estado en model. Existe una relación 1:1 entre las máquinas de estado y los modelos. Después de establecer el modelo una vez no se puede cambiar más. Cualquier otro intento de establecer el modelo usando este método será ignorado.

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.

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

[slot] void QScxmlStateMachine::start()

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

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

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

Recupera una lista de nombres de estado de todos los estados.

Cuando compress es true (el valor predeterminado), los estados que contienen estados hijos se filtrarán y sólo se devolverán 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.

[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.

Ver 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 envío una vez transcurrido el tiempo de espera. La máquina de estados se apropia de event y lo borra después de procesarlo.

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

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

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

Un método de utilidad para crear y enviar un evento externo con el eventName especificado como nombre y data como datos de carga útil.