Sepasoft MES Module Suite
Machine Recipe Item Info Object
The Recipe Item Info object stores information about the recipe items. Relevant information at the equipment item level is represented in this object. Most users need the obj.getRecipeValues() method to access the Item Recipe Value object, which has value related metadata (e.g. min/max values, data type, etc.).
With the get and set methods described below, recipe items can be managed via script rather than the graphical components. This is especially helpful when recipes are imported from other systems or maintained through a custom graphical interface.
Properties
getItemPath()
Description
Returns the path of recipe value.
Syntax
getItemPath()
- Parameters
None
- Returns
String path - The item path to a production line, cell, cell group or location corresponding to the recipe value.
getItemPathFilter()
Description
Returns the path filter for the recipe production item.
Syntax
getItemPathFilter()
- Parameters
None
- Returns
String pathFilter - Path filter for the recipe production item.
getRecipe()
Description
Get the recipe object.
Syntax
getRecipe()
- Parameters
None
- Returns
String recipe - The recipe object.
getRecipeFilter()
Description
Get the recipe filter.
Syntax
getRecipeFilter()
- Parameters
None
- Returns
String recipeFilter - The recipe filter.
getRecipeGroup()
Description
Returns the name of recipe group.
Syntax
getRecipeGroup()
- Parameters
None
- Returns
String recipeGroup - Name of the recipe group.
getRecipeState()
Description
Returns the recipe state.
Syntax
getRecipeState()
- Parameters
None
- Returns
String recipeState - The recipe state.
getRecipeValue(recipeValueItemName)
Description
Returns the recipe value
Syntax
getRecipeValue(recipeValueItemName)
- Parameters
String recipeValueItemName - The name of the recipe value item. In the Equipment configuration, this is the name of the item associated with a tag to connect the recipe set point to the PLC through the Ignition Tag Server.
- Returns
ItemRecipeValue recipeValue - The value of recipe.
getSubRecipe()
Description
Gets the sub recipe.
Syntax
getSubRecipe()
- Parameters
None
- Returns
String subRecipe - The sub recipe.
isDefaultSubRecipe()
Description
Checks whether it is the default sub recipe.
Syntax
isDefaultSubRecipe()
- Parameters
None
- Returns
boolean defaultSubRecipe - True if it is the sub recipe and False otherwise.
setItemPath(itemPath)
Description
Sets the path of recipe production item.
Syntax
setItemPath(itemPath)
- Parameters
String itemPath - The item path to a production line, cell, cell group or location corresponding to the recipe value.
- Returns
Nothing
setItemPathFilter(itemPathFilter)
Description
Sets the path filter for the recipe production item.
Syntax
setItemPathFilter(itemPathFilter)
- Parameters
String itemPathFilter - Path filter for the recipe production item.
- Returns
Nothing
setRecipe(recipe)
Description
Set the recipe object.
Syntax
setRecipe(recipe)
- Parameters
String recipe - The recipe object.
- Returns
Nothing
setRecipeFilter(recipeFilter)
Description
Set the recipe filter.
Syntax
setRecipeFilter(recipeFilter)
- Parameters
String recipeFilter - The recipe filter.
- Returns
Nothing
Sepasoft MES Module Suite