QScxmlEvent

The QScxmlEvent class is an event for a Qt SCXML state machine. More

Inheritance diagram of PySide6.QtScxml.QScxmlEvent

Synopsis

Functions

Detailed Description

SCXML events drive transitions. Most events are generated by using the <raise> and <send> elements in the application. The state machine automatically generates some mandatory events, such as errors.

For more information, see SCXML Specification - 5.10.1 The Internal Structure of Events . For more information about how the Qt SCXML API differs from the specification, see SCXML Compliance .

class PySide6.QtScxml.QScxmlEvent

PySide6.QtScxml.QScxmlEvent(other)

Parameters

otherPySide6.QtScxml.QScxmlEvent

Creates a new external SCXML event.

Constructs a copy of other.

PySide6.QtScxml.QScxmlEvent.EventType

This enum type specifies the type of an SCXML event:

Constant

Description

QScxmlEvent.PlatformEvent

An event generated internally by the state machine. For example, errors.

QScxmlEvent.InternalEvent

An event generated by a <raise> element.

QScxmlEvent.ExternalEvent

An event generated by a <send> element.

PySide6.QtScxml.QScxmlEvent.clear()

Clears the contents of the event.

PySide6.QtScxml.QScxmlEvent.data()
Return type

object

Returns the data included by the sender.

See also

setData()

PySide6.QtScxml.QScxmlEvent.delay()
Return type

int

Returns the delay in milliseconds after which this event is to be delivered after processing the <send> element.

See also

setDelay()

PySide6.QtScxml.QScxmlEvent.errorMessage()
Return type

str

If this is an error event, returns the error message. Otherwise, returns an empty QString .

PySide6.QtScxml.QScxmlEvent.eventType()
Return type

EventType

Returns the type of this event.

See also

setEventType() EventType

PySide6.QtScxml.QScxmlEvent.invokeId()
Return type

str

If this event is generated by an invoked state machine, returns the ID of the <invoke> element. Otherwise, returns an empty value.

See also

setInvokeId()

PySide6.QtScxml.QScxmlEvent.isErrorEvent()
Return type

bool

Returns true when this is an error event, false otherwise.

PySide6.QtScxml.QScxmlEvent.name()
Return type

str

Returns the name of the event.

See also

setName()

PySide6.QtScxml.QScxmlEvent.origin()
Return type

str

Returns a URI that points to the origin of an SCXML event.

See also

setOrigin()

PySide6.QtScxml.QScxmlEvent.originType()
Return type

str

Returns the origin type of an SCXML event.

See also

setOriginType()

PySide6.QtScxml.QScxmlEvent.scxmlType()
Return type

str

Returns the event type.

PySide6.QtScxml.QScxmlEvent.sendId()
Return type

str

Returns the ID of the event.

See also

setSendId()

PySide6.QtScxml.QScxmlEvent.setData(data)
Parameters

data – object

Sets the payload data to data.

See also

data

PySide6.QtScxml.QScxmlEvent.setDelay(delayInMiliSecs)
Parameters

delayInMiliSecs – int

Sets the delay in milliseconds as the value of delayInMiliSecs.

See also

delay

PySide6.QtScxml.QScxmlEvent.setErrorMessage(message)
Parameters

message – str

If this is an error event, the message is set as the error message.

See also

errorMessage()

PySide6.QtScxml.QScxmlEvent.setEventType(type)
Parameters

typeEventType

Sets the event type to type.

See also

eventType EventType

PySide6.QtScxml.QScxmlEvent.setInvokeId(invokeId)
Parameters

invokeId – str

Sets the ID of an invoked state machine to invokeid.

See also

invokeId

PySide6.QtScxml.QScxmlEvent.setName(name)
Parameters

name – str

Sets the name of the event to name.

See also

name()

PySide6.QtScxml.QScxmlEvent.setOrigin(origin)
Parameters

origin – str

Sets the origin of an SCXML event to origin.

See also

origin

PySide6.QtScxml.QScxmlEvent.setOriginType(originType)
Parameters

originType – str

Sets the origin type of an SCXML event to origintype.

See also

originType

PySide6.QtScxml.QScxmlEvent.setSendId(sendId)
Parameters

sendId – str

Sets the ID sendid for this event.

See also

sendId()