PySide6.QtScxml.QScxmlError

class QScxmlError

The QScxmlError class describes the errors returned by the Qt SCXML state machine when parsing an SCXML file. More

Synopsis

Properties

  • columnᅟ - Number in which the SCXML error occurred

  • descriptionᅟ - A description of the SCXML error

  • fileNameᅟ - Name of the file in which the SCXML error occurred

  • lineᅟ - Number on which the SCXML error occurred

  • validᅟ - Whether the SCXML error is valid

Methods

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

Note

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

property columnᅟ: int

This property holds The column number in which the SCXML error occurred..

Access functions:
property descriptionᅟ: str

This property holds A description of the SCXML error..

Access functions:
property fileNameᅟ: str

This property holds The name of the file in which the SCXML error occurred..

Access functions:
property lineᅟ: int

This property holds The line number on which the SCXML error occurred..

Access functions:
property validᅟ: bool

This property holds Whether the SCXML error is valid..

Access functions:
__init__()

Creates a new invalid SCXML error.

__init__(other)
Parameters:

otherQScxmlError

Constructs a copy of other.

__init__(fileName, line, column, description)
Parameters:
  • fileName – str

  • line – int

  • column – int

  • description – str

Creates a new valid SCXML error that contains the error message, description, as well as the fileName, line, and column where the error occurred.

column()
Return type:

int

Returns the column in which the error occurred.

Getter of property columnᅟ .

description()
Return type:

str

Returns the error message.

Getter of property descriptionᅟ .

fileName()
Return type:

str

Returns the name of the file in which the error occurred.

Getter of property fileNameᅟ .

isValid()
Return type:

bool

Returns true if the error is valid, false otherwise. An invalid error can only be created by calling the default constructor or by assigning an invalid error.

Getter of property validᅟ .

line()
Return type:

int

Returns the line on which the error occurred.

Getter of property lineᅟ .

toString()
Return type:

str

This convenience method converts an error to a string. Returns the error message formatted as: “filename:line:column: error: description”