RecipeStoreInstance

This function/function block was added in KAS 5.00.

PLCopen motion icon Pipe Network motion icon

Function Block - Store the present values of the program data in a recipe instance.

If an instance with the specified name already exists, the values in that instance are overwritten.
If no instance exists with the specified name, a new instance with the specified name is created.
No range validation is performed while storing.
- Validation is deferred until a later call to RecipeApplyInstance.

Inputs

Input	Data Type See Data Types.	Range	Unit	Default	Description
Execute	BOOL	FALSE, TRUE	N/A	No default	On the rising edge, save the program data into the named recipe instance.
RecipeID	UDINT	No range	N/A	No default	The ID of the recipe object to use. RecipeID is the handle ID returned by the RecipeOpen function block.
Name	STRING	No range	N/A	No default	The name of the new instance. If Name is an empty string, the instance is assigned the name 'Instance'.

Input

Data Type

See Data Types.

Range

Unit

Default

Description

Execute

BOOL

FALSE, TRUE

N/A

No default

On the rising edge, save the program data into the named recipe instance.

RecipeID

UDINT

No range

N/A

No default

The ID of the recipe object to use.
RecipeID is the handle ID returned by the RecipeOpen function block.

Name

STRING

No range

N/A

No default

The name of the new instance.
If Name is an empty string, the instance is assigned the name 'Instance'.

Outputs

Output	Data Type See Data Types.	Range	Unit	Description
Done	BOOL	FALSE, TRUE	N/A	If TRUE, the command completed successfully.
Busy	BOOL	FALSE, TRUE	N/A	If TRUE, the function block is executing.
Error	BOOL	FALSE, TRUE	N/A	If TRUE, an error has occurred.
ErrorID	DINT	Enumerated	N/A	Indicates the error if Error output is TRUE. See PLCopen Function Block ErrorIDs.

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

Inst_RecipeStoreInstance(True, recipeID, 'Cogs');
IF Inst_RecipeStoreInstance.Error THEN
   errorMessage := MC_ErrorDescription(Inst_RecipeStoreInstance.ErrorID); 
END_IF;