com.inscoper.api.Recipe¶

Recipe class represents the protocol to create a sequence of operations. More...

Public Functions¶

	Name
synchronized void	delete()
	Recipe() Default constructor.
	Recipe(String name) Constructor with name.
void	fromXML(XMLNode xml) Load from XML.
void	toXML(XMLNode xmlParent) Save to XML.
String	getName() Get the recipe name.
void	setName(String name) Set the recipe name.
RecipeElementVector	getRecipeElements() Get recipe elements.
void	setRecipeElementList(RecipeElementVector recipeElements) Set recipe elements.
void	addRecipeElement(RecipeElement recipeElement) Add a recipe element.

Protected Functions¶

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

Detailed Description¶

public class com.inscoper.api.Recipe;

Recipe class represents the protocol to create a sequence of operations.

A Recipe defines an ordered list of recipe elements that controls the creation of a sequence of operations.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function Recipe¶

public Recipe()

Default constructor.

Initializes a new instance of the Recipe class.

function Recipe¶

public Recipe(
    String name
)

Constructor with name.

Parameters:

name : The name of the recipe

Initializes a new instance of the Recipe class with a specified name.

function fromXML¶

public void fromXML(
    XMLNode xml
)

Load from XML.

Parameters:

xml : The XML node containing recipe information

Exceptions:

InscoperException If an error occurs

Populates the recipe information 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

Exports the recipe information to an XML node attached to the parent node.

function getName¶

public String getName()

Get the recipe name.

Return: The name of the recipe

Retrieves the name of the recipe.

function setName¶

public void setName(
    String name
)

Set the recipe name.

Parameters:

name : The name of the recipe

Sets the name of the recipe.

function getRecipeElements¶

public RecipeElementVector getRecipeElements()

Get recipe elements.

Return: The list of recipe elements

Retrieves the list of elements that compose the recipe.

function setRecipeElementList¶

public void setRecipeElementList(
    RecipeElementVector recipeElements
)

Set recipe elements.

Parameters:

recipeElements : The list of recipe elements

Replaces the current list of recipe elements.

function addRecipeElement¶

public void addRecipeElement(
    RecipeElement recipeElement
)

Add a recipe element.

Parameters:

recipeElement : The recipe element to add

Appends a recipe element at the end of the recipe's list.

Protected Functions Documentation¶

function Recipe¶

protected Recipe(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    Recipe obj
)

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