Sepasoft MES Module Suite
MESItemRecipe Object
The MESItemRecipe Object is an AbstractMESObject that stores value overrides for an Equipment's default collection of settings within the Settings and Changeover. The MESItemRecipe maintains a single Equipment reference, and represents the Equipment item under an MESRecipe or MESSubRecipe. The overrides are stored in MESRecipeValueComplexPropery entries, each with a name and default-value reference UUID that matches a corresponding Equipment MESRecipeValueDefComplexProperty.
With the get and set methods described below, MESItemRecipes can be managed via script rather than through graphical components. This is especially helpful when recipe-related content is imported from other systems or maintained through a custom graphical interface.
Object Creation
The following functions can be used to create this object.
-
system.recipe.addItemToRecipe
-
system.recipe.createSubProductCode
Object Functions
This object provides the following functions:
getEquipmentRefUUID()
Retrieves the UUID of the Equipment Item this MESItemRecipe represents.
getEquipmentRefUUID()
Nothing
String equipmentUUID - The UUID of the Equipment item.
setEquipmentRefUUID(equipmentRefUUID, changeNote)
Sets the UUID of the Equipment Item to reference.
setEquipmentRefUUID(equipmentRefUUID, changeNote)
String equipmentUUID - The Equipment UUID to set.
String changeNote - A note to accompany this change in the change log. This argument may be omitted.
Nothing
createRecipeValue(defaultValueRefUUID, defaultValueName, value, changeNote)
Creates an MESRecipeValueComplexProperty that is used to override the Equipment's default setpoint value with.
createRecipeValue(defaultValueRefUUID, defaultValueName, value, changeNote)
String defaultValueRefUUID - The UUID of the MESRecipeValueDefComplexProperty to override.
String defaultValueName - The Name of the MESRecipeValueDefComplexProperty.
String value - The value to override the Equipment's setpoint with.
String changeNote - A note to accompany this change in the change log. This argument may be omitted.
The newly created MESRecipeValueComplexProperty.
getRecipeValues()
Retrieves a collection containing all of this MESItemRecipe's setpoint values.
getRecipeValues()
Nothing
A Collection of MESRecipeValueComplexProperty instances.
getRecipeValue(recipeValueName)
Retrieves the MESItemRecipe's setpoint value, if it exists.
getRecipeValue(recipeValueName)
String recipeValueName - The name of the setpoint.
The MESItemRecipe's MESRecipeValueComplexProperty that matches the recipeValueName argument. None, if it does not exist.
setRecipeValue(valueName, value, changeNote)
Assigns the value to the corresponding Recipe Value. If the corresponding MESItemRecipe does not have an MESRecipeValueComplexProperty, one will be created automatically.
setRecipeValue(valueName, value, changeNote)
String valueName - The name of the MESRecipeValueComplexProperty to retrieve from the MESItemRecipe.
String value - The value to assign to the setpoint.
String changeNote - A note to accompany this change in the change log. This argument may be omitted.
Nothing
disableRecipeValue(valueName, changeNote)
Disables the named MESRecipeValueComplexProperty , if it exists.
disableRecipeValue(valueName, changeNote)
String valueName - The name of the MESRecipeValueComplexProperty.
String changeNote - A note to accompany this change in the change log. This argument may be omitted.
Nothing
disableAllRecipeValues(changeNote)
Disables all of this MESItemRecipe's MESRecipeValueComplexProperty entries. The changeNote argument may be omitted.
disableAllRecipeValues(changeNote)
String changeNote - A note to accompany this change in the change log. This argument may be omitted.
An integer representing the amount of disables that occurred.
Sepasoft MES Module Suite