MESRecipe

Sepasoft MES Module Suite

MESRecipe Object

The MESRecipe Object is an AbstractMESRecipe object that stores information about a Master or Descendant recipe, or collection of settings within the Settings and Changeover.  

MESRecipes are children of the MESRecipeRoot object. If an MESRecipe is created and saved without a parent, it will automatically be assigned to the MESRecipeRoot object.

With the get and set methods described below, recipes can be managed via script rather than through graphical components.  This is especially helpful when recipes are imported from other systems or maintained through a custom graphical interface.

Inherits from AbstractMESObject.

Object Creation

The following function can be used to create this object.



Object Properties

This object inherits the AbstractMESObject properties...


Object Functions

This object provides the following functions:

 getGroup()

Description

Returns the Group Name (a meta-data string) for the current recipe. The Group Name is an arbitrary name used for MESRecipe sorting and organizational purposes.

Syntax

getGroup()

  • Parameters

Nothing

  • Returns

String recipeGroupName - The Group Name (a meta-data string) for the current recipe.

 setGroup(groupName, changeNote)

Description

Sets the Group Name (a meta-data string) for the current recipe.

Syntax

setGroup(groupName, changeNote)

  • Parameters

String groupName - The Group Name (a meta-data string) for the current recipe. The Group Name is an arbitrary name used for MESRecipe sorting and organizational purposes.

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

  • Returns

Nothing

 

getState()

Description

Returns the State Name (a meta-data string) for the current recipe. The State Name is an arbitrary name used for MESRecipe sorting and organizational purposes.

Syntax

getState()

  • Parameters

Nothing

  • Returns

String recipeStateName - The state name (a meta-data string) for the current recipe.

 

setState(state, changeNote)

Description

Sets the State Name (a meta-data string) for the current recipe. The State Name is an arbitrary name used for MESRecipe sorting and organizational purposes.

Syntax

setState(state, changeNote)

  • Parameters

String state - An arbitrary State name (a meta-data string) for the current recipe, or None to unassign the MESRecipe from all States.

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

  • Returns

Nothing


This object inherits the AbstractMESObject functions.


Object Events

Objects have events associated with them that allow for custom scripts to be added whenever the event occurs. Refer to MES Object Events for more information.

This object inherits the AbstractMESObject events.

Sepasoft MES Module Suite