PySide6.QtScxml.QScxmlCompiler¶

class QScxmlCompiler¶

The QScxmlCompiler class is a compiler for SCXML files. More…

Synopsis¶

Methods¶

def __init__()
def compile()
def errors()
def fileName()
def loader()
def setFileName()
def setLoader()

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¶

Parses an SCXML file and dynamically instantiates a state machine for a successfully parsed SCXML file. If parsing fails, the new state machine cannot start. All errors are returned by parseErrors() .

To load an SCXML file, fromFile or fromData should be used. Using QScxmlCompiler directly is only needed when the compiler needs to use a custom Loader .

__init__(xmlReader)¶

Parameters:: xmlReader – QXmlStreamReader

Creates a new SCXML compiler for the specified reader.

compile()¶

Return type:: QScxmlStateMachine

Parses an SCXML file and creates a new state machine from it.

If parsing is successful, the returned state machine can be initialized and started. If parsing fails, parseErrors() can be used to retrieve a list of errors.

errors()¶

Return type:: .list of QScxmlError

Returns the list of parse errors.

fileName()¶

Return type:: str

Returns the file name associated with the current input.

See also

setFileName()

loader()¶

Return type:: Loader

Returns the loader that is currently used to resolve and load URIs for the SCXML compiler.

See also

setLoader()

setFileName(fileName)¶

Parameters:: fileName – str

Sets the file name for the current input to fileName.

The file name is used for error reporting and for resolving relative path URIs.

See also

fileName()

setLoader(newLoader)¶

Parameters:: newLoader – Loader

Sets newLoader to be used for resolving and loading URIs for the SCXML compiler.

See also

loader()