weisang.com > Dokumentation > NextTimePeriod (FPScript)

FlexPro-Dokumentation

NextTimePeriod (FPScript)

21.09.2021

Sucht in einem Datensatz mit Kalenderzeitwerten nach dem nächsten Wert, der in einem periodischen Zeitausschnitt liegt.

Syntax

NextTimePeriod(DataSet, Criterion, [ Position ], LowerBound, UpperBound [ , Direction = EVENT_RIGHT ])

Die Syntax der NextTimePeriod-Funktion besteht aus folgenden Teilen:

Teil

Beschreibung

DataSet

Der Datensatz mit Kalenderzeitwerten, in dem nach Perioden gesucht werden soll.

Erlaubte Datenstrukturen sind Datenreihe, Signal und Signalreihe. Es sind alle numerischen Datentypen erlaubt.

Ist das Argument eine Liste, dann wird die Funktion für jedes Element der Liste ausgeführt und das Ergebnis ist ebenfalls eine Liste.

Criterion

Gibt an, welches Datumselement der Suche zugrunde gelegt werden soll.

Das Argument Criterion kann folgende Werte haben:

Konstante	Bedeutung
SECOND	Sekunde in der Minute (0.0 bis 59.9999)
MINUTE	Minute in der Stunde (0.0 bis 59.9999)
HOUR	Stunde des Tages (0.0 bis 23.9999)
DAY	Tag des Monats (1 bis 31)
WEEKDAY	Wochentag (0 für Sonntag bis 6 für Samstag, statt Zahlenwerten können Sie auch die Konstanten SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY und SATURDAY verwenden)
MONTH	Monat des Jahres (1 bis 12)
YEAR	Jahr (1970 bis 3000)
DAYOFYEAR	Jahrestag (1 bis 366)

Ist das Argument eine Liste, dann wird deren erstes Element entnommen. Ist dies wieder eine Liste, dann wird der Vorgang wiederholt.

Position

Wenn Sie in einem Signal suchen, ist dies der X-Wert, ab dem gesucht werden soll. Der Wert selbst wird in die Suche nicht eingeschlossen. Wenn Sie in einer Datenreihe suchen, dann ist dies der Index des Wertes, ab dem gesucht werden soll. Der Index selbst wird in die Suche nicht eingeschlossen. Ein negativer Index bestimmt hierbei eine Position relativ zum Ende des Datensatzes. Wenn Sie das Argument weglassen oder den Wert Empty übergeben, beginnt die Suche je, nach Suchrichtung, am Anfang oder am Ende des Datensatzes. Der erste bzw. letzte Wert des Datensatzes wird nur berücksichtigt, wenn Sie das Argument weglassen oder den Wert Empty übergeben.

Erlaubte Datenstrukturen sind Einzelwert. Es sind alle numerischen Datentypen erlaubt. Die Einheit muss mit der von Parameter DataSet kompatibel sein.

Bei komplexen Datentypen erfolgt eine Betragsbildung.

Ist das Argument eine Liste, dann wird die Funktion für jedes Element der Liste ausgeführt und das Ergebnis ist ebenfalls eine Liste.

LowerBound

Gibt die Untergrenze des Zeitausschnittes an. Wenn Sie einen Wert mit Einheit angeben, muss diese zum gewählten Datumselement passen.

Erlaubte Datenstrukturen sind Einzelwert. Es sind alle reellen Datentypen erlaubt.

Ist das Argument eine Liste, dann wird die Funktion für jedes Element der Liste ausgeführt und das Ergebnis ist ebenfalls eine Liste.

UpperBound

Gibt die Obergrenze des Zeitausschnittes an. Wenn Sie einen Wert mit Einheit angeben, muss diese zum gewählten Datumselement passen.

Erlaubte Datenstrukturen sind Einzelwert. Es sind alle reellen Datentypen erlaubt.

Ist das Argument eine Liste, dann wird die Funktion für jedes Element der Liste ausgeführt und das Ergebnis ist ebenfalls eine Liste.

Direction

Legt die Suchrichtung der Funktion fest.

Das Argument Direction kann folgende Werte haben:

Konstante	Bedeutung
EVENT_RIGHT	Nach rechts suchen.
EVENT_LEFT	Nach links suchen.

Ist das Argument eine Liste, dann wird deren erstes Element entnommen. Ist dies wieder eine Liste, dann wird der Vorgang wiederholt.

Wenn das Argument nicht angegeben wird, wird es auf den Vorgabewert EVENT_RIGHT gesetzt.

Anmerkungen

Das Ergebnis ist immer vom Datentyp Kalenderzeit.

Bei Signalen und Signalreihen wird die X-Komponente durchsucht.

Für den Fall, dass LowerBound kleiner oder gleich UpperBound ist, liegt ein Wert im Intervall, wenn er größer oder gleich LowerBoundund kleiner oder gleich UpperBound ist. Wird LowerBound größer als UpperBound angegeben, dann liegt ein Wert im Intervall, wenn er größer oder gleich LowerBoundoder kleiner oder gleich UpperBound ist. Dies entspricht annähernd eine Komplementbildung.

Für die Datumselemente SECOND, MINUTE und HOUR können Sie die Intervallgrenzen als Fließkommazahl angeben.

Verfügbarkeit

FlexPro Basic, Professional, Developer Suite

Beispiele

NextTimePeriod(TimeSignal, SECOND, , 3.5, 12.3)	Liefert den Index des ersten Wertes des Signals 'TimeSignal' zurück, der im Intervall [3.5, 12.3] Sekunden in jeder Minute liegt.
TimeSignal[[NextTimePeriod(TimeSignal, SECOND, 5.5 s, 200 ms, 600 ms, EVENT_LEFT)]]	Sucht in dem Signal 'TimeSignal' ab der Position X = 5.5 s nach links den nächsten Wert, der im Intervall [0.2, 0.6] Sekunden in jeder Minute liegt. Das Ergebnis ist der Y-Wert an der gefundenen Stelle.