com.inscoper.api.RecipeElementEvent¶

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

Inherits from com.inscoper.api.RecipeElement

Public Functions¶

	Name
synchronized void	delete()
	RecipeElementEvent() Default constructor.
void	fromXML(XMLNode xml) Load from XML.
void	toXML(XMLNode xmlParent) Save to XML.
ERecipeElementType	getType() Get the element type.

Protected Functions¶

	Name
	RecipeElementEvent(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(RecipeElementEvent obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.api.RecipeElement

	Name
int	getRealType()
RecipeElement	createProxy(long cPtr, boolean cMemoryOwn)
RecipeElementSimple	castToRecipeElementSimple(RecipeElement recipeElement)
RecipeElementGroup	castToRecipeElementGroup(RecipeElement recipeElement)
RecipeElementEvent	castToRecipeElementEvent(RecipeElement recipeElement)

Protected Functions inherited from com.inscoper.api.RecipeElement

	Name
	RecipeElement(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.api.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 delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.RecipeElement.delete

function RecipeElementEvent¶

public RecipeElementEvent()

Default constructor.

Initializes a new instance of the RecipeElementEvent class.

function fromXML¶

public void fromXML(
    XMLNode xml
)

Load from XML.

Parameters:

xml : The XML node containing recipe element event

Exceptions:

InscoperException If an error occurs

Reimplements: com.inscoper.api.RecipeElement.fromXML

Populates the recipe element event from an XML node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

Save to XML.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurs

Reimplements: com.inscoper.api.RecipeElement.toXML

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

function getType¶

public ERecipeElementType getType()

Get the element type.

Return: The element type (EVENT)

Reimplements: com.inscoper.api.RecipeElement.getType

Retrieves the type of this recipe element (EVENT).

Protected Functions Documentation¶

function RecipeElementEvent¶

protected RecipeElementEvent(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.RecipeElement.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.RecipeElement.finalize

function getCPtr¶

protected static long getCPtr(
    RecipeElementEvent obj
)

Updated on 2026-09-03 at 12:14:19 +0200