Logik im Hintergrund
Das Beispiel erweitert die im Action and Conditions Editor zur Verfügung stehenden Funktionen „Activate“, „Teach“ und „TeachAsNew“ um weitere benutzerspezifische Funktionen, die im Hintergrund die Framework API der Rezeptverwaltung aufrufen. Diese Funktionen können auch in anderen Projekten wiederverwendet werden, wenn sie entsprechend importiert werden.
Die Funktionen befinden sich in HMI-Projekt unter dem Ordner RecipeFunctions.
Da alle Funktionen asynchron ausgeführt werden, erhalten diese als Übergabeparameter zusätzlich ein Context-Objekt. Dieses gibt Auskunft über den Erfolg bzw. Misserfolg der Funktion.
ConvertDatagridToRecipe
Die Funktion ConvertDatagridToRecipe liest den aktuellen Inhalt des Datagrids aus und speichert diesen in dem übergebenen Rezept ab. Diese Funktion wird beim Klick auf den Button Update selected recipe ausgeführt.
Parameter:
Name | Typ | Beschreibung |
|---|---|---|
datagridControl | tchmi:framework#/definitions/Control | Das TcHmiDatagrid, in welchem die Rezept-Member angezeigt werden sollen. |
recipeReference | tchmi:framework#/definitions/RecipeReference | Die Referenz zu dem Rezept, welches beschrieben werden soll. |
Rückgabewert:
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
ConvertRecipeToDatagrid
Die Funktion ConvertRecipeToDatagrid zeigt alle Member des übergebenen Rezeptes in einem Datagrid an. Die Funktion wird beim Selektionswechsel in der Combobox an das SrcData-Attribut des Datagrids übergeben, um das neu selektierte Rezept zu laden.
Parameter:
Name | Typ | Beschreibung |
|---|---|---|
recipeReference | tchmi:framework#/definitions/RecipeReference | Die Referenz zu dem Rezept, welches angezeigt werden soll. |
Rückgabewert:
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
Der Datensatz für das Datagrid wird dem Context-Objekt übergeben.
DeleteRecipe
Die Funktion DeleteRecipe löscht ein übergebenes Rezept.
Parameter:
Name | Typ | Beschreibung |
|---|---|---|
recipeReference | tchmi:framework#/definitions/RecipeReference | Die Referenz zu dem Rezept, welches gelöscht werden soll. |
Rückgabewert:
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
DownloadRecipe
Die Funktion Download ermöglicht den Download eines übergebenen Rezeptes als JSON-Datei. Diese kann anschließend über die Funktion UploadRecipe importiert werden.
Parameter:
Name | Typ | Beschreibung |
|---|---|---|
recipeReference | tchmi:framework#/definitions/RecipeReference | Die Referenz zu dem Rezept, welches downloadet werden soll. |
Rückgabewert:
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
 | Die Upload- und Download-Funktion stehen nicht im LiveView in Visual Studio zur Verfügung. |
ListRecipeAsReferenceArray
Die Funktion ListRecipeAsReferenceArray erstellt ein Array aus allen verfügbaren Rezepten, welches für die Auswahl in der Combobox benötigt wird. Die Funktion wird auf dem SrcData-Attribut der Combobox verwendet.
Parameter:
Name | Typ | Beschreibung |
|---|---|---|
recipeList | tchmi:server#/definitions/folderRecipe | Die Referenz zu allen Rezepten. Die Liste aller Rezepte ist das Symbol „recipeList“ in der RecipeManagement-Extension. |
Rückgabewert:
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
Der Datensatz für die Combobox wird dem Context-Objekt übergeben.
UpdateDatagridFromTarget
Die Funktion UpdateDatagridFromTarget listet die aktuellen Online-Werte der Rezept-Member des übergebenen Rezeptes im Datagrid unter der Spalte „New value“ auf. Die Funktion wird beim Klick auf den Button Read values from target ausgeführt.
Parameter:
Name | Typ | Beschreibung |
|---|---|---|
datagridControl | tchmi:framework#/definitions/Control | Das TcHmiDatagrid, in welchem die Online-Werte in der Spalte „New value“ angezeigt werden sollen. |
recipeReference | tchmi:framework#/definitions/RecipeReference | Die Referenz zu dem Rezept, welches im Datagrid angezeigt werden soll. |
Rückgabewert:
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
UploadRecipe
Die Funktion UploadRecipe lädt ein Rezept aus einer JSON-Datei in die Rezeptverwaltung. Mit dieser Funktion können Rezepte, die mit der Funktion DownloadRecipe exportiert wurden, importiert werden.
Parameter:
Name | Typ | Beschreibung |
|---|---|---|
- | - | - |
Das Rezept in Form der JSON-Datei wird direkt über den Dateibrowser im Browser ausgewählt.
Rückgabewert:
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
| Die Upload- und Download-Funktion stehen nicht im LiveView in Visual Studio zur Verfügung. |