FB_ALY_SankeyDiagram

Der Baustein Sankey Diagram kann verwendet werden, um ein Sankey Diagramm zur späteren Verwendung im HMI Dashboard zu erstellen. Es wird zwischen Zu- und Abflüssen unterschieden. Die Anzahl von Zu- und Abflüssen kann jeweils individuell über die Parameter Num Channels Inflow und Num Channels Outflow parametriert werden.

Da die Funktion dieses Bausteins für die Analyse selbst irrelevant ist, zählt er zur Kategorie Visualization Only.

Syntax

Definition:

FUNCTION_BLOCK FB_ALY_StateHistogram_1Ch
VAR_OUTPUT
    ipResultMessage: Tc3_EventLogger.I_TcMessage;
    bError: BOOL;
    bNewResult: BOOL;
    bConfigured: BOOL;
    fRest: LREAL;
END_VAR

Ausgänge

Name	Typ	Beschreibung
ipResultMessage	I_TcMessage	Beinhaltet nähere Informationen zum aktuellen Rückgabewert. Für diesen speziellen Schnittstellenzeiger ist intern sichergestellt, dass er immer gültig/zugewiesen ist.
bError	BOOL	Der Ausgang ist `TRUE`, wenn ein Fehler auftritt.
bNewResult	BOOL	Wenn ein neues Ergebnis berechnet wurde, ist der Ausgang `TRUE.`
bConfigured	BOOL	Zeigt `TRUE` an, wenn der Baustein erfolgreich konfiguriert ist.
fRest	LREAL	Restwert (Inflow – Outflow) in Prozent.

Methoden

Name	Definitionsort	Beschreibung
Call()	Local	Methode zur Berechnung der Ausgänge für eine bestimmte Konfiguration.
Configure()	Local	Allgemeine Konfiguration des Algorithmus mit seinen parametrisierten Bedingungen.
ConfigureInflowChannel()	Local	Konfiguration der Inflow-Kanäle.
ConfigureOutflowChannel()	Local	Konfiguration der Outflow-Kanäle.
FB_Init	Local	Initialisieren der Anzahl an Inflow- und Outflow-Kanäle.
GetGetInflowChannelOutputValue()	Local	Abrufen des Ergebnis-Werts aus dem Inflow-Ergebnis-Array, ohne neue Werte hinzuzufügen.
GetGetInflowOutputArray()	Local	Abrufen des Inflow-Ergebnis-Arrays, ohne neue Werte hinzuzufügen.
GetGetOutflowChannelOutputValue()	Local	Abrufen des Ergebnis-Werts aus dem Outflow- Ergebnis-Array, ohne neue Werte hinzuzufügen.
GetGetOutflowOutputArray ()	Local	Abrufen des Outflow-Ergebnis-Arrays, ohne neue Werte hinzuzufügen.
Reset()	Local	Setzt alle internen Zustände oder die bisher durchgeführten Berechnungen zurück.
SetInflowChannelValue()	Local	Methode zur Übergabe von Inflow-Werten an den Algorithmus.
SetOutflowChannelValue()	Local	Methode zur Übergabe von Outflow-Werten an den Algorithmus.

Beispiel

VAR
    fbSankeyDiagram : FB_ALY_SankeyDiagram(nNumChannelsInflow := 2, nNumChannelsOutflow := 3);
    aChannelNamesInflow : ARRAY [1..2] OF STRING(255) := ['Grid', 'PV'];
    aChannelNamesOutflow : ARRAY [1..3] OF STRING(255) := ['HVAC', 'Server', 'Lights'];
    sChannelNameRest : STRING(255) := 'Rest';

    bConfigure : BOOL := TRUE;
    fInflowGrid : LREAL;
    fInflowPV: LREAL;
    fOutflowHVAC: LREAL;
    fOutflowServer: LREAL;
    fOutflowLights: LREAL;

    aInflow : ARRAY[1..2] OF LREAL;
    aOutflow : ARRAY[1..3] OF LREAL;
END_VAR

// Configure algorithm
IF bConfigure THEN
    bConfigure := FALSE;

    fbSankeyDiagram.ConfigureInflowChannel(1, aChannelNamesInflow[1]);
    fbSankeyDiagram.ConfigureInflowChannel(2, aChannelNamesInflow[2]);
    fbSankeyDiagram.ConfigureOutflowChannel(1, aChannelNamesOutflow[1]);
    fbSankeyDiagram.ConfigureOutflowChannel(2, aChannelNamesOutflow[2]);
    fbSankeyDiagram.ConfigureOutflowChannel(3, aChannelNamesOutflow[3]);
    fbSankeyDiagram.Configure(sChannelNameRest);
END_IF

// Call algorithm
fbSankeyDiagram.SetInflowChannelValue(1, fInflowGrid);
fbSankeyDiagram.SetInflowChannelValue(2, fInflowPV);
fbSankeyDiagram.SetOutflowChannelValue(1, fOutflowHVAC);
fbSankeyDiagram.SetOutflowChannelValue(2, fOutflowServer);
fbSankeyDiagram.SetOutflowChannelValue(3, fOutflowLights);
fbSankeyDiagram.Call();
fbSankeyDiagram.GetInflowOutputArray(ADR(aInflow), SIZEOF(aInflow));
fbSankeyDiagram.GetOutflowOutputArray(ADR(aOutflow), SIZEOF(aOutflow));

Voraussetzungen

Entwicklungsumgebung	Zielplattform	Einzubindende SPS-Bibliotheken
TwinCAT v3.1.4024.0	PC oder CX (x64, x86)	Tc3_Analytics

Weiterführende Informationen