Sepasoft MES Module Suite
BatchPhase Object
The BatchPhase object represents a phase. Batch Phases can be defined using Batch Phase Manager - UI component or through scripting.
Scripting Functions
Returns BatchPhase:
BatchPhase is a parameter for:
- system.mes.batch.phase.savePhase(phase)
- system.mes.batch.phase.importPhase(xml, parentLink) - XML list of BatchPhase objects
- system.mes.batch.phase.exportPhase(phaseLink) - XML list of BatchPhase objects
BatchPhase Methods
Get and Set Phase Type
getPhaseType() | Returns the base phase type which the BatchPhase was derived from. |
setPhaseType(BatchPhaseTypes phaseType) | Set the base phase type which the BatchPhase should derive from. The base phase type cannot be altered after the BatchPhase has been saved into the system. |
Expose to Tag Engine
isExposed() | States whether the BatchPhase is exposed or not. |
setExposed | Boolean. Set whether the BatchPhase should be exposed or not. |
Add and Manage Parameters
addParameter(String name) | Adds a new parameter with the specified name to the BatchPhase. If a parameter with the specified name already exists, an error will be thrown. |
removeParameter(String name) | Remove the parameter with the specified name from the BatchPhase. |
renameParameter(String existingName, String newName) | Rename an existing parameter to the specified new name. |
removeAllParameters() | Remove all user-defined parameters from the BatchPhase. |
getParameter(String name) | Returns the BatchPhase parameter with the specified name. |
getParameterByUUID(String paramUUID) | Returns the BatchPhase parameter with the specified UUID. |
getParameterList() | Returns a list of all the parameters on the BatchPhase. |
Parameter Property
| Properties for Parameters on Batch Procedure Phases | |
|---|---|
| getDataType | |
| getDescription | |
| getDisplayName | |
| getParamCalculation | |
| hasParamCalculation | |
| getName | |
| paramMinValue | |
| paramMaxValue | |
| paramRecordingType | |
| paramRecordingTypeName | |
| paramTagType | |
| setParamKindName('User Phase') | |
| param.setParamDataTypeName('String') | |
| param.setParamValueSourceName('Recipe and Execution') | |
| setParamRecordingTypeName('All to Object and History') | |
| param.setParamValue('testvalue') |
Inherits AbstractMESObject
Sepasoft MES Module Suite