Formelzeitreihen

Der Zeitreihenmanager unterstützt formelbasierte Zeitreihen. Diese Formeln unterstützen sämtliche Funktionen des Microsoft .Net Frameworks in VB.Net Notation. Zusätzlich können benutzerdefinierte Funktionen in VB.Net erstellt und verwendet werden.

Das Editieren der Formel bzw. Aufrufen der Funktionen erfolgt in der Bearbeiten Maske für Zeitreihen, die man über die Suche -> Reiter Bearbeiten erreicht.

Um eine Hilfe zu erhalten welche Funktionen zur Verfügung stehen dient die Tastenkombination STRG + Leerzeichen wenn sich der Cursor im Formel-Textfeld befindet.

Überblick Formelzeitreihen

Formelzeitreihen werden durch die zugrundeliegende Formel festgelegt. Diese spiegelt die Berechnungsvorschrift wider.

Die Zeitreihendefinition einer Formelzeitreihe wird gleich jeder anderen Zeitreihe in der Datenbank gespeichert und enthält zusätzlich eine Formel.

Änderungen an der Zeitreihendefinition führen zu einem Archiveintrag mit entsprechendem Zeitstempel in der Datenbank, um die Revisionssicherheit zu gewähren und auf historisierte Ergebnisse zurückgreifen zu können.

Beim Auslesen der Zeitreihe wird diese entsprechend der Formel berechnet und das Ergebnis bereitgestellt.

Über die Formel können Berechnungsvorschriften auf Basis anderer Zeitreihen abgebildet werden. Zeitreihen oder Zahlen können mittels Grundrechnungsarten und Funktionen (+, -, *, /) mit weiteren Zahlen oder Zeitreihen berechnet werden.

Des Weiteren sind kundenspezifische Funktionen implementierbar.

Formelsyntax

Formeln werden in Textform verwaltet. Die Formel wird zur Laufzeit des Auslesens der Zeitreihe vom HAKOM Framework kompiliert und berechnet.

Die Syntax ist ident zu der in VB.Net verwendeten. Es können auch sämtliche Funktionen vom Math Namespace verwendet werden: http://msdn.microsoft.com/de-de/library/system.math_members.aspx

Operatoren

Formeln unterstützen die folgenden Operatoren:

Ebenfalls werden folgende Vergleichsoperatoren unterstützt:

z.B. 3 + 5 * 2 führt dazu, dass die Zeitreihe immer den Wert 13 annimmt.

Es können auch Klammern gesetzt werden:
z.B.: (3 + 5) * 2 führt dazu, dass die Zeitreihe immer den Wert 16 annimmt.

Zeitreihen einbeziehen

Zeitreihen können nach folgendem Muster in eine Formel einbezogen werden:

[Zeitreihe (Name oder ID), Offset (Optional), Einheit (Optional), Aggregation (Optional)]

Mit der Verwendung der Zeitreihen in Formeln mittels eckigen Klammern wird ein Data-Element übergeben. Dieses beinhaltet neben den Werten ([8765].Value) der Zeitreihe auch den Status ([8765].Flag) der Werte, das Von und Bis-Datum ([8765].fromDate und [8765].toDate) und der Index der Zeitreihe ([8765].Index).

Für alle unter dem Punkt "Operatoren" erwähnten Operatoren gilt:

• Vergleich/Berechnung einer referenzierten Zeitreihe mit einer weiteren Zeitreihe liefert als Ergebnis ebenfalls ein Data-Element.
• Vergleich/Berechnung einer referenzierten Zeitreihe mit einem Integer-Wert liefert als Ergebnis ein Data-Element.
• Vergleich/Berechnung einer referenzierten Zeitreihe mit einem Double-Wert liefert als Ergebnis ein Data-Element.
• Wird statt der Zeitreihen-ID direkt mit den Werten der Zeitreihe gerechnet (also [Zeitreihen-ID].Value anstatt [Zeitreihen-ID]), liefert dies als Ergebnis einen Double-Wert.

Beispiele

Beispiel 1:

Hier wird nur die ID einer Zeitreihe übergeben:

[4711]

Die Formelzeitreihe nimmt beim Auslesen nun dieselben Daten wie die Zeitreihe 4711 an.

Beispiel 2:

Hier werden die ID einer Zeitreihe und ein Offset übergeben:

Lead([4711, 2], 2)

Die Formelzeitreihe nimmt beim Laden die Daten der Zeitreihe 4711 an, zusätzlich werden die Daten 2 Intervallschritte vor dem Rasterbeginn der Formelzeitreihe und 2 Intervallschritte nach dem Rasterende der Formelzeitreihe geladen. Die Funktion "Lead" verschiebt die Daten um zwei Rasterschritte, was durch die zusätzlich geladenen Daten außerhalb der "von" und "bis" Daten ermöglicht wird.

Beispiel 3:

Hier werden die ID einer Zeitreihe, ein Offset und eine Einheit übergeben:

[4711, 0, kW]

Die Formelzeitreihe nimmt beim Auslesen die Daten der Zeitreihe 4711 konvertiert in kW an.

Beispiel 4:

Hier werden die ID einer Zeitreihe, ein Offset, eine Einheit und eine Aggregation übergeben:

[4711, 0, "", Sum]

Die Formelzeitreihe nimmt beim Auslesen die Daten der Zeitreihe 4711 an. Werden Daten aggregiert (weil sich z.B. die Intervalle der Zeitreihen unterscheiden), wird entsprechend der Aggregationsregel "Sum" die Summe der Daten gebildet.

Beispiel 5:

Hier werden Zeitreihen mittels der unterstützten Operatoren miteinander verknüpft:

[4711]*3+[123]+0.22

Die Formelzeitreihe nimmt hier den Wert der Zeitreihe 4711 multipliziert mit drei und addiert mit dem Wert der Zeitreihe 123 und dem Wert 0,22 an.

Wird ein Zeitreihenname in den Formel-Editor eingetragen, wird dieser automatisch in die Zeitreihen-ID verwandelt. Dadurch soll sichergestellt werden, dass keine Probleme entstehen, wenn der Name der referenzierten Zeitreihe geändert wird. Wenn der Anzeigemodus auf "Zeitreihen-Name" geändert wird, werden die verwendeten Zeitreihen mit ihren Namen angezeigt. In diesem Modus ist es nicht möglich die Formel zu bearbeiten.

Spezifikation Formelzeitreihen

Raster

Formelzeitreihen werden im Raster der angelegten Formelzeitreihe berechnet. Dies bedeutet, dass in Formeln verwendete Zeitreihen, für die Berechnung, im Raster der Formelzeitreihe abgefragt werden.

Beispiel: Bewerten von Lastprofilen mit Lastprofil im Stunden- und Preiszeitreihe im Halbstundenraster für Stunden- und Tageswerte:

Szenario 1 - Formelzeitreihe im Stundenraster

Berechnung: Lastprofil (Stundenraster) * Preiszeitreihe (auf Stundenraster gemittelt)

Ergebnis: Formelzeitreihe im Stundenraster

Szenario 2 – Eine Formelzeitreihe im Tagesraster

Berechnung: Lastprofil (auf Tagesraster gemittelt) * Preiszeitreihe (auf Tagesraster gemittelt)

Ergebnis: Formelzeitreihe im Tagesraster

->  Dies bedeutet das falsche Ergebnis, da nur die Tagesdurchschnittswerte berechnet werden

Szenario 3 – Eine Formelzeitreihe im Stundenraster, als Tagesraster auslesen

Berechnung: Lastprofil (auf Stundenraster gemittelt) * Preiszeitreihe (auf Stundenraster gemittelt)

Zwischenergebnis: Formelzeitreihe im Stundenraster

Ergebnis: Formelzeitreihe ausgelesen als Tagesraster

->  Hier ist das Ergebnis richtig, da der Tageswert der Formelzeitreihe aus den aufsummierten Stundenwerten besteht.

Einheiten

Es besteht die Möglichkeit eine Einheit in der Formel der Zeitreihe angeben zu können.
Z.B.: [530379,-3,KW,Average] wandelt die Daten der Zeitreihe 530379 von ursprünglichen MW in KW um, verschiebt die Zeitreihe um -3 Intervalle und errechnet dabei den Durchschnitt, der über den Raster der Formelzeitreihe mit den Werten der Zeitreihe 530379 gebildet wird.

Dabei muss darauf geachtet werden, dass die Umrechnungen der Einheiten auch plausibel gewählt werden (Es ist nicht möglich eine Zeitreihe mit der Einheit MW in Euro oder Prozent umzuwandeln.).

Funktionen in EvalComponent

Im BIN Verzeichnis des Zeitreihenmanagers liegen mehrere .VB Dateien deren Namen mit  EvalComponent beginnen. In diesen befinden sich Funktionen die im Formeleditor aufgerufen werden können. Sie sind in .Net Syntax hinterlegt.

Formeln, die als Public Function in den EvalComponent Funktionen angelegt werden, werden mit dem Intellisense im Zeitreihenmanager Formeleditorfenster angezeigt. Um eine Auswahl aller Public Functions zu erhalten muss die „Space“ Taste gedrückt werden.

Hier ein einfaches Beispiel in EvalComponents:

Public Function Wenn(ByVal a As Boolean, ByVal b As Double, ByVal c As Double) As Double
   If a Then Return b Else Return c
End Function

Aufruf dieser Formel im Zeitreihenmanager:

Hier wird beim Aufruf der Formel durch die Operatoren <> verglichen ob der Wert der Zeitreihe [12] ungleich 0 ist. Das Ergebnis ist ein Boolean Wert (True / False), anhand dessen die Funktion entscheidet ob Sie bei True den Wert aus der Zeitreihe [11] liefert, oder bei False den Wert „100“ zurückgibt.

Standardfunktionen

Die Zeitreihenmanager-Installation enthält die EvalComponentHAKOM Dateien, sie enthalten die Standardfunktionen die von Hakom mit ausgeliefert werden.

*Diesen Funktionen kann anstelle eines Data-Types ein Integer übergeben werden. Bsp.: Statt Lag([123]) ist es möglich Lag([123].Index) anzugeben.

Beispiele

Für die nachfolgenden Beispiele gelten folgende Definitionen:

Es gibt vier Versionen von "ConstandMaturity_Daten": Am 01.01.2020 viertelstündlich zwischen 06:00:00 und 06:45:00.

Das Raster von beider Zeitreihen ist eine Viertelstunde.

Beispiel 1: Die ConstantMaturity Funktion

ConstantMaturity([ConstandMaturity_Daten],0)

Wie kommen die Werte für "ConstantMaturity_Formel" zustande?

Die Funktion überprüft, ob für den aktuellen Rastereintrag eine Version der übergebenen Zeitreihe existiert. Für 06:00-06:15 wird also überprüft, ob es von "ConstantMaturity_Daten" eine Version von 01.01.2019 06:00 existiert. Da dies der Fall ist, wird der Parameter "maturity", der einen Shift darstellt, auf diese Version angewandt. Da dieser in diesem Beispiel = 0 ist, wird nicht geshiftet und der Wert der Version von 06:00-06:15 übernommen.

Danach wird für den nächsten Rastereintrag (06:15-06:30) wieder überprüft, ob es eine Version für diesen Zeitpunkt gibt. Das ist der Fall und es wird der Wert der entsprechenden Version für diesen Rastereintrag übernommen.

Ab 07:00 gibt es keine Version mehr von "ConstantMaturity_Daten"und die Werte sind daher = 0, missing.

Beispiel 2: Die ConstantMaturity Funktion mit Verschiebung

ConstantMaturity([ConstantMaturity_Daten],4)

Die Werte der Formelzeitreihe werden hier wie in Beispiel 1 ermittelt. Einzig der Parameter "maturity" unterscheidet sich. Das hat folgende Auswirkungen:

Es wird nun nicht mehr der Wert der Version zum Startzeitpunkt des aktuellen Rastereintrags übernommen. Stattdessen wird um die mit maturity übergebene Anzahl an Schritte innerhalb der Version geshiftet. In diesem Beispiel ist maturity = 4, daher wird für den Rastereintrag von 06:00-06:15 nicht der Wert dieses Rastereintrags der Version von 06:00 übernommen, sondern jener von 07:00-07:15, weil vier mal um eine Viertelstunde verschoben wurde.

Weil es keine Version vor jener von 06:00 gibt, bleibt der Wert der Formelzeitreihe von 06:00-07:00 = 0, missing.

Beispiel 3: Die ConstantMaturity Funktion mit Verschiebung um Rasterintervall

ConstantMaturity([ConstantMaturity_Daten],2,Components2016.TimeSeries.TimeSeriesInterval.Hour)

In diesem Beispiel wurde der Funktion zusätzlich ein Interval (Components2016.TimeSeries.TimeSeriesInterval) übergeben. Maturity ist nun = 2 und das Interval = Stunde. Daher werden die Werte der jeweiligen Rastereinträge den entsprechenden Versionen entnommen und um zwei Stunden verschoben.

Individuelle EvalComponents und Programmierung

Es ist möglich eigene EvalComponent-Dateien anzulegen. Die Verwaltung der individuellen Dateien sollte durch den Anwender erfolgen oder mit HAKOM abgestimmt werden, da es sonst möglich ist, dass bei Neuinstallationen diese speziellen Dateien nicht mitinstalliert werden. Im Installationspaket für den TSM können sie im Ordner Custom abgelegt werden, damit das Setup sie mit kopiert.

Anlegen und Syntax

Um eine eigene EvalComponent Datei anzulegen, erzeugt man im bin Verzeichnis der Zeitreihenmanagerinstallation zunächst eine .vb Datei. Der Dateiname muss mit EvalComponent beginnen.

z.B. EvalComponentMyFunctions.vb

Inhalt:

Imports System
Imports HAKOM.Framework.DAL
Imports HAKOM.Framework.Lib
Imports HAKOM.Framework.TimeSeries
Imports System.Collections.Generic
Imports System.Data

Partial Public Class EvalComponent

'eigene Funktionen
     
End Class

Achtung: Selbst erstellte EvalComponents dürfen niemals in die von HAKOM standardmäßig ausgelieferten EvalComponent.vb-Dateien (EvalComponentHAKOM.vb, EvalComponentHAKOMOptional.vb, EvalComponentHAKOMReferences.vb) geschrieben werden!

Value und Index Funktionen

Es gibt zwei Möglichkeiten Zeitreihenwerte beim Aufrufen einer Funktion anzuwenden:

Value

Der Wert can in folgendem Beispiel direkt angewendet werden:

Add2(ByVal value Double) As Double

Der Aufruf wäre hier: Add2([1234])

In der EvalComponent würde die Funktion folgendermaßen aussehen:

Private Function Add2(ByVal value As Double) As Double
      Return value + 2
End Function

Index

Es besteht aber auch die Möglichkeit, den Index eines Wertes anzuwenden. In diesem Fall wird nicht der Wert selbst angewendet, sondern die Position des Werts ausgehend vom aktuellen Interval. Dies kann zum Beispiel nötig sein, wenn mit einem Offset gearbeitet wird:

Add2(ByVal index As Integer) As Double

Der Aufruf wäre hier: Add2([1234].Index)

In der EvalComponent würde die Funktion folgendermaßen aussehen:

Private Function Add2(ByVal index As Integer) As Double
      Return mSourceTSData(index)(aktLine).Value + 2
End Function

Variablen

Assembly Cache

Der Assembly Cache kann genutzt werden, um das Aufrufen von Funktionen in EvalComponents zu beschleunigen.

Die Funktionen in EvalComponent*.vb-Dateien werden für jeden Aufruf temporär in DLL-Dateien übersetzt. Um dabei Zeit zu sparen, kann folgender Eintrag in der HAKOM.Config hinzugefügt werden:

<HAKOMFramework>
    <settings>
		<AssemblyCache>
			%ALLUSERSPROFILE%\HAKOM\TimeSeriesManager\AssemblyCache
		</AssemblyCache>
    </settings>
</HAKOMFramework>

Der Pfad, unter dem die sonst temporären DLLs gespeichert werden würden kann innerhalb des Tags <AssemblyCache> angegeben werden. Wurde die EvalComponent bzw. die Formel nicht geändert, wird die DLL beim nächsten Aufruf der Formel wiederverwendet.