Analytics Builder 10.15.0 | Using Analytics Builder for Cumulocity IoT | Block Reference | Flow Manipulation | Gate
 
Gate
apama.analyticskit.blocks.core.Gate
Blocks the input from going to output unless the gate is open and enabled.
The block will start disabled if the Enable input is connected, otherwise the block will always be enabled. The block will start closed if the Open input is connected, otherwise the block will start open.
Parameters
Name
Description
Type
Notes
Null Value
The value to use as output value when the gate is either disabled or closed.
The exact type of the value depends on the Null Value Type parameter. If the Null Value Type parameter is specified then the string value is parsed as the specified type. If the Null Value Type parameter is not specified, and the value is parsable into a float or a boolean value then it is parsed into the corresponding value type, otherwise it is used as a string value.
string
Optional
Null Value Type
The type of the value specified by the Null Value parameter. If specified, the null value is parsed into the specified type.
Option - one of:
*Float
*Boolean
*String
Optional
Close Duration (secs)
The amount of time (in seconds) the gate should be closed when a close signal is received.
If the parameter is not specified, then after a close signal is received, the gate remains closed until an open signal is received. If the parameter is specified, then the gate automatically opens after the specified number of seconds, unless another open or close signal is received before the time has elapsed. On opening, if the gate is also enabled, then the latest input value is sent out as output.
This must be a finite and positive number.
float
Optional
Input Port Details
Name
Description
Type
Value
The value to pass to output.
any
Enable
Enables the gate. If the gate is always to be enabled, then leave this port unconnected.
boolean
Open
Opens the gate. If the gate is to be open at the start, then leave this port unconnected.
pulse
Close
Closes the gate. If the Close Duration parameter is specified, then the gate is closed only for the specified number of seconds.
pulse
Output Port Details
Name
Description
Type
Gated Value
Same as the input value when the gate is open and enabled. Otherwise the value specified by the Null Value parameter.
input(value)
Activated
Output pulse. Generated when the gate becomes active. The gate is active when it is both open and enabled.
pulse
Deactivated
Output pulse. Generated when the gate becomes inactive. The gate is inactive when it is either closed or disabled.
pulse