DataOrder (FPScript)
Determines the data order of a data set or of its X component.
Syntax
DataOrder(DataSet)
The syntax of the DataOrder function consists of the following parts:
Part |
Description |
|---|---|
DataSet |
The data set for which the data order is determined. All data structures are allowed. Not supported data types arestring. |
Remarks
For signals, signal series and space curves, only the X component is analyzed. For two-dimensional data sets, the criterion is output that applies to all columns in the data matrix. Void values in the data set are ignored, i.e. the result corresponds to the value obtained when all void values are removed before the function call. If the data set determines a constant increment, then you can determine this increment using the Increment function.
If an argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.
For complex data types the absolute value is formed.
The function returns one of the following values:
Constant |
Meaning |
|---|---|
DATAORDER_NONE |
The data set is a scalar value, or the values in the data set are not in any particular order. |
DATAORDER_INDEFINITE |
The data set contains no values or only one value. |
DATAORDER_CONSTANT |
The data set contains at least two values, and all values are identical. |
DATAORDER_INCREASING |
The data set contains at least two values, and each value in the data set is larger than or the same as its predecessor. |
DATAORDER_DECREASING |
The data set contains at least two values, and each value in the data set is smaller than or the same as its predecessor. |
DATAORDER_STRICTLYINCREASING |
The data set contains at least two values, and each value in the data set is larger than its predecessor. |
DATAORDER_STRICTLYDECREASING |
The data set contains at least two values, and each value in the data set is smaller than its predecessor. |
Available in
FlexPro View, Basic, Professional, Developer Suite
Examples
DataOrder({1}) |
Results in DATAORDER_INDEFINITE. |
DataOrder(5) |
Results in DATAORDER_INDEFINITE. |
DataOrder({1, 1}) |
Results in DATAORDER_CONSTANT. |
DataOrder({1, 3, 4}) |
Results in DATAORDER_STRICTLYINCREASING. |
DataOrder({1, ?, 4}) |
Results in DATAORDER_STRICTLYINCREASING. |
DataOrder({1, 2, 2, 4}) |
Results in DATAORDER_INCREASING. |
DataOrder({1, 2, 1, 4}) |
Results in DATAORDER_NONE. |
DataOrder(Signal) |
Checks the data order of a signal's X component. |