com.inscoper.api.RecipeElementSimple¶

RecipeElementSimple class represents a basic recipe step with actions and conditions. More...

Inherits from com.inscoper.api.RecipeElement

Public Functions¶

	Name
synchronized void	delete()
	RecipeElementSimple() Default constructor.
void	fromXML(XMLNode xml) Load from XML.
void	toXML(XMLNode xmlParent) Save to XML.
ERecipeElementType	getType() Get the element type.
String	getDescription() Get the description.
void	setDescription(String description) Set the description.
SubDeviceId	getSubDeviceId() Get the sub-device ID.
void	setSubDeviceId(SubDeviceId subDeviceId) Set the sub-device ID.
String	getRecipeId() Get the recipe ID.
void	setRecipeId(String recipeId) Set the recipe ID.
EFunctionType	getFunction() Get the function type.
void	setFunction(EFunctionType function) Set the function type.
String	getValue() Get the value.
void	setValue(String value) Set the value.
boolean	getImage() Check if this element will generate an image.
void	setImage(boolean image) Set the image generation flag.
ValueConditionVector	getValueConditionList() Get value conditions.
void	setValueConditionList(ValueConditionVector valueConditionList) Set value conditions.
void	addValueCondition(ValueCondition valueCondition) Add a value condition.
String	getTagCondition() Get the tag condition.
void	setTagCondition(String tagCondition) Set the tag condition.
boolean	getOptimisation() Check the optimization flag.
void	setOptimisation(boolean optimisation) Set the optimization flag.
boolean	hasValueCondition() Check for value conditions.
String	getCallId() Get the call ID.
void	setCallId(String callId) Set the call ID.
void	addOnCallSubRecipes(RecipeElementSimpleVector elems) Add recipe elements to notify on call.
void	addOnCallSubRecipe(RecipeElementSimple elem) Add a recipe element to notify on call.
StringVector	getDependencies() Get the list of recipe element call IDs that will, when called, notify this recipe element.
void	setRecipeCalled(String id) Set the recipe element as called.
String	getRecipeCallCondition() Get recipe call condition.
void	setRecipeCallCondition(String recipeCallCondition) Set recipe call condition.
StringBoolMap	getRecipeCallState() Get recipe call states.
RecipeElementSimpleVector	getRecipeCallSubRecipes() Get the recipe elements to notify when this element is called.

Protected Functions¶

	Name
	RecipeElementSimple(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(RecipeElementSimple 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.RecipeElementSimple;

RecipeElementSimple class represents a basic recipe step with actions and conditions.

Note: This class is non-copyable and non-movable.

This is the main recipe element type, supporting actions on sub-devices, conditional execution based on tags or values, and optimization settings.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.RecipeElement.delete

function RecipeElementSimple¶

public RecipeElementSimple()

Default constructor.

Initializes a new instance of the RecipeElementSimple class.

function fromXML¶

public void fromXML(
    XMLNode xml
)

Load from XML.

Parameters:

xml : The XML node containing the simple recipe element

Exceptions:

InscoperException If an error occurs

Reimplements: com.inscoper.api.RecipeElement.fromXML

Populates the simple recipe element 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 simple recipe element to an XML node attached to the parent XML node.

function getType¶

public ERecipeElementType getType()

Get the element type.

Return: The type (SIMPLE)

Reimplements: com.inscoper.api.RecipeElement.getType

Retrieves the type of this recipe element.

function getDescription¶

public String getDescription()

Get the description.

Return: The description

Retrieves the description of the recipe element.

function setDescription¶

public void setDescription(
    String description
)

Set the description.

Parameters:

description : The description

Sets the description of the recipe element.

function getSubDeviceId¶

public SubDeviceId getSubDeviceId()

Get the sub-device ID.

Return: The sub-device ID

Retrieves the ID of the sub-device associated with this element.

function setSubDeviceId¶

public void setSubDeviceId(
    SubDeviceId subDeviceId
)

Set the sub-device ID.

Parameters:

subDeviceId : The sub-device ID

Sets the ID of the sub-device associated with this element.

function getRecipeId¶

public String getRecipeId()

Get the recipe ID.

Return: The recipe ID

Retrieves the identifier of the recipe element.

function setRecipeId¶

public void setRecipeId(
    String recipeId
)

Set the recipe ID.

Parameters:

recipeId : The recipe ID

Sets the identifier of the recipe element.

function getFunction¶

public EFunctionType getFunction()

Get the function type.

Return: The function type

Retrieves the function type to be executed on the sub-device.

function setFunction¶

public void setFunction(
    EFunctionType function
)

Set the function type.

Parameters:

function : The function type

Sets the function type to be executed on the sub-device.

function getValue¶

public String getValue()

Get the value.

Return: The value

Retrieves the parameter value associated with the function call.

function setValue¶

public void setValue(
    String value
)

Set the value.

Parameters:

value : The value

Sets the parameter value associated with the function call.

function getImage¶

public boolean getImage()

Check if this element will generate an image.

Return: True if an image will be generated, false otherwise

Determines if the function to be called by the element generates an image.

function setImage¶

public void setImage(
    boolean image
)

Set the image generation flag.

Parameters:

image : True if an image will be generated, false otherwise

Sets whether the function to be called will generate an image.

function getValueConditionList¶

public ValueConditionVector getValueConditionList()

Get value conditions.

Return: The list of value conditions

Retrieves the list of value conditions that must be met for this element to execute.

function setValueConditionList¶

public void setValueConditionList(
    ValueConditionVector valueConditionList
)

Set value conditions.

Parameters:

valueConditionList : The list of value conditions

Sets the list of value conditions that must be met for this element to execute.

function addValueCondition¶

public void addValueCondition(
    ValueCondition valueCondition
)

Add a value condition.

Parameters:

valueCondition : The value condition to add

Adds a value condition to the list.

function getTagCondition¶

public String getTagCondition()

Get the tag condition.

Return: The tag condition

Retrieves the tag condition required for execution.

function setTagCondition¶

public void setTagCondition(
    String tagCondition
)

Set the tag condition.

Parameters:

tagCondition : The tag condition

Sets the tag condition required for execution.

function getOptimisation¶

public boolean getOptimisation()

Check the optimization flag.

Return: True if optimization is enabled, false otherwise

Determines if optimization is enabled for this element.

function setOptimisation¶

public void setOptimisation(
    boolean optimisation
)

Set the optimization flag.

Parameters:

optimisation : True to enable optimization, false to disable

Enables or disables optimization for this element.

function hasValueCondition¶

public boolean hasValueCondition()

Check for value conditions.

Return: True if value conditions exist, false otherwise

Returns whether there are value conditions associated with this recipe element.

function getCallId¶

public String getCallId()

Get the call ID.

Return: The call ID

Retrieves the call ID associated with this element.

function setCallId¶

public void setCallId(
    String callId
)

Set the call ID.

Parameters:

callId : The call ID

Sets the call ID associated with this element.

function addOnCallSubRecipes¶

public void addOnCallSubRecipes(
    RecipeElementSimpleVector elems
)

Add recipe elements to notify on call.

Parameters:

elems : The list of recipe elements to add

Adds a list of simple recipe elements to notify when this recipe element is called.

function addOnCallSubRecipe¶

public void addOnCallSubRecipe(
    RecipeElementSimple elem
)

Add a recipe element to notify on call.

Parameters:

elem : The recipe element to add

Adds a simple recipe element to notify when this recipe element is called.

function getDependencies¶

public StringVector getDependencies()

Get the list of recipe element call IDs that will, when called, notify this recipe element.

Return: The list of recipe element call IDs

Retrieves the list of recipe element call IDs that will, when called, notify this recipe element.

function setRecipeCalled¶

public void setRecipeCalled(
    String id
)

Set the recipe element as called.

Parameters:

id : The call ID of the recipe element

Marks the recipe associated to the call ID as called.

function getRecipeCallCondition¶

public String getRecipeCallCondition()

Get recipe call condition.

Return: The recipe call condition

Retrieves the call condition of the recipe.

function setRecipeCallCondition¶

public void setRecipeCallCondition(
    String recipeCallCondition
)

Set recipe call condition.

Parameters:

recipeCallCondition : The recipe call condition

Sets the call condition of the recipe.

function getRecipeCallState¶

public StringBoolMap getRecipeCallState()

Get recipe call states.

Return: A map pairing the call ID with the execution state

Retrieves the states of recipe calls.

function getRecipeCallSubRecipes¶

public RecipeElementSimpleVector getRecipeCallSubRecipes()

Get the recipe elements to notify when this element is called.

Return: The list of recipe elements

Retrieves the list of recipe elements to notify when this element is called.

Protected Functions Documentation¶

function RecipeElementSimple¶

protected RecipeElementSimple(
    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(
    RecipeElementSimple obj
)

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