Methods
- Last UpdatedJun 23, 2017
- 52 minute read
This section describes the methods available for the wwRecipe class.
AddAllocateProcessPhase()
This method adds an allocation process phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddAllocateProcessPhase ( ProcessInstance, PhaseLabel)
Parameters
ProcessInstance
Data Type: String
Process instance in recipe
PhaseLabel
Data Type: String
The phase label is generated automatically by the recipe server and returned when this method is called.
AddAllocateTransferPhase()
This method adds an allocation transfer phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddAllocateTransferPhase ( TransferInstance, PhaseLabel)
Parameters
TransferInstance
Data Type: String
Transfer instance in recipe
PhaseLabel
Data Type: String
The phase label is generated automatically by the recipe server and returned when this method is called.
AddInputMaterials()
This method adds materials to the recipe input material list. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddInputMaterials ( MaterialInputIds)
Parameters
MaterialInputId
Data Type: Object (string array)
Input material ID
AddOperation()
This method adds an operation to the focal unit procedure. The operation is added below the current focal operation. Focus is automatically on the operation added. It is not necessary to call the SetFocusOperation method. The return code is a Boolean value that can be used for error handling.
Although not required, operation names should be unique to allow for easy access and changing operation focus.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddOperation ( Name )
Parameters
Name
Data Type: String
Name of created operation
AddOutputMaterials()
This method adds materials to the recipe output material list. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddOutputMaterials ( MaterialOutputIds)
Parameters
MaterialOutputId
Data Type: Object (string array)
Output material ID
AddProcessClass()
This method adds a process class from the Process Model database to the process class list in the recipe. A default process instance of the same name is created and added to the recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddProcessClass (ProcessClass)
Parameters
ProcessClass
Data Type: String
Process class to add
AddProcessInstance()
This method adds a unique process instance to a process class. Process instances are defined to be unique not just in their process class but across all classes. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddProcessInstance ( ProcessClass, ProcessInstance)
Parameters
ProcessClass
Data Type: String
Process class in recipe
ProcessInstance
Data Type: String
Unique instance name
AddProcessPhase()
This method adds a process phase to the focal operation. This phase must be defined under the operation’s process class. Focus is automatically on the phase added. It is not necessary to call the SetFocusPhase method. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddProcessPhase (PhaseName,
PhaseLabel)
Parameters
PhaseName
Data Type: String
Process phase name
PhaseLabel
Data Type: String
The phase label is generated automatically by the recipe server and returned when this method is called.
AddReleaseProcessPhase()
This method adds a release process phase. Focus is automatically on the phase added. It is not necessary to call the SetFocusPhase method. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddReleaseProcessPhase ( ProcessInstance, PhaseLabel)
Parameters
ProcessInstance
Data Type: String
Process instance in recipe
PhaseLabel
Data Type: String
The phase label is generated automatically by the recipe server and returned when this method is called
AddReleaseTransferPhase()
This method adds a release transfer phase. Focus is automatically on the phase added. It is not necessary to call the SetFocusPhase method. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddReleaseTransferPhase ( TransferInstance, PhaseLabel)
Parameters
TransferInstance
Data Type: String
Transfer instance in recipe
PhaseLabel
Data Type: String
The phase label is generated automatically by the recipe server and returned when this method is called.
AddToOpLibrary()
This method adds the current focal operation to the operation library. All equipment and materials are stored with the operation. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddToOpLibrary (Name, Comments)
Parameters
Name
Data Type: String
Name of the operation as it is to appear in the operation library
Comments
Data Type: String
Comments to be stored with the operation in the library
AddToUpLibrary()
This method adds the current focal unit procedure to the unit procedure library. All equipment and materials are stored with the unit procedure. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddToUpLibrary (Name, Comments)
Parameters
Name
Data Type: String
Name of the unit procedure as it is to appear in the operation library
Comments
Data Type: String
Comments to be stored with the unit procedure in the library
AddTransferInstance()
This method adds a transfer instance to a transfer class. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddTransferInstance ( TransferClass, InstanceName, SourceInstance, DestinationInstance)
Parameters
TransferClass
Data Type: String
Transfer class in recipe
InstanceName
Data Type: String
Unique transfer instance name
SourceInstance
Data Type: String
Process instance for source class
DestinationInstance
Data Type: String
Process instance for destination class
AddTransferPhase()
This method adds a transfer phase to the focal operation. The transfer instance and phase must associated with the process class of the operation. The process class is either the source or destination class for the associated transfer instance. Focus is automatically on the phase added. It is not necessary to call the SetFocusPhase method. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddTransferPhase ( TransferInstance, TransferPhase, PhaseLabel)
Parameters
TransferInstance
Data Type: String
Instance of transfer class
TransferPhase
Data Type: String
Phase of transfer class
PhaseLabel
Data Type: String
The phase label is generated automatically by the recipe server and returned when this method is called.
AddUnitProcedure()
This method adds a unit procedure to the recipe procedure. The unit procedure is added below the current focal unit procedure. Focus is automatically on the unit procedure added. It is not necessary to call the SetFocusUnitProcedure method. The return code is a Boolean value that can be used for error handling.
Although not required, unit procedure names should be unique to allow for easy access and changing unit procedure focus.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.AddUnitProcedure (Name, ProcessInstance)
Parameters
Name
Data Type: String
Name of created unit procedure
ProcessInstance
Data Type: String
Process instance in recipe
ChangeInputMaterial()
This method substitutes one material for another and reflects this change in all input phases using that material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values".
Syntax
ReturnCode = RecipeVar.ChangeInputMaterial (OldMatId, NewInputId)
Parameters
OldMatId
Data Type: Integer
Existing input material index entry in array of materials. The list of materials is one-based.
NewInputId
Data Type: String
New material to replace existing material
ChangeOutputMaterial()
This method substitutes one material for another and reflects this change in all output phases using that material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ChangeOutputMaterial ( OldOutputId, NewOutputId)
Parameters
OldOutputId
Data Type: Integer
Existing output material index entry in array of materials. The list of materials is one-based.
NewOutputId
Data Type: String
New material to replace existing material
ChangeProcessInstance()
This method renames a process instance. The new instance name is modified throughout the recipe procedure. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ChangeProcessInstance ( ProcessInstance, NewInstanceName)
Parameters
ProcessInstance
Data Type: String
Old process instance name
NewInstanceName
Data Type: String
New process instance name
ChangeTransferInstance()
This method modifies a transfer instance name or the source and destination transfer instances. The InstanceName field is required. The NewInstanceName, NewSrcInstance, and NewDestInstance fields are optional and the existing values are used. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ChangeTransferInstance ( InstanceName, NewInstanceName, NewSrcInstance, NewDestInstance)
Parameters
InstanceName
Data Type: String
Transfer Instance defined in recipe
NewInstanceName
Data Type: String
Optional new name of instance
NewSrcInstance
Data Type: String
Optional new source instance for source class
NewDestInstance
Data Type: String
Optional new destination instance for destination process class
ClearAppendtoInstructions()
This method disables the append unit descriptions to instructions property for the focal phase. There is no return value.
Syntax
RecipeVar.ClearAppendtoInstructionsDesc ()
ClearCommentRequired()
This method disables the comment required property for the focal phase. There is no return value.
Syntax
RecipeVar.ClearCommentRequired ()
ClearEntryAck()
Disables the phase entry acknowledge property for the focal phase. There is no return value.
Syntax
RecipeVar.ClearEntryAck ()
ClearEntryAck()
This method disables the phase exit acknowledge property for the focal phase. There is no return value.
Syntax
RecipeVar.ClearExitAck ()
ClearHeaderComments()
This method removes the header comments from the recipe. There is no return value.
Syntax
RecipeVar.ClearHeaderComments ()
ClearInstructions()
This method removes the phase instructions from the focal phase. There is no return value.
Syntax
RecipeVar.ClearInstructions ()
ClearPhaseContinue()
This method disables the continue mode property for the focal phase. There is no return value.
Syntax
RecipeVar.ClearPhaseContinue ()
ClearPhaseReportName()
This method removes the assigned report name from the focal phase. There is no return value.
Syntax
RecipeVar.ClearPhaseReportName
ClearProcessInstanceUnit()
This method removes the unit assignment from a process instance. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ClearProcessInstanceUnit ( ProcessInstance)
Parameters
ProcessInstance
Data Type: String
Instance for which to remove unit assignment
ClearProductionApproval()
This method disables recipe production approval. A recipe cannot be run without either approval for production or test. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ClearProdutionApproval ()
ClearTestApproval()
This method disables recipe test approval. A recipe cannot be run without either approval for production or test. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ClearTestApproval ()
Close()
This method closes the currently open recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.Close ()
DeleteInputMaterials()
This method deletes input materials. Phases using a deleted material are reset. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteInputMaterials ( InputMaterials)
Parameters
InputMaterials
Data Type: Object
List of input materials to delete
DeleteOperation()
This method deletes an operation from the focal unit procedure. The focal operation becomes the previous operation and the focal phase is the phase header. If no operations exist following the deletion, focus returns to the operation header. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteOperation ()
DeleteOpFromLibrary()
This method deletes an operation from the operation library. The operation to delete is selected from the list of possible operations that can be obtained by calling the GetOpLibrary method. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteOpFromLibrary ( OperationIndex)
Parameters
OperationIndex
Data Type: Integer
Index entry in array of available operations. The list of operations is one-based.
DeleteOutputMaterials()
This method deletes output materials. Phases using a deleted material are reset. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteOutputMaterials ( OutputMaterials)
Parameters
OutputMaterials
Data Type: Object
Output materials to delete
DeletePhase()
This method deletes the phase with focus, or if the phase header has focus, this method deletes all phases. The phase header has focus following a call to SetFocusOperation. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeletePhase ()
DeleteProcessClass()
This method deletes a process class from the recipe. All process instances are also deleted. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteProcessClass ( ProcessClass)
Parameters
ProcessClass
Data Type: String
Process Class to delete
DeleteProcessInstance()
This method deletes a process instance. Because process instances are unique across all process classes, specification of a process class is not necessary. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteProcessInstance ( ProcessInstance)
Parameters
ProcessInstance
Data Type: String
Instance to delete
DeleteRecipe()
This method deletes a recipe from the recipe database. The recipe remains in memory as an untitled recipe but is removed from the list of available recipes. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteRecipe (RecipeId)
Parameters
RecipeId
Data Type: String
Recipe to delete
DeleteTransferInstance()
This method deletes a transfer instance. Transfer instances are unique across all transfer classes so specification of a transfer class in not necessary. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteTransferInstance ( TransferInstance)
Parameters
TransferInstance
Data Type: String
Transfer Instance to delete
DeleteUnitProcedure()
This method deletes a unit procedure from the recipe procedure. The focal unit procedure becomes the previous unit procedure and the focal operation is the operation header. If only two recipe levels are defined, then the focal phase is the phase header. If no unit procedures exist following the deletion, focus returns to the procedure header. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteUnitProcedure ()
DeleteUpFromLibrary()
This method deletes a unit procedure from the unit procedure library. The unit procedure to delete is selected from the list of possible unit procedures that can be obtained by calling the GetUpLibrary method. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.DeleteOpFromLibrary ( UnitProcedureIndex)
Parameters
UnitProcedureIndex
Data Type: Integer
Index entry in array of available unit procedures. The list of unit procedures is one-based.
ExportRecipe()
This method exports a recipe from the recipe database to a binary RCP file. Only the recipes that exist in the recipe database can be exported. All exported recipes are placed in the config_A directory, by default, and have an .rcp extension. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ExportRecipe (RecipeId, Overwrite)
Parameters
RecipeId
Data Type: String
Name of recipe to export
Overwrite
Data Type: Boolean
Flag to determine if the exported recipe should overwrite an existing recipe file if one is found in the config_A directory. A value of True overwrites an existing recipe file. A value of False preserves an existing recipe file.
ExportRecipeXML()
This method exports a recipe from the recipe database to an XML file. Only the recipes that exist in the recipe database can be exported. All exported recipes are placed in the config_A directory, by default, and have an .xml extension. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see Error Return Values .
Syntax
ReturnCode = RecipeVar.ExportRecipeXML (RecipeId, Overwrite)
Parameters
RecipeId
Data Type: String
Name of recipe to export
Overwrite
Data Type: Boolean
Flag to determine if the exported recipe should overwrite an existing recipe file if one is found in the config_A directory. A value of True overwrites an existing recipe file. A value of False preserves an existing recipe file.
GetAllProcessInstances()
This method queries the recipe for all defined process instances. An array of string values containing the process instances is returned.
Syntax
ProcessInstances = RecipeVar.GetAllProcessInstances ()
GetAllTransferInstances()
This method queries the recipe for all transfer instances. An array of string values containing the transfer instances is returned.
Syntax
TransferInstances = RecipeVar.GetAllTransferInstances ()
GetApprovalHistory()
This method queries the approval history for a particular version of the currently open recipe. The version is selected from the list of all versions that can be obtained by calling the GetRecipeHistory method. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetApprovalHistory ( VersionIndex, Approval2, Approval3, Approval4, Approval5, Test, State, Type)
Parameters
VersionIndex
Data Type: Integer
Index entry in array of versions. The list of versions is one-based.
Approval2
Data Type: String
User name of individual who was the second to approve the selected version for production
Approval3
Data Type: String
User name of individual who was the third to approve the selected version for production
Approval4
Data Type: String
User name of individual who was the fourth to approve the selected version for production
Approval5
Data Type: String
User name of individual who was the fifth to approve the selected version for production
Test
Data Type: String
User name of individual approved the selected version for test
State
Data Type: String
State of the recipe for the selected version
Type
Data Type: String
Type of the recipe for the selected version
GetConnectionInfo()
This method queries a specified connection and returns the transfer class, source unit, and destination unit.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetConnectionInfo ( ConnectionName, TransferClass, SourceUnit, DestinationUnit)
Parameters
Connection
Data Type: String
Unique name of the connection
TransferClass
Data Type: String
Transfer class of the specified connection
SourceUnit
Data Type: String
Name of the destination unit for the specified connection
GetConnections()
This method queries for all connections. An array of string values containing the connection names is returned.
Syntax
Connections = RecipeVar.GetConnections ()
GetDocumentInfo()
This method queries the document viewing requirements for the focal phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetDocumentInfo (DocPath, DocDesc, DocViewReq)
Parameters
DocPath
Data Type: String
Path to the document
DocDesc
Data Type: String
Description of the assigned document
DpcViewReq
Data Type: Integer
Document viewing acknowledgement setting:
0 = None
1 = On entry
2 = Prior to exit
GetFocusOperation()
This method queries the focal operation name. The operation name is returned as a string.
Syntax
OperationName = RecipeVar.GetFocusOperation ()
GetFocusPhase()
This method queries the focal phase label. The phase label is returned as a string.
Syntax
PhaseLabel = RecipeVar.GetFocusPhase ()
GetFocusUnitProcedure()
This method queries the focal unit procedure name. The unit procedure name is returned as a string.
Syntax
UnitProcedureName = RecipeVar.GetFocusUnitProcedure ()
GetHeaderComments()
This method queries the header comments for the currently open recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetHeaderComments (Comments)
Parameters
Comment
Data Type: String
Comments defined in the header of the recipe
GetInputMaterialChars()
This method queries the characteristics defined for a specified input. The characteristics and their values are returned in arrays that can be traversed for information. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetInputMaterialChars ( MaterialId, CharacteristicNames, CharacteristicValues)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
CharacteristicName
Data Type: Object
Array of names for the characteristics defined for the selected material
CharacteristicValues
Data Type: Object
Array of values for the characteristics defined for the selected material
GetInputMaterialDescription()
This method queries the description defined for a specified input. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetInputMaterialDescription ( MaterialId, Description)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
Description
Data Type: String
Input material description
GetInputMaterialInfo()
This method queries information concerning a specified input. The information returned allows identification of duplicate materials. The UnitofMeasure and the ValueType may be defined to uniquely identify input materials. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetInputMaterialInfo (MatId, MaterialId, MaterialUnitOfMeasure, MaterialValueType)
Parameters
MatId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
MaterialId
Data Type: String
Input material ID
MaterialUnitOfMeasure
Data Type: String
Input material unit of measure value
MaterialValueType
Data Type: Integer
Input material value type
GetInputMaterialPhaseLabels()
This method queries the recipe procedure for a list of phases assigned to the specified input material. An array of string values containing the input phase labels is returned.
Syntax
InputPhaseLabels = RecipeVar.GetInputMaterialPhaseLabels (InputId)
Parameters
InputId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
GetInputMaterials()
This method queries the recipe for a list of input materials ids. An array of string values containing the input materials is returned.
Syntax
InputMaterials = RecipeVar.GetInputMaterials ()
GetInputMaterialTotal()
This method queries the total amount of input material used in the recipe. The total is returned in the Total parameter. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetInputMaterialTotal ( MaterialId, Total)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
Total
Data Type: Double
Total of material in recipe
GetInputMaterialValue()
This method queries the value of an input material. The material value is returned in the Value parameter. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetInputMaterialValue ( MaterialId, Value)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
Value
Data Type: Double
Value assigned to material
GetInputParmInfo()
This method queries all of the defined parameter information for an input parameter associated with the focal phase. The information returned includes everything about the input parameter as defined for the phase. This method is typically called following the GetParmType method once an input parameter is located. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetInputParmInfo (ParmName, Value, Tolerance, HighDev, LowDev, MaterialId, ValueType, Total, UnitOfMeasure)
Parameters
ParmName
Data Type: String
Input parameter name
Value
Data Type: Double
Input material value
Tolerance
Data Type: Integer
Input tolerance setting:
0 = General
1 = Recipe
2 = None
HiDev
Data Type: Double
Input material high deviation
LowDev
Data Type: Double
Input material low deviation
MaterialId
Data Type: String
Input material ID
ValueType
Data Type: Integer
Input value type setting:
0 = Percent
1 = Actual
Total
Data Type: Boolean
Flag to determine if the material is totaled in the formula. A value of True indicates totaling enabled. A value of False indicates totaling disabled.
UnitofMeasure
Data Type: String
Input material unit of measure
GetInstructions()
This method queries the focal phase for all defined instructions. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetInstructions (Instructions, AppendToInstructions)
Parameters
Instructions
Data Type: String
Instructions defined for the phase
AppendToInstructions
Data Type: Boolean
Flag to determine if append unit/connection description is enabled for the phase. A value of True indicates that append unit or connection description is enabled. A value of False indicates that append unit or connection description is disabled.
GetMaterialDBUofM()
This method queries the default unit of measure for a material from the materials database. The unit of measure value is returned as a string.
Syntax
MaterialUofM = RecipeVar.GetMaterialDBUofM (MaterialId)
Parameters
MaterialId
Data Type: String
Material ID
GetMaterials()
This method queries the materials database and returns a list of ids for the specified type. An array of string values containing the materials is returned.
Syntax
ListMaterials = RecipeVar.GetMaterials (MaterialType)
Parameters
MaterialType
Data Type: wwMaterialType
Material type enumeration. For MaterialType enumeration constants, see "Enumerated Constants" on page 383.
GetOperations()
This method queries the focal unit procedure for all operations. An array of string values containing the operations is returned.
Syntax
Operations = RecipeVar.GetOperations ()
GetOpLibrary()
This method queries the recipe database for all available operations in the operation library. Two arrays are returned. One array contains the names of the operations. The second array contains that operation comments. These arrays can be used to load and delete operations from the library. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetOpLibrary (OpName, OpComment)
Parameters
OpName
Data Type: Object
Array of names for all of the operations in the operation library
OpComment
Data Type: Object
Array of comments for all of the operations in the operation library
GetOutputMaterialChars()
This method queries the characteristics defined for a specified output. The characteristics and their values are returned in arrays that can be traversed for information. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetOutputMaterialChars ( MaterialId, CharacteristicNames, CharacteristicValues)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
CharacteristicName
Data Type: Object
Array of names for the characteristics defined for the selected material.
CharacteristicValues
Data Type: Object
Array of values for the characteristics defined for the selected material
GetOutputMaterialDescription()
This method queries the description defined for a specified output. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetOutputMaterialDescription ( MaterialId, Description)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
Description
Data Type: String
Output material description
GetOutputMaterialInfo()
This method queries information concerning a specified output. The information returned allows identification of duplicate materials. The UnitofMeasure or the ValueType may be defined to uniquely identify output materials. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetOutputMaterialInfo (MatId, MaterialId, MaterialUnitOfMeasure, MaterialValueType)
Parameters
MatId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
MaterialId
Data Type: String
Output material ID
MaterialUnitOfMeasure
Data Type: String
Output material unit of measure value
MaterialValueType
Data Type: Integer
Output material value type
GetOutputMaterialPhaseLabels()
This method queries the recipe procedure for a list of phases assigned to an output material. An array of string values containing the output phase labels is returned.
Syntax
OutputPhaseLabels = RecipeVar.GetOutputMaterialPhaseLabels (OutputId)
Parameters
OutputId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
GetOutputMaterials()
This method queries the recipe for a list of output materials ids. An array of string values containing the output materials is returned.
Syntax
OutputMaterials = RecipeVar.GetOutputMaterials ()
GetOutputMaterialTotal()
This method queries the total amount of output material used in the recipe. The total is returned in the Total parameter. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetOutputMaterialTotal ( MaterialId, Total)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
Total
Data Type: Double
Total material in recipe
GetOutputMaterialValue()
This method queries the value of an output material. The material value is returned in the Value parameter. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetOutputMaterialValue ( MaterialId, Value)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
Value
Data Type: Double
Assigned value to material
GetOutputParmInfo()
This method queries all of the defined parameter information for an output parameter associated with the focal phase. The information returned includes everything about the output parameter as defined for the phase. This method is typically called following the GetParmType method once an output parameter is located. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetOutputParmInfo (ParmName, Value, MaterialId, ValueType, Total, UnitOfMeasure)
Parameters
ParmName
Data Type: String
Output parameter name
Value
Data Type: Double
Output material value
MaterialId
Data Type: String
Output material ID
ValueType
Data Type: Integer
Input value type setting:
0 = Percentl
1 = Actual
Total
Data Type: Boolean
Flag to determine if the material is totaled in the formula. A value of True indicates that totaling is enabled. A value of False indicates that totaling is disabled.
UnitofMeasure
Data Type: String
Output material unit of measure
GetParameterDescription()
This method queries the description defined in the Process Model database of a specific parameter in the focal phase. The name of the phase parameter is required as an input to the function. The parameter description is returned as a parameter of the function. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetParameterDescription ( ParmName, Description)
Parameters
ParmName
Data Type: String
Name of the parameter for which the description is desired
Description
Data Type: String
Description of the parameter
GetParmElementInfo()
This method queries all of the configuration information defined in the Process Model database for each element of the selected parameter for the focal process or transfer phase. The name of the phase parameter is required as an input to the function. The parameter type, data class, and three arrays of parameter element information are returned as parameters of the function. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
The ElementTypes array contain the appropriate enumeration value (wwParamElementType) for the parameter element names (such as Target and Actual). The ElementViews array contains the appropriate enumeration value, (wwPhaseParamViewType) for the Enable Display, Edit Allowed, or Edit Required setting for each parameter element. The ElementValues array contains the default values for each parameter element where applicable. The three arrays contain information based on the type and data class of the selected parameter and all information is in the same relative position in each array.
For example, if an analog process variable parameter is selected, the first position in the ElementTypes array is 0 for the Target element, the second for the Actual element, the third position in the ElementTypes array is 2 for the High Deviation element, and so forth for all six possible elements of an analog process variable parameter (see the table that follows). However, for an analog input parameter, there would be seven entries in the ElementTypes array that correspond to the seven elements available for an input parameter (see the tables that follow).
Further, the values in the ElementViews and ElementValues arrays correspond to the appropriate element type in the ElementTypes array. Thus, for an analog process variable parameter, the first position in the ElementTypes array is 0 for the Target element, the first position in the ElementViews array is 1, 3, or 7 for the Enable Display, Edit Allowed, or Edit Required setting for the Target element, and the first position in the ElementValues array is the default value for the Target element. However, for an analog input parameter, the first position in the ElementTypes array is 0 for the Target element, the first position in the ElementViews array is 1, 3, or 7 for the Enable Display, Edit Allowed, or Edit Required setting for the Target element, but the first position in the ElementValues array is empty because there is no default value for the Target element of an input parameter.
The following tables show the basic structure of the three arrays for each possible parameter type and data class combination.
Process Variable Parameters (Analog)
The following table shows the basic structure of the analog process variable parameters.
|
Element Name |
Types Array Entry |
Views Array Entry |
Values Array Entry |
|---|---|---|---|
|
Target |
0 |
0, 1, 3, or 7 |
Default value |
|
Actual |
1 |
0, 1, 3, or 7 |
Always blank |
|
High Deviation |
2 |
0, 1, 3, or 7 |
Default value |
|
Low Deviation |
3 |
0, 1, 3, or 7 |
Default value |
|
High Limit |
4 |
0, 1, 3, or 7 |
Default value |
|
Low Limit |
5 |
0, 1, 3, or 7 |
Default value |
Process Variable Parameters (Discrete or String)
The following table shows the basic structure of the discrete or string process variable parameters.
|
Element Name |
Types Array Entry |
Views Array Entry |
Values Array Entry |
|---|---|---|---|
|
Target |
0 |
0, 1, 3, or 7 |
Default value |
|
Actual |
1 |
0, 1, 3, or 7 |
Always blank |
Input Parameters (Analog Only)
The following table shows the basic structure of the input parameters.
|
Element Name |
Types Array Entry |
Views Array Entry |
Values Array Entry |
|---|---|---|---|
|
Target |
0 |
0, 1, 3, or 7 |
No value returned |
|
Actual |
1 |
0, 1, 3, or 7 |
No value returned |
|
High Deviation |
2 |
0, 1, 3, or 7 |
No value returned |
|
Low Deviation |
3 |
0, 1, 3, or 7 |
No value returned |
|
Preact |
4 |
0, 1, 3, or 7 |
No value returned |
|
Lot Code |
5 |
0, 1, 3, or 7 |
No value returned |
|
Material ID |
6 |
0, 1, 3, or 7 |
No value returned |
Output Parameters (Analog Only)
The following table shows the basic structure of the output parameters,
|
Element Name |
Types Array Entry |
Views Array Entry |
Values Array Entry |
|---|---|---|---|
|
Target |
0 |
0, 1, 3, or 7 |
No value returned |
|
Actual |
1 |
0, 1, 3, or 7 |
No value returned |
|
Material ID |
2 |
0, 1, 3, or 7 |
No value returned |
Syntax
ReturnCode = RecipeVar.GetParmElementInfo (ParmName, ParmType, DataClass, ElementTypes, ElementViews, ElementValues)
Parameters
ParmName
Data Type: String
Name of the parameter for which the element information is desired
ParmType
Data Type: Integer
Phase parameter type setting:
0 = Input
1 = Process variable
2 = Output
DataClass
Data Type: Integer
Phase parameter data class setting:
0 = Analog
1 = Discrete
2 = String
3 = Enumeration
ElementTypes
Data Type: Object
Array of elements available for the selected parameter. Each entry is an integer that corresponds to the wwParamElementType enumeration. For Element Type enumeration constants, see "wwParamElementType" on page 384.
ElementViews
Data Type: Object
Array of display and edit settings for the appropriate parameter elements. Each entry is an integer that corresponds to the wwPhaseParamViewType enumeration. For Element View enumeration constants, see "wwPhaseParamViewType" on page 386.
ElementValues
Data Type: Object
Array of default values for the appropriate parameter elements. Each entry is a string that corresponds to the default value defined in the Process Model Editor for that corresponding element.
GetParmEnumValues()
This method queries the enumeration values available for a selected parameter. An array is returned that contains the enumeration values. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetParmEnumValues (ParmName, EnumValues)
Parameters
ParmName
Data Type: String
Name of the parameter
EnumValue
Data Type: Object
Array of enumeration values available for the selected parameter
GetParmType()
This method queries the selected parameter for its type. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetParmType (ParmName, ParmType)
Parameters
ParmName
Data Type: String
Name of the parameter
ParmType
Data Type: Integer
Phase parameter type setting:
0 = Input
1 = Process variable
2 = Output
GetPhaseDescription()
This method queries the description defined in the Process Model database for the focal phase. The phase description is returned as a parameter of the function. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetPhaseDescription ( Description)
Parameters
Description
Data Type: String
Description of the focal phase
GetPhaseInfo()
This method queries the focal phase for all defined property information. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetPhaseInfo (ReportName, EntryAck, ExitAck, CommentRequired, ContinueMode)
Parameters
ReportName
Data Type: String
Name of report assigned to the phase
EntryAck
Data Type: Integer
Phase entry acknowledgement setting:
0 = Entry acknowledge
3 = Done by Entry acknowledge
7 = Check by Entry acknowledge
ExitAck
Data Type: Integer
Phase entry acknowledgement setting:
8 = Exit acknowledge
24 = Done by Exit acknowledge
56 = Check by Exit acknowledge
CommentRequired
Data Type: Boolean
Flag to determine if comment required property is enabled for the phase. A value of True indicates comment required enabled. A value of False indicates comment required disabled.
ContinueMode
Data Type: Boolean
Flag to determine if continue mode property is enabled for the phase. A value of True indicates continue mode enabled. A value of False indicates continue mode disabled.
GetPhaseLabels()
This method queries the focal operation and returns a list of the operation’s phase labels. An array of string values containing the phase labels is returned.
Syntax
PhaseLabels = RecipeVar.GetPhaseLabels ()
GetPhaseParams()
This method queries the focal phase and returns a list of all phase parameters. An array of string values containing the phase parameters is returned.
Syntax
PhaseParams = RecipeVar.GetPhaseParams ()
GetPhases()
This method queries the focal operation and returns a list of phase names. An array of string values containing the phases is returned.
Syntax
Phases = RecipeVar.GetPhases ()
GetPhaseType()
This method queries the type for the focal phase. A Short return value provides the phase type. The value can be interpreted as follows:
0 = Process
1 = Allocate process
2 = Release process
3 = Transfer
4 = Allocate transfer
5 = Release transfer
Syntax
PhaseType = RecipeVar.GetPhaseType ()
GetProcessClasses()
This method queries the Process Model database for all process classes. An array of string values containing the process classes is returned.
Syntax
ProcessClasses = RecipeVar.GetProcessClasses ()
GetProcessClassUnits()
This method queries the Process Model database and returns a list of units assigned to a process class. An array of string values containing the assigned units is returned.
Syntax
AssignedUnit = RecipeVar.GetProcessClassUnits ( ProcessClass)
Parameters
ProcessClass
Data Type: String
Process class in model database
GetProcessInstanceAttributes()
This method queries the attributes defined for a specified process instance in the recipe. Three arrays are returned that includes the names, minimum values, and maximum values for each attribute. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetProcessInstanceAttributes ( ProcessInstance, AttributeNames, AttributeMins, AttributeMaxs)
Parameters
ProcessInstance
Data Type: String
Name of process instance for which attributes are desired
Attribute
Data Type: Object
Array of names for the attributes defined for the selected process class
AttributeMins
Data Type: Object
Array of minimum values for the attributes defined for the selected process class
AttributeMaxs
Data Type: Object
Array of maximum values for the attributes defined for the selected process class
GetProcessInstances()
This method queries the process class instances defined for a recipe. An array of string values containing the process instances is returned.
Syntax
ProcessInstances = RecipeVar.GetProcessInstances ( ProcessClass)
Parameters
ProcessClass
Data Type: String
Class to query for its instances
GetProcessInstanceUnit()
This method queries a process instance for its unit assignment. The unit name is returned as a string.
Syntax
UnitName = RecipeVar.GetProcessInstanceUnit ( ProcessInstance)
Parameters
ProcessInstance
Data Type: String
Instance to query for unit assignment
GetProcessPhaseDescByClass()
This method queries the description defined in the Process Model database for a specific process phase. The names of the process class and process phase are required as input to the function. The phase description is returned as a parameter of the function. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetProcessPhaseDescByClass ( ProcessClass, ProcessPhase, Description)
Parameters
ProcessClass
Data Type: String
Name of the process class as defined in the Process Mode
ProcessPhase
Data Type: String
Name of the process phase as defined in the Process Model
Description
Data Type: String
Description of the process phase requested
GetProcessPhaseDescByInstance()
This method queries the description defined in the Process Model database for a specific process phase based on the phase instance in a recipe. The names of the recipe process instance and process phase are required as input to the function. The phase description is returned as a parameter of the function. This method differs from GetProcessPhaseDescByClass in that this method requires the process instances be added to a recipe prior to the retrieval of the description. The GetProcessPhaseDescByClass method does not require any prior recipe configuration. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetProcessPhaseDescByInstance ( ProcessInstance, ProcessPhaseName, PhaseDescription)
Parameters
ProcessInstance
Data Type: String
Name of the process instance as defined in the recipe
ProcessPhase
Data Type: String
Name of the process phase as defined in the Process Model
Description
Data Type: String
Description of the process phase requested
GetProcessPhases()
This method queries the phases from the Process Model database for a specific process class. The name of the process class is required as an input to the function. An array of process phases is returned.
Syntax
ProcessPhases = RecipeVar.GetProcessPhases ( ProcessClass)
Parameters
ProcessClass
Data Type: String
Name of the process class as defined in the Process Mode
GetProcessVariables()
This method queries all recipe phase labels, phases, and phase formula parameters. Three arrays are returned by this function. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetProcessVariables (Labels, Phases, Parameters)
Parameters
Labels
Data Type: Object
Array of all labels for phases in the recipe
Phases
Data Type: Object
Array of all phases in the recipe
Parameters
Data Type: Object
Array of all phase formula parameters in the recipe
GetProcessVarParmInfo()
This method queries all the defined parameter information for a process variable parameter associated with the focal phase. The information returned includes everything about the process variable parameter as defined for the phase. This method is typically called following the GetParmType method after a process variable parameter is located. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetProcessVarParmInfo ( ParmName, Value, ToleranceType, HighDev, LowDev, UnitofMeasure)
Parameters
Labels
Data Type: String
Process variable parameter name
Value
Data Type: String
Process variable value
ToleranceType
Data Type: Integer
Process variable tolerance setting:
0 = General
1 = Recipe
2 = None
HighDev
Data Type: Double
Process variable high deviation
LowDev
Data Type: Double
Process variable low deviation
UnitOfMeasure
Data Type: String
Process variable unit of measure
GetRecipeApprovals()
This method queries the recipe approval status for the currently open recipe. The approval flags are returned when this method is called. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetRecipeApprovals (Production, Test)
Parameters
Production
Data Type: Boolean
Flag to determine if recipe is approved for production. A value of True indicates that approved for production is enabled. A value of False indicates that approved for production is disabled.
Test
Data Type: Boolean
Flag to determine if recipe is approved for test. A value of True indicates that approved for test is enabled. A value of False indicates that approved for test is disabled.
GetRecipeHistory()
This method queries the history for the currently open recipe. The number of versions is returned as a parameter. In addition, three arrays are returned that includes the dates, authors, and comments for each version. The arrays can be traversed using the number of versions information. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetRecipeHistory (NumVersions, Dates, Authors, Comments)
Parameters
NumVersion
Data Type: Integer
Number of recipe versions available
Dates
Data Type: Object
Array of dates for each recipe version
Authors
Data Type: Object
Array of authors for each recipe version
Comments
Data Type: Object
Array of comments for each recipe version
GetRecipeProcessClasses()
This method queries all process classes assigned to a recipe. An array of string values containing the process classes is returned.
Syntax
ProcessClasses = RecipeVar.GetRecipeProcessClasses ()
GetState()
This method queries the state defined for the current open recipe. The name of the state assigned to the recipe is returned as a parameter. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetState (StateName)
Parameters
StateName
Data Type: String
Name of state assigned to recipe
GetStateInfo()
This method queries the information for a specific state in the recipe database. The name of the state is required and the description, default status, schedule status, and read only information is returned in the parameters. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetStateInfo (StateName, Description, DefaultState, ScheduleState, ReadOnly)
Parameters
StateName
Data Type: String
Name of state for which information is desired
Description
Data Type: String
Description of specified state
DefaultState
Data Type: Boolean
Flag to determine if state is the default for the recipe database. A value of True indicates the default state. A value of False indicates not the default state.
ScheduleState
Data Type: Boolean
Flag to determine if state allows scheduling. A value of True indicates that recipes with this state can be scheduled. A value of False indicates that recipes with this state cannot be scheduled.
ReadOnly
Data Type: Boolean
Flag to determine if recipe with this state is read only or read/write. A value of True indicates read only. A value of False indicates read and write.
GetStates()
This method queries all states defined in the recipe database. The states are returned in an object.
Syntax
RecipeStates = RecipeVar.GetStates ()
GetTrainAttributes()
This method queries the train for the defined attributes, values, and data classes. An array of string values containing the attribute names is returned in the names argument. An array of values is returned in the values argument. An array of ValueTypes is returned in the ValueTypes argument. The function returns a boolean value: True if successful, and False if there is an error.
Syntax
Dim Names as Object
Dim Values as Object
Dim ValueTypes as Object
Dim Train as String
ReturnCode = RecipeVar.GetTrainAttributes (Train, Names, Values, ValueTypes)
Parameters
Train
Data Type: String
Train to query for its attributes
Names
Data Type: Object
Returned names of the attributes
Values
Data Type: Object Array
Returned Values of attributes
ValueTypes
Data Type: Object Array
Returned Value Types of attributes:
0 = Real
1 = Integer
2 = String
GetTrains()
This method queries the system for the defined trains. An array of string values containing the train names is returned.
Syntax
Trains = RecipeVar.GetTrains ()
GetTrainUnits()
This method queries the train for its contained units. An array of string values containing the unit names is returned.
Syntax
Units = RecipeVar.GetTrainUnits (Train)
Parameters
Train
Data Type: String
Train to query for its units
GetTransferClasses()
This method queries the recipe for the defined transfer classes. Transfer classes are added to the recipe when both the source and destination process classes are defined in the recipe. An array of string values containing the transfer classes is returned.
Syntax
TransferClasses = RecipeVar.GetTransferClasses ()
GetTransferInstances()
This method queries the transfer class instances defined for a recipe. A transfer class and default instances are added to a recipe automatically when both the source and destination process classes are defined for the recipe. An array of string values containing the transfer instances is returned.
Syntax
TransferInstances = RecipeVar.GetTransferInstances ( TransferClass)
Parameters
TransferClass
Data Type: String
Class to query for its instances
GetTransferInstanceSrcDest()
This method queries a transfer instance for its source and destination instances. These source and destination instances are defined under the source and destination process classes for the transfer class. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetTransferInstanceSrcDest ( TransferInstance, Source, Destination)
Parameters
TransferInstance
Data Type: String
Transfer Instance to query for source and destination instances
Source
Data Type: String
Source instance of Transfer
Destination
Data Type: String
Destination instance of Transfer
GetTransferPhaseDescByClass()
This method queries the description defined in the Process Model database for a specific transfer phase. The names of the transfer class and transfer phase are required as input to the function. The phase description is returned as a parameter of the function. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetTransferPhaseDescByClass ( TransferClass, TransferPhase, Description)
Parameters
TransferClass
Data Type: String
Name of the transfer class as defined in the Process Model
TransferPhase
Data Type: String
Name of the transfer phase as defined in the Process Model
Description
Data Type: String
Description of the transfer phase requested
GetTransferPhaseDescByInstance()
This method queries the description defined in the Process Model database for a specific transfer phase based on the phase instance in a recipe. The names of the recipe transfer instance and transfer phase are required as input to the function. The phase description is returned as a parameter of the function. This method differs from GetTransferPhaseDescByClass in that this method requires the transfer instances be added to a recipe prior to the retrieval of the description. The GetTransferPhaseDescByClass method does not require any prior recipe configuration. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetTransferPhaseDescByInstance ( TransferInstance, TransferPhaseName, PhaseDescription)
Parameters
TransferInstance
Data Type: String
Name of the transfer instance as defined in the Process Model
TransferPhase
Data Type: String
Name of the transfer phase as defined in the Process Model
Description
Data Type: String
Description of the transfer phase requested
GetTransferPhases()
This method queries the phases from the Process Model database for a specific transfer class. The name of the transfer class is required as an input to the function. An array of transfer phases is returned.
Syntax
TransferPhases = RecipeVar.GetTransferPhases ( TransferClass)
Parameters
TransferClass
Data Type: String
Name of the transfer class as defined in the Process Model
GetType()
This method queries the type defined for the current open recipe. The name of the type assigned to the recipe is returned as a parameter. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetType (TypeName)
where:
Parameters
TypeName
Data Type: String
Name of type assigned to recipe
GetTypeInfo()
This method queries the information for a specific type in the recipe database. The name of the type is required and the description and default status information is returned in the parameters. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetTypeInfo (TypeName, Description, DefaultType)
Parameters
TypeName
Data Type: String
Name of type for which information is desired
Description
Data Type: String
Description of specified type
DefaultType
Data Type: Boolean
Flag to determine if type is the default for the recipe database. A value of True indicates the default type. A value of False indicates not the default type.
GetTypes()
This method queries all types defined in the recipe database. The types are returned in an object.
Syntax
RecipeTypes = RecipeVar.GetTypes ()
GetUnitProcedureProcessPhases()
This method queries the focal unit procedure and returns a list of process phases. This list represents all process phases for the unit procedure’s process instance. An array of string values containing the process phases is returned.
Syntax
ProcessPhases = RecipeVar.GetUnitProcedureProcessPhases ()
GetUnitProcedures()
This method queries the recipe procedure for all unit procedures. An array of string values containing the unit procedures is returned.
Syntax
UnitProcedures = RecipeVar.GetUnitProcedures ()
GetUnitProcedureTransferPhases()
This method queries the Process Model database for transfer instances and phases associated with the focal unit procedure. These lists represent the instances and phases for the unit procedure’s process instance. The transfer instances and phase are returned to the TransferInstances and TransferPhases parameters. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetUnitProcedureTransferPhases ( TransferInstances, TransferPhases)
Parameters
TransferInstances
Data Type: Object
List of transfer instances
TransferPhases
Data Type: Object
List of transfer phases
GetUpLibrary()
This method queries the recipe database for all available unit procedures in the unit procedure library. Two arrays are returned. One array contains the names of the unit procedures. The second array contains that unit procedure comments. These arrays can then be used to load and delete unit procedures from the library. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.GetUpLibrary (UpNames, UpComments)
Parameters
UpName
Data Type: Object
Array of names for all of the unit procedures in the unit procedure library
UpComments
Data Type: Object
Array of comments for all of the unit procedures in the unit procedure library
ImportRecipe()
This method imports a recipe from a file into the recipe database. Recipes that are exported from the recipe database and have an .rcp extension can be imported using this method. Also, recipes that have an .xml extension and are in the proper format can be imported. The return code is a Boolean value that can be used for error handling. You should also check the SMC Logger or LogViewer for more details if you get an error.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ImportRecipe (FileName, Overwrite)
Parameters
FileName
Data Type: String
Name of recipe file to import. This name can include the full path to the file as well.
UpComments
Data Type: Boolean
Flag to determine if the imported recipe should overwrite an existing recipe if one is found in the recipe database. A value of True overwrites an existing recipe. A value of False preserves an existing recipe.
LoadOpFromLibrary()
This method loads an operation from the operation library into the focal unit procedure. The operation is placed after the current focal operation. The operation to load is selected from the list of possible operations that can be obtained by calling the GetOpLibrary method. If the proper equipment has not been assigned to the recipe, the operation does not load. The InsertMaterials parameter can optionally be used to automatically add any materials defined in the operation to the recipe formula. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.LoadOpFromLibrary ( OperationIndex, InsertMaterials)
Parameters
OperationIndex
Data Type: Integer
Index entry in array of available operations. The list of operations is one-based.
UpComments
Data Type: Boolean
Flag to determine if the materials associated with the operation to be loaded should be automatically added to the recipe formula. A value of True adds the materials. A value of False does not add the materials. The operation is added even if the materials are not added to the formula.
LoadUpFromLibrary()
This method loads a unit procedure from the unit procedure library into the recipe procedure. The unit procedure is placed after the current focal unit procedure. The unit procedure to load is selected from the list of possible unit procedures that can be obtained by calling the GetUpLibrary method. If the proper equipment has not been assigned to the recipe, the unit procedure cannot load. The InsertMaterials parameter can optionally be used to automatically add any materials defined in the unit procedure to the recipe formula. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.LoadUpFromLibrary ( UnitProcedureIndex, InsertMaterials)
Parameters
UnitProcedureIndex
Data Type: Integer
Index entry in array of available unit procedures. The list of unit procedures is one-based.
InsertMaterials
Data Type: Boolean
Flag to determine if the materials associated with the unit procedure to be loaded should be automatically added to the recipe formula. A value of True adds the materials. A value of False does not add the materials. The unit procedure is added even if the materials are not added to the formula.
NewRecipe()
This method initializes and clears the recipe in memory. The Construction of recipes requires either calling NewRecipe or Open. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.NewRecipe ()
Open()
This method opens a recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.Open (RecipeId)
Parameters
RecipeId
Data Type: String
Recipe in database to open
ResetPhaseFocus()
This method focuses on a phase not within the current focused operation and having that phase become the focal phase. If you are using SetFocusPhase, the phase label specified must part of the current focal operation. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.RecipeVar.ResetPhaseFocus ( Label)
Parameters
Label
Data Type: String
Phase label
Save()
This method saves the currently opened recipe to the recipe database. The Author field is required. Version comments are optional. The version information is automatically incremented by the server. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.RecipeVar.Save (Author, VersionComments)
Parameters
Author
Data Type: String
Modifier of recipe
VersionComments
Data Type: String
Optional comments recorded with recipe version record.
SaveAs()
This method saves a recipe to the recipe database using a unique Recipe Id. The Author and Id fields are required. Version comments are optional. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.RecipeVar.SaveAs (RecipeId, Author, VersionComments)
Parameters
RecipeId
Data Type: String
Unique recipe identifier
Author
Data Type: String
Creator of recipe
VersionComments
Data Type: String
Optional comments recorded with recipe version record
SetAppendtoInstructions()
This method enables the appending unit descriptions to phase instructions property for the focal phase. There is no return value.
Syntax
RecipeVar.RecipeVar.SetAppendtoInstructions ()
SetCommentRequired()
This method enables the comment required property for the focal phase. There is no return value.
Syntax
RecipeVar.RecipeVar.SetCommentRequired ()
SetDocumentInfo()
This method assigns a document and the viewing requirements to the focal phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.RecipeVar.SetDocumentInfo ( DocPath, DocDesc, DocViewReq)
Parameters
DocPath
Data Type: String
Path to the document
DocDesc
Data Type: String
Description of assigned document
DocViewReq
Data Type: Integer
Document viewing acknowledgement setting:
0 = None
1 = On entry
2 = Prior to exit
SetEntryAck()
This method enables the phase entry acknowledge property for the focal phase. There is no return value.
Syntax
RecipeVar.SetEntryAck (EntryAck)
Parameters
EntryAck
Data Type: wwPhaseEntry
Phase entry acknowledgement enumeration. For EntryAck enumeration constants, see "Enumerated Constants" on page 383.
SetExitAck()
This method enables the phase exit acknowledge property for the focal phase. There is no return value.
Syntax
RecipeVar.SetExitAck (ExitAck)
Parameters
ExitAck
Data Type: wwPhaseExit
Phase exit acknowledgement enumeration. For ExitAck enumeration constants, see "Enumerated Constants" on page 383.
SetFocusOperation()
This method sets focus to a specified operation. Invalid operation names do not reset either operation or phase focus. Since operation names need not be unique, it always sets focus to the first operation found with the name. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetFocusOperation ( OperationName)
Parameters
OperationName
Data Type: String
Operation Name in unit procedure
SetFocusPhase()
This method sets focus to a new phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetFocusPhase (PhaseLabel)
Parameters
PhaseLabel
Data Type: String
Unique label for selected phase
SetFocusUnitProcedure()
This method sets focus to a specified unit procedure. Invalid unit procedure names do not reset either unit procedure, operation or phase focus. Since unit procedure names need not be unique, it always sets focus to the first unit procedure found with the name. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetFocusUnitProcedure ( UnitProcedureName)
Parameters
UnitProcedureName
Data Type: String
Unit Procedure Name in recipe procedure
SetFocusUpPhase()
This method sets the focus on a phase within a unit procedure. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetFocusUpPhase (UnitProcedure, PhaseLabel)
Parameters
UnitProcedure
Data Type: String
Name of focal unit procedure
PhaseLabel
Data Type: String
Phase label within unit procedure
SetHeaderComments()
This method defines header comments. The function does not append comments to the currently defined header comments so the comments passed to the function become the new header comments. There is no return value.
Syntax
RecipeVar.SetHeaderComments (HeaderComments)
Parameters
HeaderComments
Data Type: String
Null terminated string containing all comments
SetInputHighDev()
This method assigns a new high deviation value to an input material. The material must have Recipe tolerances (wwRecipeTolerance). The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputHighDev (MaterialId, HighDev)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
HighDev
Data Type: Double
New high deviation
SetInputLowDev()
This method assigns a new low deviation value to an input material. The material must have Recipe tolerances (wwRecipeTolerance). The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputLowDev (MaterialId, LowDev)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
LowDev
Data Type: Double
New low deviation
SetInputParmMaterial()
This method assigns a material and value to an input phase parameter. The material Id must be defined as an input material for the recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputParmMaterial ( Parameter, MaterialId, Value)
Parameters
Parameter
Data Type: String
Parameter of focal phase
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
Value
Data Type: Double
Phase parameter value
SetInputParmValue()
This method assigns a value to the input phase parameter for the focal phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputParmValue (ParmName, Value)
Parameters
ParmName
Data Type: String
Input phase parameter name
Value
Data Type: Double
New value for parameter
SetInputTolerance()
This method assigns a tolerance type to an input material. The default type is General (wwGeneralTolerance). The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputTolerance (MaterialId, Tolerance)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
Tolerance
Data Type: wwToleranceType
Input tolerance enumeration. For Tolerance enumeration constants, see "Enumerated Constants" on page 383.
SetInputTotal()
This method enables or disables the totaling of an input material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputTotal (MaterialId, Total)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
Total
Data Type: Integer
Flag to disable or enable totaling of material:
0 = Not totaled
1 = Totaled
SetInputUnitOfMeasure()
This method modifies the unit of measure for an input material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputUnitOfMeasure ( MaterialId, NewMaterialUofM)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
NewMaterialUofM
Data Type: String
New material unit of measure value
SetInputValue()
This method assigns a new value to an input material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputValue (MaterialId, Value)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
Value
Data Type: Double
New value for material
SetInputValueType()
This method assigns a new value type to an input material. The default value type is Percent (wwPercentValueType). The return code is a Boolean value that can be used for error handling.
Note: The ValueType parameter is used to distinguish between multiple instances of the same material. It is possible to have more than two instances of a material.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetInputValueType (MaterialId, ValueType)
Parameters
MaterialId
Data Type: Integer
Input material index entry in array of materials. The list of materials is one-based.
ValueType
Data Type: wwParmValueType
Input value type enumeration. For ValueType enumeration constants, see "Enumerated Constants" on page 383.
SetInstructions()
This method assigns phase instructions to the focal phase. There is no return value.
Syntax
RecipeVar.SetInstructions (Instructions)
Parameters
Instructions
Data Type: String
String of instructions to be assigned to a phase
SetOutputParmMaterial()
This method assigns a material and value to an output phase parameter. The material Id must be defined as an output material for the recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetOutputParmMaterial ( ParmName, MaterialId, Value)
Parameters
ParmName
Data Type: String
Parameter Name in focal phase
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
Value
Data Type: Double
Phase parameter value
SetOutputParmValue()
This method assigns a value to the output phase parameter for the focal phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetOutputParmValue (ParmName, Value)
Parameters
ParmName
Data Type: String
Parameter Name in focal phase
Value
Data Type: Double
Phase parameter value
SetOutputTotal()
This method enables or disables the totaling of an output material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetOutputTotal (MaterialId, Total)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
Total
Data Type: Integer
Flag to disable or enable totaling of material:
0 = Not totaled
1 = Totaled
SetOutputUnitOfMeasure()
This method modifies the unit of measure for an output material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetOutputUnitOfMeasure ( MaterialId, NewMaterialUofM)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
NewMaterialUofM
Data Type: String
New material unit of measure value
SetOutputValue()
This method assigns a new value to an output material. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetOutputValue (MaterialId, Value)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
Value
Data Type: Double
New value for material
SetOutputValueType()
This method assigns a new value type to an input material. The default value type is Percent (wwPercentValueType). The return code is a Boolean value that can be used for error handling.
Note: The ValueType parameter may be used to distinguish between multiple instances of the same material. It is possible to have more than two instances of a material.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetOutputValueType (MaterialId, ValueType)
Parameters
MaterialId
Data Type: Integer
Output material index entry in array of materials. The list of materials is one-based.
ValueType
Data Type: wwParmValueType
Output value type enumeration. For ValueType enumeration constants, see "Enumerated Constants" on page 383.
SetPhaseContinue()
This method enables the continue mode property for the focal phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetPhaseContinue ()
SetPhaseLabel()
This method changes the label for the focal phase. The function assures uniqueness of phase label names. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetPhaseLabel (OldLabel, NewLabel)
Parameters
OldLabel
Data Type: String
Existing phase label
NewLabel
Data Type: String
New unique phase label
SetPhaseReportName()
This method assigns a report name to the focal phase. There is no return value.
Syntax
RecipeVar.SetPhaseReportName (ReportName)
Parameters
ReportName
Data Type: String
Report name defined in report database
SetProcessInstanceAttribute()
This method assigns a value to a process instance attribute. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetProcessInstanceAttribute ( ProcessInstance, AttributeName, AttributeMin, AttributeMax)
Parameters
ProcessInstance
Data Type: String
Instance containing attribute
AttributeName
Data Type: String
Attribute name from model database
AttributeMin
Data Type: Double
New minimum attribute value
AttributeMax
Data Type: Double
New maximum attribute value
SetProcessInstanceSelMode()
This method defines the unit selection mode for a process instance. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetProcessInstanceSelMode ( ProcessInstance, SelectionMode)
Parameters
ProcessInstance
Data Type: String
Process Instance to assign selection mode
SelectionMode
Data Type: wwUnitSelectionType
Instance selection mode enumeration. For SelectionMode enumeration constants, see "Enumerated Constants" on page 383.
SetProcessInstanceUnit()
This method assigns a unit to a process instance. The unit must be assigned to the process instance’s process class. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetProcessInstanceUnit ( ProcessInstance, Unit)
Parameters
ProcessInstance
Data Type: String
Process Instance to receive unit assignment
Unit
Data Type: String
Unit name from process model database
SetProcessVarParmValue()
This method assigns a value to a process variable parameter for the focal phase. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetProcessVarParmValue ( ParmName, Value)
Parameters
ParmName
Data Type: String
Process variable name
Value
Data Type: String
New parameter value
SetProcessVarTolerance()
This method assigns a tolerance type to a process variable parameter. The default type is General (wwGeneralTolerance). The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetProcessVarTolerance ( Parameter, Tolerance, LowDev, HighDev)
Parameters
Parameter
Data Type: String
Process variable parameter
Tolerance
Data Type: wwToleranceType
Process variable tolerance enumeration. For Tolerance enumeration constants, see "Enumerated Constants" on page 383.
LowDev
Data Type: Double
New low deviation
HighDev
Data Type: Double
New high deviation
SetProductionApproval()
This method enables recipe production approval. A recipe cannot be run without either approval for production or test. The return code is a Boolean value that can be used for error handling.
Note: This function should only be called after the recipe has been saved using the Save or SaveAs methods. Any change made to a recipe automatically disables the approved for production flag.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetProductionApproval ()
SetState()
This method assigns a valid state to a recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetState (StateName)
Parameters
StateName
Data Type: String
Name of state to assign to recipe
SetStatetoDefault()
This method assigns the default state to the recipe. If no default state is defined in the database, the recipe is not modified. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetStatetoDefault ()
SetTestApproval()
This method disables recipe test approval. A recipe cannot be run without either approval for production or test. The return code is a Boolean value that can be used for error handling.
Note: This function should only be called after the recipe has been saved using the Save or SaveAs methods. Any change made to a recipe automatically disables the approved for test flag.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetTestApproval ()
SetType()
This method assigns a valid type to a recipe. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetType (Name)
Parameters
Name
Data Type: String
Name of type to assign to recipe.
SetTypetoDefault()
This method assigns the default type to the recipe. If no default type is defined in the database, the recipe is not modified. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.SetTypetoDefault ()
ValidateRecipe()
This method validates the recipe and returns any error messages. If valid, function returns True and one message stating recipe is valid. The validation messages are returned to the ValidationMsgs parameter. The return code is a Boolean value that can be used for error handling.
For more information on the error codes returned, see "Error Return Values" on page 388.
Syntax
ReturnCode = RecipeVar.ValidateRecipe (ValidationMsgs)
Parameters
ValidationMsgs
Data Type: Object
One message for each error or a single message for valid recipe.