Commandes de RecipeMan 

Présentation

Lors de l'appel d'une commande de recette, le programme accède aux données internes. Suivant le type d'équipement, cela peut prendre plusieurs millisecondes. Veillez à ce que ces appels ne soient pas effectués par la tâche MAST ou par une tâche pour laquelle une horloge de surveillance ou une tâche en temps réel est configurée. Une erreur d'application risque d'être renvoyée et le contrôleur passera à l'état HALT.

Gardez à l'esprit que l'option Enregistrer automatiquement les modifications des recettes dans le fichier de recette permet également d'accéder au fichier à chaque modification de la recette. Désactivez cette option si l'enregistrement de la recette est déclenché par l'application.

Valeurs renvoyées

Les commandes de recette peuvent renvoyer les valeurs suivantes :

CreateRecipe

Cette méthode crée une recette dans la définition de recette indiquée, et lit ensuite les valeurs du contrôleur dans cette nouvelle recette. À l'issue de l'opération, la nouvelle recette est enregistrée dans le fichier par défaut.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_ALREADY_EXIST, ERR_FAILED, ERR_OK

CreateRecipeNoSave

Cette méthode crée une recette dans la définition de recette indiquée, et lit ensuite les valeurs du contrôleur dans cette nouvelle recette.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

DeleteRecipe

Cette méthode supprime une recette d'une définition de recette.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

DeleteRecipeFile

Cette méthode supprime le fichier de recette par défaut d'une recette.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_OK

LoadAndWriteRecipe

Cette méthode charge une recette à partir du fichier de recette par défaut, et écrit ensuite la recette dans les variables du contrôleur.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_RECIPE_MISMATCH, ERR_FAILED, ERR_OK

LoadFromAndWriteRecipe

Cette méthode charge une recette à partir du fichier de recette indiqué, et écrit ensuite la recette dans les variables du contrôleur.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_RECIPE_MISMATCH, ERR_FAILED, ERR_OK

LoadRecipe

Cette méthode charge une recette à partir du fichier de recette par défaut. Le nom du fichier de recette par défaut se présente sous la forme suivante : <recette>.<définition de recette>.<extension de la recette>.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_RECIPE_MISMATCH, ERR_FAILED, ERR_OK

ReadAndSaveRecipe

Cette méthode lit les valeurs du contrôleur dans la recette, et enregistre ensuite celle-ci dans le fichier de recette par défaut.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK

ReadAndSaveRecipeAs

Cette méthode lit les valeurs du contrôleur dans la recette, et enregistre ensuite celle-ci dans le fichier de recette indiqué. Si le fichier existe déjà, son contenu est remplacé.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK

SaveRecipe

Cette méthode enregistre la recette dans le fichier de recette par défaut. Si le fichier existe déjà, son contenu est remplacé. Le nom du fichier de recette par défaut se présente sous la forme suivante : <recette>.<définition de recette>.<extension de la recette>.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK

ReadRecipe

Cette méthode lit les valeurs du contrôleur dans la recette.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

WriteRecipe

Cette méthode écrit la recette dans les variables du contrôleur.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

ReloadRecipes

Cette méthode recharge la liste des recettes à partir du système de fichiers.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_FAILED, ERR_OK

GetRecipeCount

Cette méthode renvoie le nombre de recettes conformément à la définition de recette correspondante.

Valeurs renvoyées : -1 : si la définition de recette est introuvable.

GetRecipeNames

Cette méthode renvoie les noms des recettes à partir de la définition de recette correspondante.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_FAILED, ERR_OK

Exemple :

Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :

strArr: ARRAY[0..9] OF STRING;

Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.

iStartIndex := 0;

Les noms 0 à 9 sont renvoyés.

iStartIndex := 20;

Les noms 20 à 29 sont renvoyés. Dans cet exemple :

iSize := 10;

GetRecipeValues

Cette méthode renvoie les valeurs des variables de recette à partir de la recette correspondante.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

Exemple :

Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :

strArr: ARRAY[0..9] OF STRING;

Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.

iStartIndex := 0;

Les valeurs 0 à 9 sont renvoyées.

iStartIndex := 20;

Les valeurs 20 à 29 sont renvoyées. Dans cet exemple :

iStringLength := 80;
iSize := 10;

GetRecipeVariableNames

Cette méthode renvoie le nom des variables de la recette correspondante.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

Exemple :

Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :

strArr: ARRAY[0..9] OF STRING;

Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.

iStartIndex := 0;

Les noms 0 à 9 sont renvoyés.

iStartIndex := 20;

Les noms 20 à 29 sont renvoyés. Dans cet exemple :

iSize := 10;

SetRecipeValues

Cette méthode définit les valeurs des recettes dans la recette correspondante.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

Exemple :

Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :

strArr: ARRAY[0..9] OF STRING;

Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.

iStartIndex := 0;

Les valeurs 0 à 9 sont définies.

iStartIndex := 20;

Les valeurs 20 à 29 sont définies. Dans cet exemple :

iStringLength := 80;
iSize := 10;

GetLastError

Cette méthode renvoie la dernière erreur détectée dans les opérations précédentes.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_OK

ResetLastError

Cette méthode réinitialise la dernière erreur détectée.

Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_OK