OrAlarm transfer function takes n alarms in input and returns another alarm that is set if at least one of the alarms in input is set (OR).
Note that this TF can be replaced by the Multiplicty TF with the "threshold" property set to 1.
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
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Attributes
- See also
-
ScalaTransferExecutor#eval
The mode of the ouptut depends on the modes of the inputs: it is UNKNOW if the modes of the inputs differ, otherwise it is the common operational mode of the inputs.
The mode of the ouptut depends on the modes of the inputs: it is UNKNOW if the modes of the inputs differ, otherwise it is the common operational mode of the inputs.
Value parameters
- modes
-
the operational modes of the inputs
Attributes
- Returns
-
the mode to assign to the output
Get and return the properties of the output by the properties of the inputs
Get and return the properties of the output by the properties of the inputs
Value parameters
- props
-
the properties of the inputs that are set
Attributes
- Returns
-
the properties to assign to the ouput
Check that all the inputs and the output are alarms
Check that all the inputs and the output are alarms
Value parameters
- inputsInfo
-
The IDs and types of the inputs
- outputInfo
-
The Id and type of thr output
Attributes
- Definition Classes
Attributes
- See also
-
TransferExecutor#shutdown()
Inherited methods
Value parameters
- id
-
the id to translate, templated or not
Attributes
- Returns
-
teh identifer translated if the ASCE is templated
- Inherited from:
- ScalaTransferExecutor
Attributes
- Inherited from:
- TransferExecutor
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
- Inherited from:
- ScalaTransferExecutor
Attributes
- Inherited from:
- TransferExecutor
Attributes
- Inherited from:
- TransferExecutor
Concrete fields
If set the logic is inverted
If set the logic is inverted
By default it is false because of the definition of java.lang.Boolean.getBoolean
Attributes
The priority of the alarm from the java property or the default if not defined
The priority of the alarm from the java property or the default if not defined