Analytics Builder 10.13.0 | Using Analytics Builder for Cumulocity IoT | Block Reference | Calculation | Range
 
Range
apama.analyticsbuilder.blocks.Range
Compares the input value against the defined lower and upper range values to detect whether the input is within or out of the range, or whether it crosses the range.
By default, the range includes the value for the lower range but excludes the value for the upper range. For example, if the lower range is 100 and the upper range is 200, then all values from 100 to 199 are within the range. 200 is considered to be out of the range.
A pulse is sent when the defined range is crossed. That is, when either the lower or upper range is crossed, or if the value goes from below the range to over the range (or vice versa) without ever being within the range.
Parameters
Name
Description
Type
Notes
Lower Range
The lower range value.
float
Optional
Include Lower Range
If selected, an input value equal to the lower range is considered to identify whether it is within or out of the range. If not selected, an input value equal to the lower range is not considered.
boolean
Default: true
Upper Range
The upper range value.
float
Optional
Exclude Upper Range
If selected, an input value equal to the upper range is not considered to identify whether it is within or out of the range. If not selected, such an input value is considered to identify whether it is within or out of the range.
boolean
Default: true
Input Port Details
Name
Description
Type
Value
The input value to validate against the defined range.
float
Reset
Resets the state of the block.
pulse
Output Port Details
Name
Description
Type
Out of Range
Is set to true when the input value is not within the defined range.
boolean
In Range
Is set to true when the input value is within the defined range.
boolean
Crossed
Sends a pulse when the range is crossed.
pulse