QScxmlInvokableService#

The QScxmlInvokableService class is the base class for services called from state machines. More…

Synopsis#

Properties#

id - ID of the invokable service
name - Of the service being invoked
parentStateMachine - SCXML state machine that invoked the service

Functions#

def parentStateMachine ()

Virtual functions#

def id ()
def name ()
def postEvent (event)
def start ()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

The services are called from state machines via the mechanism described in SCXML Specification - 6.4 <invoke> . This class represents an actual instance of an invoked service.

class PySide6.QtScxml.QScxmlInvokableService(parentStateMachine, parent)#

Parameters:

parentStateMachine – PySide6.QtScxml.QScxmlStateMachine
parent – PySide6.QtScxml.QScxmlInvokableServiceFactory

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtScxml.QScxmlInvokableService.id: str#

This property holds The ID of the invokable service..

The ID is specified by the id attribute of the <invoke> element.

Access functions:

id ()

property PᅟySide6.QtScxml.QScxmlInvokableService.name: str#

This property holds The name of the service being invoked..

Access functions:

name ()

property PᅟySide6.QtScxml.QScxmlInvokableService.parentStateMachine: PySide6.QtScxml.QScxmlStateMachine#

This property holds The SCXML state machine that invoked the service..

Access functions:

parentStateMachine ()

abstract PySide6.QtScxml.QScxmlInvokableService.id()#

Return type:: str

Getter of property id .

abstract PySide6.QtScxml.QScxmlInvokableService.name()#

Return type:: str

Getter of property name .

PySide6.QtScxml.QScxmlInvokableService.parentStateMachine()#

Return type:: PySide6.QtScxml.QScxmlStateMachine

Getter of property parentStateMachine .

abstract PySide6.QtScxml.QScxmlInvokableService.postEvent(event)#

Parameters:: event – PySide6.QtScxml.QScxmlEvent

Sends an event to the service.

abstract PySide6.QtScxml.QScxmlInvokableService.start()#

Return type:: bool

Starts the invokable service. Returns true on success, or false if the invocation fails.