RecipeElementEvent

Bases: RecipeElement

RecipeElementEvent class represents the check of an event within a recipe.

This recipe element is used to check for user interactions (e.g., stop, pause) during a sequence. It must be placed carefully in the sequence to aNone stopping in an undefined state (e.g., with opened shutters).

__init__()

Default constructor.

Initializes a new instance of the RecipeElementEvent class.

fromXML(xml)

Load from XML.

Populates the recipe element event from an XML node.

Parameters:

Name	Type	Description	Default
xml	XMLNode	The XML node containing recipe element event	required

Raises:

Type	Description
InscoperException	If an error occurs

toXML(xmlParent)

Save to XML.

Exports the recipe element event to an XML node attached to the parent XML node.

Parameters:

Name	Type	Description	Default
xmlParent	XMLNode	The parent XML node	required

Raises:

Type	Description
InscoperException	If an error occurs

getType()

Get the element type.

Retrieves the type of this recipe element (EVENT).

Returns:

Type	Description
int	The element type (EVENT)