Inscoper::RecipeElementEvent¶

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

#include <RecipeElementEvent.h>

Public Functions¶

	Name
	RecipeElementEvent() Default constructor.
	~RecipeElementEvent() Default destructor.
virtual void	fromXML(Inscoper::XMLNode & xml) override Load from XML.
virtual void	toXML(Inscoper::XMLNode & xmlParent) override Save to XML.
virtual Inscoper::ERecipeElementType	getType() override Get the element type.

Detailed Description¶

class Inscoper::RecipeElementEvent;

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 avoid stopping in an undefined state (e.g., with opened shutters).

Public Functions Documentation¶

function RecipeElementEvent¶

RecipeElementEvent()

Default constructor.

Initializes a new instance of the RecipeElementEvent class.

function ~RecipeElementEvent¶

~RecipeElementEvent()

Default destructor.

function fromXML¶

virtual void fromXML(
    Inscoper::XMLNode & xml
) override

Load from XML.

Parameters:

xml : The XML node containing recipe element event

Exceptions:

InscoperException If an error occurs

Reimplements: Inscoper::RecipeElement::fromXML

Populates the recipe element event from an XML node.

function toXML¶

virtual void toXML(
    Inscoper::XMLNode & xmlParent
) override

Save to XML.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurs

Reimplements: Inscoper::RecipeElement::toXML

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

function getType¶

virtual Inscoper::ERecipeElementType getType() override

Get the element type.

Return: The element type (EVENT)

Reimplements: Inscoper::RecipeElement::getType

Retrieves the type of this recipe element (EVENT).

Updated on 2026-04-02 at 10:55:36 +0200