QScxmlStateMachine Class

Dokumentation der Mitgliedsfunktionen

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

Ruft eine Liste der Namen aller aktiven Zustände ab.

Wenn ein Zustand aktiv ist, sind per Definition auch alle seine übergeordneten Zustände aktiv. Wenn ` compress ` auf ` true ` gesetzt ist (Standardeinstellung), werden die übergeordneten Zustände herausgefiltert und nur die Endzustände zurückgegeben. Wenn der Wert ` false` lautet, wird die vollständige Liste der aktiven Zustände zurückgegeben.

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

Bricht ein verzögertes Ereignis mit dem angegebenen „ sendId “ ab.

Erstellt eine Verbindung der angegebenen ` type ` vom durch ` scxmlEventSpec ` spezifizierten Ereignis zu ` functor`, wobei es sich um einen Funktor oder eine Mitgliedsfunktion des optionalen Objekts ` context ` handeln kann.

Der „ functor “ des Empfängers muss ein „ QScxmlEvent “ als Parameter annehmen.

Im Gegensatz zu Ereignisspezifikationen in SCXML-Dokumenten sind Leerzeichen im „ scxmlEventSpec “ hier nicht zulässig. Um eine Verbindung zu mehreren Ereignissen mit unterschiedlichen Präfixen herzustellen, muss „ connectToEvent()“ mehrfach aufgerufen werden.

Gibt ein Handle für die Verbindung zurück, das später zum Trennen der Verbindung verwendet werden kann.

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

Erstellt eine Verbindung des angegebenen ` type ` vom durch ` scxmlEventSpec ` angegebenen Ereignis zum ` method ` im Objekt ` receiver `. Die Methode ` method ` des Empfängers kann einen ` QScxmlEvent ` als Parameter entgegennehmen. Beispiel:

void mySlot(const QScxmlEvent &event);

Im Gegensatz zu Ereignisspezifikationen in SCXML-Dokumenten sind Leerzeichen im „ scxmlEventSpec “ hier nicht zulässig. Um eine Verbindung zu mehreren Ereignissen mit unterschiedlichen Präfixen herzustellen, muss connectToEvent() mehrmals aufgerufen werden.

Gibt ein Handle für die Verbindung zurück, das später zum Trennen der Verbindung verwendet werden kann.

Erstellt eine Verbindung des angegebenen type vom durch scxmlStateName festgelegten Zustand zu functor, wobei es sich um einen Funktor oder eine Mitgliedsfunktion des optionalen context -Objekts handeln kann.

Der „ functor “ des Empfängers muss ein boolesches Argument annehmen, das angibt, ob der verbundene Zustand aktiv oder inaktiv wurde.

Gibt ein Handle für die Verbindung zurück, das später zum Trennen der Verbindung verwendet werden kann.

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

Erstellt eine Verbindung der angegebenen „ type “ vom durch „ scxmlStateName “ identifizierten Zustand zum „ method “ im Objekt „ receiver “. Die Methode „ method “ des Empfängers kann ein boolesches Argument entgegennehmen, das angibt, ob der verbundene Zustand aktiv oder inaktiv geworden ist. Beispiel:

void mySlot(bool active);

Gibt ein Handle für die Verbindung zurück, das später zum Trennen der Verbindung verwendet werden kann.

QScxmlDataModel *QScxmlStateMachine::dataModel() const

Gibt das von der Zustandsmaschine verwendete Datenmodell zurück.

Siehe auch „ setDataModel()“.

[signal] void QScxmlStateMachine::finished()

Dieses Signal wird ausgesendet, wenn die Zustandsmaschine einen Endzustand der obersten Ebene erreicht.

Siehe auch „ running “.

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

Erstellt eine Zustandsmaschine, indem aus der unter data angegebenen SCXML-Datei ( QIODevice ) gelesen wird.

Diese Methode gibt immer eine Zustandsmaschine zurück. Treten beim Einlesen der SCXML-Datei ` fileName` Fehler auf, kann die Zustandsmaschine nicht gestartet werden. Die Fehler können durch Aufruf der Methode ` parseErrors()` abgerufen werden.

Siehe auch parseErrors().

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

Erstellt eine Zustandsmaschine aus der SCXML-Datei, die mit „ fileName “ angegeben wurde.

Diese Methode gibt immer eine Zustandsmaschine zurück. Wenn beim Einlesen der SCXML-Datei Fehler auftreten, kann die Zustandsmaschine nicht gestartet werden. Die Fehler können durch Aufruf der Methode ` parseErrors()` abgerufen werden.

Siehe auch ` parseErrors()`.

[slot] bool QScxmlStateMachine::init()

Initialisiert die Zustandsmaschine.

Die Initialisierung der Zustandsmaschine umfasst den Aufruf von ` QScxmlDataModel::setup()`, das Festlegen der Anfangswerte für die Elemente von ` <data> ` sowie das Ausführen aller ` <script> `-Tags des ` <scxml> `-Tags. Die Anfangswerte der Daten werden aus der Eigenschaft ` initialValues ` übernommen.

Gibt „ false “ zurück, wenn Parsing-Fehler auftreten oder einer der Initialisierungsschritte fehlschlägt. Andernfalls wird „ true “ zurückgegeben.

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

Gibt „ true “ zurück, wenn der durch „ scxmlStateName “ angegebene Zustand aktiv ist, andernfalls „ false “.

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

Gibt „ true “ zurück, wenn der Zustand mit der ID „ stateIndex “ aktiv ist.

Diese Methode ist Teil der Schnittstelle zur kompilierten Darstellung von SCXML-Zustandsmaschinen. Sie sollte nur intern und von aus SCXML-Dokumenten kompilierten Zustandsmaschinen verwendet werden.

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

Gibt „ true “ zurück, wenn eine Nachricht an „ target “ von dieser Zustandsmaschine versendet werden kann.

Gültige Ziele sind:

• #_parent die übergeordnete Zustandsmaschine, wenn die aktuelle Zustandsmaschine durch <invoke>
• #_internal für die aktuelle Zustandsmaschine
• #_scxml_sessionid, wobei ` sessionid ` die Sitzungs-ID der aktuellen Zustandsmaschine ist
• #_servicename, wobei ` servicename ` die ID oder der Name eines Dienstes ist, der von dieser Zustandsmaschine mit ` <invoke> ` gestartet wurde

bool QScxmlStateMachine::isRunning() const

Gibt „ true “ zurück, wenn die Zustandsmaschine läuft, andernfalls „ false “.

Siehe auch „ setRunning()“ und „ runningChanged()“.

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

Dieses Signal wird ausgelöst, wenn im SCXML ein <log> -Tag verwendet wird. „ label “ ist der Wert des Attributs „label“ des <log> -Tags. „ msg “ ist der Wert des ausgewerteten Attributs „expr“ des <log> -Tags. Ist kein „expr“-Attribut vorhanden, wird eine leere Zeichenkette zurückgegeben.

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

Gibt einen Funktor zurück, der ein boolesches Argument entgegennimmt und den angegebenen ` functor ` aufruft, wenn dieses Argument ` true` ist. Der angegebene ` functor ` darf keine Argumente entgegennehmen.

Dies ist nützlich, um Handler für ` connectToState()` zu umschließen, die nur ausgeführt werden sollen, wenn der Zustand erreicht wird.

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

Gibt einen Funktor zurück, der ein boolesches Argument akzeptiert und die angegebene Methode ` method ` auf ` receiver ` mithilfe von ` QMetaObject::invokeMethod()` aufruft, sofern dieses Argument ` true ` ist und ` receiver ` noch nicht gelöscht wurde.

Die angegebene Funktion „ method “ darf keine Argumente akzeptieren. „ method “ ist der reine Methodenname, ohne die Umschreibungsfunktionen „ SIGNAL() “ oder „ SLOT() “.

Dies ist nützlich, um Handler für ` connectToState()` zu umschließen, die nur ausgeführt werden sollen, wenn der Zustand erreicht wird.

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

Gibt einen Funktor zurück, der ein boolesches Argument entgegennimmt und die angegebene Funktion ` method ` auf ` receiver ` aufruft, sofern dieses Argument ` true ` ist und die Funktion ` receiver ` noch nicht gelöscht wurde. Die angegebene Funktion ` method ` darf keine Argumente entgegennehmen.

Dies ist nützlich, um Handler für ` connectToState()` zu umschließen, die nur ausgeführt werden sollen, wenn der Zustand erreicht wird.

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

Gibt einen Funktor zurück, der ein boolesches Argument akzeptiert und den angegebenen functor aufruft, wenn dieses Argument den Wert „ false “ hat. Der angegebene functor darf keine Argumente akzeptieren.

Dies ist nützlich, um Handler für ` connectToState()` zu verpacken, die nur ausgeführt werden sollen, wenn der Zustand verlassen wird.

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

Gibt einen Funktor zurück, der ein boolesches Argument akzeptiert und die angegebene Methode ` method ` auf ` receiver ` mithilfe von ` QMetaObject::invokeMethod()` aufruft, sofern dieses Argument ` false ` ist und ` receiver ` noch nicht gelöscht wurde.

Die angegebene Funktion ` method ` darf keine Argumente akzeptieren. ` method ` ist der reine Methodenname, nicht in `SIGNAL(...)` oder `SLOT(...)` eingeschlossen.

Dies ist nützlich, um Handler für connectToState() zu umschließen, die nur ausgeführt werden sollen, wenn der Zustand verlassen wird.

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

Gibt einen Funktor zurück, der ein boolesches Argument akzeptiert und die angegebene Funktion „ method “ auf „ receiver “ aufruft, sofern dieses Argument „ false “ ist und die Funktion „ receiver “ noch nicht gelöscht wurde. Die angegebene Funktion „ method “ darf keine Argumente akzeptieren.

Dies ist nützlich, um Handler für ` connectToState()` zu umschließen, die nur ausgeführt werden sollen, wenn der Zustand verlassen wird.

[signal] void QScxmlStateMachine::reachedStableState()

Dieses Signal wird ausgegeben, wenn die Ereigniswarteschlange am Ende eines Makroschritts leer ist oder wenn ein Endzustand erreicht wurde.

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

Dieses Signal wird ausgelöst, wenn die Eigenschaft „ running “ mit dem Argument „ running “ geändert wird.

void QScxmlStateMachine::setDataModel(QScxmlDataModel *model)

Legt das Datenmodell für diese Zustandsmaschine auf „ model “ fest. Zwischen Zustandsmaschinen und Modellen besteht eine 1:1-Beziehung. Nachdem das Modell einmal festgelegt wurde, kann es nicht mehr geändert werden. Alle weiteren Versuche, das Modell mit dieser Methode festzulegen, werden ignoriert.

Siehe auch „ dataModel()“.

void QScxmlStateMachine::setRunning(bool running)

Startet die Zustandsmaschine, wenn „ running “ den Wert „ true “ hat, oder stoppt sie andernfalls.

Siehe auch „ start()“, „ stop()“, „ isRunning()“ und „ runningChanged()“.

[slot] void QScxmlStateMachine::start()

Startet diese Zustandsmaschine. Wenn ein endgültiger Zustand der obersten Ebene erreicht wird, sendet die Maschine das Signal „ finished()“ aus.

Siehe auch runningChanged(), setRunning(), stop() und finished().

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

Ruft eine Liste der Namen aller Bundesstaaten ab.

Wenn „ compress “ auf „ true “ gesetzt ist (Standard), werden Zustände, die untergeordnete Zustände enthalten, herausgefiltert und nur die Blattzustände zurückgegeben. Bei der Einstellung „ false “ wird die vollständige Liste aller Zustände zurückgegeben.

Die zurückgegebene Liste enthält keine Zustände von möglicherweise verschachtelten Zustandsmaschinen.

[slot] void QScxmlStateMachine::stop()

Hält diese Zustandsmaschine an. Die Maschine führt keine weiteren Zustandsübergänge mehr aus. Ihre Eigenschaft „ running “ wird auf „ false “ gesetzt.

Siehe auch „ runningChanged()“, „ start()“ und „ setRunning()“.

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

Übermittelt das SCXML-Ereignis „ event “ je nach Priorität des Ereignisses an die interne oder externe Ereigniswarteschlange.

Wenn eine Verzögerung festgelegt ist, wird das Ereignis zur Übermittlung in die Warteschlange gestellt, sobald die Zeitüberschreitung abgelaufen ist. Die Zustandsmaschine übernimmt die Verantwortung für „ event “ und löscht es nach der Verarbeitung.

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

Eine Hilfsmethode zum Erstellen und Senden eines externen Ereignisses mit dem angegebenen „ eventName “ als Namen.

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

Eine Hilfsfunktion zum Erstellen und Senden eines externen Ereignisses mit dem angegebenen „ eventName “ als Namen und „ data “ als Nutzdaten.