DelayedAlarm processes the alarm input and produces another alarm if the alarm in input remains steady active for a given amount of time. In the same way, the produced alarm is cleared if the input stays steady cleared for a given amount of time.
There is no default value for the delays: if they are not provided the TF will throw an exception.
The actual implementation of the TF does not allow a ASCE to run a TF at a given time rate or after a delay elapsed. This method does its best but will not be precise. Issue #84 of the IAS core is about this problem. The best way to get the alarm close to the required time frame is to tune the refresh rate of the Supervisor where this TF is executed.
Value parameters
cEleId:
the ID of the ASCE
cEleRunningId:
the runningID of the ASCE
props:
the user defined properties
validityTimeFrame:
The time frame (msec) to invalidate monitor points
This method transparently returns a value from the passed ID and instance.
This method transparently returns a value from the passed ID and instance.
When an input is not templated, neither a template instance, then its value cabn be directly retrieved from the map of the inputs passed to [#eval]. But if the imput is templated or a templated instance then this method must be used.
If the ASCE is generated out of a template, its inputs can or cannot be generated out of the same template. In the latter, their identifiers must be enriched with the number of the instance of the ASCE. For templated inputs the number of the instance is not needed because it is the same instance number of the ASCE and it is known to the transfer function. The case of templated input instances is different because their instance number is defined in the configuration of the ASCE and not known in the transfer function so it must be esplicity passed by the caller.
For normal and templated inputs, the instance is empty. For templated inputs the instance can be passed if it is teh same of the ASCE. For templated input instances the instance number is required.
This method must be used also to get templated input instances from non templated ASCEs.
Value parameters
id
The (non templated) identifier of the value
inputs
the map of the inputs
instance
the optional instance nummber for templated input instances, not required for other cases
Attributes
Returns
the IASValue of the given ID, or None if not found in the Map