AbstractMESRecipe

Returns the recipe type for the current recipe.

getRecipeType()

• Parameters

Nothing

• Returns

RecipeType recipeType - The Enum type for the current Recipe Type.

Assigns an Equipment Path to the MESItemRecipe.

addItemRecipePath(equipmentPath, changeNote)

• Parameters

String  equipmentPath - The Production Item's path to generate an Item Recipe for.

String changeNote - A note to accompany this change in the change log. This argument may be omitted.

• Returns

MESItemRecipe - The MESItemRecipe that has been added, or the MESItemRecipe that already existed.

Adds an Equipment UUID to the MESItemRecipe.

addItemRecipeUUID(equipmentUUID, changeNote)

• Parameters

String  equipmentUUID - The Production Item's UUID to generate an Item Recipe for.

String changeNote - A note to accompany this change in the change log. This argument may be omitted.

• Returns

MESItemRecipe - The MESItemRecipe that has been added, or the MESItemRecipe that already existed.

Adds an Equipment to the MESItemRecipe.

addItemRecipe(equipment, changeNote)

• Parameters

AbstractMESEquipment equipment - The Production Item to generate an Item Recipe for.

String changeNote - A note to accompany this change in the change log. This argument may be omitted.

• Returns

MESItemRecipe - The MESItemRecipe that has been added, or the MESItemRecipe that already existed.

Fetches the MESItemRecipe object for this Recipe.

getItemRecipeByPath(equipmentPath)

• Parameters

String  equipmentPath - The Production Item's path to get an Item Recipe for.

• Returns

The MESItemRecipe that matches the equipment, or None if it does not exist.

Fetches the MESItemRecipe object for this Recipe.

getItemRecipeByUUID(equipmentUUID)

• Parameters

String  equipmentUUID - The Production Item's UUID to get an Item Recipe for.

• Returns

The MESItemRecipe that matches the equipment, or None if it does not exist.

Fetches the MESItemRecipe object for this Recipe.

getItemRecipe(equipment)

• Parameters

AbstractMESEquipment equipment - The Production Item to get an Item Recipe for.

• Returns

The MESItemRecipe that matches the equipment, or None if it does not exist.

Assigns the value to the corresponding Recipe Value. If the corresponding MESItemRecipe does not have an MESRecipeValueComplexProperty, one will be created automatically.

setItemRecipeValueByPath(equipmentPath, valueName, value, changeNote)

• Parameters

String  equipmentPath - The Production Item's path to get an Item Recipe for.

String valueName - The name of the MESRecipeValueComplexProperty (the setpoint) to retrieve from the MESItemRecipe.

Object 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.

• Returns

The MESItemRecipe that was targeted.

Assigns the value to the corresponding Recipe Value. If the corresponding MESItemRecipe does not have an MESRecipeValueComplexProperty, one will be created automatically.

setItemRecipeValueByUUID(equipmentUUID, valueName, value, changeNote)

• Parameters

String  equipmentUUID - The Production Item's UUID to get an Item Recipe for.

String valueName - The name of the MESRecipeValueComplexProperty (the setpoint) to retrieve from the MESItemRecipe.

Object 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.

• Returns

The MESItemRecipe that was targeted.

Assigns the value to the corresponding Recipe Value. If the corresponding MESItemRecipe does not have an MESRecipeValueComplexProperty, one will be created automatically.

setItemRecipeValue(equipment, valueName, value, changeNote)

• Parameters

AbstractMESEquipment equipment - The Production Item to get an Item Recipe for.

String valueName - The name of the MESRecipeValueComplexProperty (the setpoint) to retrieve from the MESItemRecipe.

Object 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.

• Returns

The MESItemRecipe that was targeted.

Assigns multiple values to the corresponding Recipe Value. If the corresponding MESItemRecipe does not have a MESRecipeValueComplexProperty that corresponds to a value's name, one will be created automatically.

setItemRecipeValuesByPath(equipmentPath, namesAndValues, changeNote)

• Parameters

String  equipmentPath - The Production Item's path to retrieve an Item Recipe for.

PyDictionary namesAndValues - The names of the MESRecipeValueComplexProperty objects to retrieve from the MESItemRecipe, mapped to PyObject values.

String changeNote - A note to accompany this change in the change log. This argument may be omitted.

• Returns

The MESItemRecipe that was targeted.

Assigns multiple values to the corresponding Recipe Value. If the corresponding MESItemRecipe does not have a MESRecipeValueComplexProperty that corresponds to a value's name, one will be created automatically.

setItemRecipeValuesByUUID(equipmentUUID, namesAndValues, changeNote)

• Parameters

String  equipmentUUID - The Production Item's UUID to retrieve an Item Recipe for.

PyDictionary namesAndValues - The names of the MESRecipeValueComplexProperty objects to retrieve from the MESItemRecipe, mapped to PyObject values.

String changeNote - A note to accompany this change in the change log. This argument may be omitted.

• Returns

The MESItemRecipe that was targeted.

Assigns multiple values to the corresponding Recipe Value. If the corresponding MESItemRecipe does not have a MESRecipeValueComplexProperty that corresponds to a value's name, one will be created automatically.

setItemRecipeValue(equipment, namesAndValues, changeNote)

• Parameters

AbstractMESEquipment equipment - The Production Item to retrieve an Item Recipe for.

PyDictionary namesAndValues - The names of the MESRecipeValueComplexProperty objects to retrieve from the MESItemRecipe, mapped to PyObject values.

String changeNote - A note to accompany this change in the change log. This argument may be omitted.

• Returns

The MESItemRecipe that was targeted.