Compare revisions

Graziano Scalamera · Graziano Scalamera · Thomas Juerges · Graziano Scalamera · Graziano Scalamera · Graziano Scalamera
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
 image:
-        name: artefact.skatelescope.org/ska-tango-images-tango-dsconfig:1.5.5
+        name: harbor.skao.int/production/ska-tango-images-tango-dsconfig:1.5.5

 stages:
  - build
@@ -7,6 +7,8 @@ stages:

 build_job:
  stage: build
+  tags:
+    - docker
  before_script:
    - sudo apt update && sudo apt -y --no-install-recommends install build-essential cmake pkg-config libboost-thread-dev
  script:
@@ -21,6 +23,8 @@ build_job:

 test_load_job:
  stage: test
+  tags:
+    - docker
  before_script:
    - sudo apt update && sudo apt -y --no-install-recommends install libboost-thread-dev
  script:
@@ -38,7 +42,7 @@ test_load_job:
    - python ./test/check-alarm-conf.py --device=alarm/handler/01 --alarm="tag=test0;formula=(alarm/test/01/condition == 1);on_delay=0;off_delay=0;priority=high;shlvd_time=0;group=gr_test;message=Test alarm;url=;on_command=;off_command=;enabled=1"
  needs: ["build_job"]
  services:
-    - name: artefact.skatelescope.org/ska-tango-images-tango-db:10.4.16
+    - name: harbor.skao.int/production/ska-tango-images-tango-db:10.4.16
      alias: tangodb


--- a/.gitlab-ci.yml_multi_stage
+++ b/.gitlab-ci.yml_multi_stage
 image:
-  name: nexus.engageska-portugal.pt/ska-docker/tango-dsconfig
+  name: harbor.skao.int/production/ska-tango-images-tango-dsconfig:1.5.5

 # The following variables are automatically passed down to the tangodb container
 # as well as the tangodatabaseds container and available within each.
@@ -17,9 +17,9 @@ stages:
  - test

 services:
-  - name: nexus.engageska-portugal.pt/ska-docker/tango-db
+  - name: harbor.skao.int/production/ska-tango-images-tango-db
    alias: tangodb
-#  - name: nexus.engageska-portugal.pt/ska-docker/tango-cpp
+#  - name: harbor.skao.int/production/ska-tango-images-tango-cpp
 #    alias: tangodatabaseds
 #    entrypoint: ["/usr/local/bin/DataBaseds"]
 #    command: ["2","-ORBendPoint giop:tcp::10000"]
@@ -60,7 +60,7 @@ configure_and_run_job:
    expire_in: 1 week
  needs: ["build_job"]
  #services:
-  #  - name: nexus.engageska-portugal.pt/ska-docker/tango-db
+  #  - name: harbor.skao.int/production/ska-tango-images-tango-db
  #    alias: tangodb

 test_job:

--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -103,11 +103,19 @@ target_include_directories(alarm_handler
        "${PROJECT_BINARY_DIR}"
 	${Boost_INCLUDE_DIRS})

-set_target_properties(alarm_handler 
-    PROPERTIES 
+if(NOT (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang"))
+    set_target_properties(alarm_handler
+        PROPERTIES
        OUTPUT_NAME ${AH_NAME}
        LINK_FLAGS "-Wl,--no-undefined"
-        CXX_STANDARD 11)
+        CXX_STANDARD 17)
+else()
+    set_target_properties(alarm_handler
+        PROPERTIES
+        OUTPUT_NAME ${AH_NAME}
+        LINK_FLAGS ""
+        CXX_STANDARD 17)
+endif()

 if(DO_CLANG_TIDY)
    set_target_properties(alarm_handler 

--- a/README.md
+++ b/README.md
 # Alarm-handler
 Elettra alarm-handler Tango device

+## Documentation
+
+[Alarm-handler](docs/AlarmHandler.md)

 ## Building and Installation


--- a/docs/AlarmEcosystem.md
+++ b/docs/AlarmEcosystem.md
+# The Alarm Ecosystem
+
+There are several projects related to alarms, which can work together with AlarmHandlers.
+
+## AlarmNotify
+
+[alarm-notify](https://gitlab.elettra.eu/cs/ds/alarm-notify) connect to a list of alarm-handler devices and subscribes for the change event of their alarm attributes. It checks whether there are Recipients configured in individual alarms, or interested in alarms belonging to a group, or all alarms, then builds a list of recipients for each alarm state of each alarm.
+When an event is received, if there are recipients configured for the new alarm state, a command is triggered on a device for notification.
+A string parameter with a semicolon-separated list of “key=value” fields is passed to the notification command, with the following keys:
+```
+name=<_tag_>;handler=<AlarmHandler device>;values=<JSON attribute values>url=<_url_>;msg=<_msg_>;formula=<_formula_>;groups=<_groups_>;shlvd_time=<_shlvd_time_>;state=<Alarm state DevEnum label>;ack=<true|false>;time=<timestamp>;
+```
+
+See an example of configuration properties:
+
+![screenshot](images/alarm_notify_properties.png)
+
+## AlarmManager
+
+[alarm-manager](https://gitlab.elettra.eu/cs/ds/alarm-manager) is a Tango device server that supports the configuration of AlarmHandlers. AlarmHandlers are designed to be modular, so that different AlarmManagers can be configured to handle different groups/subsets of AlarmHandlers.
+AlarmManager can display the selected alarm configuration as attributes (_tag_, _formula_, _message_, _priority_, _group_, _shlvd_time_, _on_delay_, _off_delay_, _on_command_, _off_command_, _receivers_) or can Load/Modify alarms with the configuration provided in the attributes (_tag_, _formula_, _message_, ... same list as above)
+
+## AlarmMail
+
+[alarm-mail](https://gitlab.elettra.eu/cs/ds/alarm-mail) is a Tango device server  which exports commands able to send emails. Its commands can be configured in _on_command_ and _off_command_ properties (deprecated) or called by AlarmNotify.
+
+## AlarmHandlerGUI
+
+[alarm-handler-gui](https://gitlab.elettra.eu/cs/gui/alarm-ng) is the default AlarmHandler GUI at [Elettra](www.elettra.eu). It is designed to display different sets of AlarmHandlers. See:
+
+![screenshot](images/alarm_ng.png)
+
+The different lists of AlarmHandlers to use are taken from free properties. Same properties that can be used to configure AlarmManagers. See:
+
+![screenshot](images/free_properties.png)
+
+AlarmHandlerGUI is also able to display and search in alarm history stored by HDB++ (MySQL schema only). See:
+
+![screenshot](images/alarm_ng_history.png)
+
+## AlarmManagerGUI
+
+[alarm-manager-gui](https://gitlab.elettra.eu/cs/gui/alarm-manager) displays in a tree the list of alarms read from the AlarmManager's _alarmList_ attribute. When an alarm is selected in the tree, AlarmManager's _tag_ and _handler_ are written accordingly and all the other attributes contain the updated configuration, see:
+
+![screenshot](images/alarm_manager.png)
+
+This can then be modified or loaded as a new alarm if the _tag_ attribute has changed.
+
+## HDB++
+
+[EventSubscriber](https://gitlab.com/tango-controls/hdbpp/hdbpp-es) can be used to store alarm history: alarm are exported by the AlarmHandler interface as DevEnum attributes whose change and archive events are pushed in the code at any variation. The configuration of HDB++ is independent of the AlarmHandlers, but also AlarmManagerGUI can also do this.
+
+## PANIC
+
+[PANIC](https://gitlab.com/tango-controls/panic) is the Alarm System developed at [Alba](https://www.cells.es). Preliminary work has been done to support AlarmHandler as an alarm formula evaluation device for PANIC. Specifically, the _alarmSummary_ attribute, GetAlarmInfo command and alarm Devenum attributes are compatible between the two systems. PANIC should also be able of handle the configuation of AlarmHandlers in attribute properties, but the work has not yet been finalized.
+
+
+
+
--- a/docs/AlarmHandler.md
+++ b/docs/AlarmHandler.md
+# Alarm Handler
+
+AlarmHandler is a Tango device server which manage alarms in compliance with IEC 62682 standard. It evaluates the formulas that define the alarm condition and creates a dynamic attribute for each alarm rule to export the state of the alarm. Having the alarm state in the attributes enables asynchronous notification of clients interested in alarm changes, with the granularity of one alarm. In fact, each attribute representing an alarm can push events when its state changes. Clients can subscribe to events of the alarm attributes they are interested in, or the events of all attributes, and be notified asynchronously. Clients can be graphical user interfaces, notifiers, other AlarmHandlers or any TANGO device in general.
+The configuration of each alarm is saved in the Tango Database as attribute properties.
+
+## Configuration
+
+Configuration uses both device/class and attribute properties.
+
+### Device/Class properties
+
+Device properties are for configurations that apply to the entire device. The same properties can also be defined as Class properties, in which case they apply to all devices of the AlarmHandler Class in which the Device Property of the same name is not defined.
+
+| Name | Description | Type | Default Value |
+|------|-----|:-----:|:-----:|
+| GroupNames | Labels for Group mask, first is for mask 0x00 so ‘none’ is the default label associated to it. Second label is associated to the mask 0x1, third to the mask 0x2, ... <br>Only labels defined here can be used as group names in the alarm configuration. | String[] | none |
+| SubscribeRetryPeriod | Change event subscription period in seconds. Every time this period expires AlarmHandler tries to re-subscribe all faulty attributes | DevLong | 30 |
+| _StatisticsTimeWindow_ | **Not implemented** | DevLong[] | 60 |
+| ErrorDelay | Delay in seconds before going to ERROR state after receiving an exception. | DevULong | 30 |
+| SetAlarmQuality | Set the alarm attribute quality as evaluated using the attribute quality in the formula | DevBoolean | false |
+
+### Attribute properties
+
+The following attribute properties are used to store the configuration of alarms. They are present for each attribute that has the same name as the alarm name. Some of these properties are mandatory, others optional.
+
+| Name | Description | Mandatory | Default Value |
+|------|-----|:-----:|:-----:|
+| tag | Alarm name (same as the attribute name) | Yes |  |
+| formula | Alarm formula | Yes |  |
+| on_delay | Delay in seconds before the alarm becomes active after the formula result has changed from false to true | No | 0 |
+| off_delay | Delay in seconds before the alarm becomes inactive after the formula result has changed from true to false | No | 0 |
+| priority | Severity of the alarm. 'highest', 'high', 'medium', 'low', 'lowest','fault', 'warning' and 'log' are allowed | Yes |  |
+| silent_time | Time in minutes when the alarm will be silenced or shelved with the _Silence_ and _Shelve_ commands. If -1, the alarm cannot be silenced or shelved. | No | -1 |
+| group | One or more groups to which this alarm belongs. The possible groups are defined in the device property GroupNames. Multiple groups are specified by concatenating with the \| character | Yes |  |
+| message | Additional message carried with the alarm | Yes |  |
+| on_command | No | Command executed when the alarm becomes active. Command argin has to be DEV_VOID or DEV_STRING. In the second case the string _“name=...;groups=...;msg=…;values=…;formula=...”_ is passed as the argument | "" |
+| off_command | No | Command executed when the alarm becomes inactive. Command argin has to be DEV_VOID or DEV_STRING. In the second case the string _“name=...;groups=...;msg=…;values=…;formula=...”_ is passed as the argument | "" |
+| enabled | If true alarm is enabled, otherwise it is set to the OOSRV - out of service alarm state | No | 1 |
+| receivers | List of alarm states colon list of email recipients. Used only by [alarm-notify](https://gitlab.elettra.eu/cs/ds/alarm-notify) | No | "" |
+
+### Formula syntax
+
+See [Formula.md](./Formula.md).
+
+## Interface
+
+### Attributes
+
+#### Dynamic Attributes
+
+| Name | Attr. type | R/W type | Data type | Description |
+|------|:-----:|:-----:|:-----:|-----|
+| AlarmState | Scalar | READ |DEV_ENUM <br>Labels:  NORM, UNACK, ACKED, RTNUN, SHLVD, DSUPR, OOSRV, ERROR | Dynamically created with the tag name as the attribute name for each alarm |
+
+#### Static Attributes
+
+| Name | Attr. type | R/W type | Data type | Description |
+|------|:-----:|:-----:|:-----:|-----|
+| alarmAudible | Scalar | READ | DEV_BOOLEAN | True if there is at least one alarm that needs an audible indication on the GUI |
+| StatisticsResetTime | Scalar | READ | DEV_DOUBLE | Time elapsed in seconds since last ResetStatistics command |
+| alarm | Spectrum | READ | DEV_STRING | List of active (UNACK or ACKED) alarms and and their status. Format described below |
+| alarmDisabled | Spectrum | READ | DEV_STRING | List of disabled (OOSRV or SHLVD) alarms and and their status. Format described below |
+| alarmNormal | Spectrum | READ | DEV_STRING | List of alarm names in NORM state |
+| alarmUnacknowledged | Spectrum | READ | DEV_STRING | List of alarm names in UNACK state |
+| alarmAcknowledged | Spectrum | READ | DEV_STRING | List of alarm names in ACKED state |
+| alarmUnacknowledgedNormal | Spectrum | READ | DEV_STRING | List of alarm names in RTNUN state |
+| alarmShelved | Spectrum | READ | DEV_STRING | List of alarm names in SHLVD state |
+| alarmOutOfService | Spectrum | READ | DEV_STRING | List of alarm names in OOSRV state |
+| alarmSilenced | Spectrum | READ | DEV_STRING | List of alarm names in silenced state |
+| alarmList | Spectrum | READ | DEV_STRING | List of all alarm names |
+| alarmFrequency | Spectrum | READ | DEV_DOUBLE | List of alarms frequency, i.e. the number of times alarms have occurred since the last  _ResetStatistics_ command |
+| alarmSummary | Spectrum | READ | DEV_STRING | List of all alarms and their status. Format described below |
+| eventList | Spectrum | READ | DEV_STRING | List of all attributes subscribed (attributes present in formulas) |
+| eventSummary | Spectrum | READ | DEV_STRING | List of all attributes subscribed and their status. Format described below |
+
+* _alarm_
+    ```
+    <timestamp seconds>\t<timestamp us>\t<tag>\t<ALARM|NORMAL|ERROR>\t<ACK|NACK>\t<priority>\t<silenced time>\t<group>\t<message>
+    Example:
+    1740990955	124920	pssip_kg09.05_ch1_off	ALARM	ACK	high	0	gr_vac	sip300_l04.05 PS not ON
+    1741280601	438811	pssip_ctf.03_ch3_off	NORMAL	NACK	high	0	gr_vac	sip_ctf.07 PS not ON	 
+    1741595157	64811	pssip_kg04.01_ch1_off	ERROR	ACK	high	0	gr_vac	Tango error for kg04/vacuum/pssip_kg04.01/stat1: Not valid status
+    ```
+* _alarmDisabled_
+    ```
+    <timestamp seconds>\t<timestamp us>\t<tag>\t<OOSRV|SHLVD>\t<ACK|NACK>\t<priority>\t<silenced time>\t<group>\t<message>
+    Example:
+    1740990965	41097	pssip_kg07.15_ch2_off	OOSRV	NACK	high	0	gr_vac	sip75_boc_l02.01 PS not ON	
+    ```
+* _alarmSummary_
+    ```
+    tag=<tag>;state=<state>;priority=<priority>;time=<date time us>;formula=<formula>;message=<message>;
+    Example:
+    tag=pssip_kg09.05_ch1_off;state=ACKED;priority=high;time=2025-03-03 09:35:55.124920;formula=(kg09/vacuum/pssip_kg09.05/state1 == 0);message=sip300_l04.05 PS not ON
+    tag=pssip_ctf.03_ch3_off;state=ACKED;priority=high;time=2025-03-06 18:03:21.438811;formula=(ctf/vacuum/pssip_ctf.03/state3!=ON);message=sip_ctf.07 PS not ON
+    tag=pssip_kg04.01_ch1_off;state=ERROR;priority=high;time=2025-03-10 09:25:57.64811;formula=(kg04/vacuum/pssip_kg04.01/stat1[0] == 0);message=sip02_kg04.01 PS not ON
+    ```
+* _eventSummary_
+    ```
+    event=<attribute fqdn>;time=<date time s>;values=<attribute values>;exception=<attribute exception>;quality=<attribute quality>;
+    Example:
+    event=usa/vacuum/pssip_usa.22/stat1;time=2025-03-12 13:50:51;values=[1,1,0,1,1,0,0,0];exception=;quality=ATTR_VALID
+    event=kg15/vacuum/pssip_kg15.01/stat1;time=2025-03-14 16:49:50;values=[];exception={"Reason":"Event_ERROR","Desc":"Tango error for kg15/vacuum/pssip_kg15.01/stat1: Not valid status","Origin":"kg15/vacuum/pssip_kg15.01/stat1"};quality=ATTR_INVALID;
+    ```
+
+### Commands
+
+| Name | Input argument | Output argument | Description |
+|------|:-----:|:-----:|-----|
+| Ack | DEVVAR_STRINGARRAY | DEV_VOID | Acknowledge the list of alarms passed as input argument |
+| Load | DEV_STRING | DEV_VOID | Load a new alarm as a string of concatenated _“key=value;”_. Possible keys are those documented in the attribute properties. Note: The _SearchAlarm_ command returns strings that have the correct syntax for the _Load_ and _Modify_ input arguments |
+| Modify | DEV_STRING | DEV_VOID | Modify an existing alarm. Input argument has the same syntax of the _Load_ command |
+| Remove | DEV_STRING | DEV_VOID | Remove completely an alarm. Its configuration is deleted from the attribute properties |
+| Enable | DEV_STRING | DEV_VOID | Enable an alarm whose name is passed as the input argument. It has to be in the OOSRV or SHLVD state. Enabled is set to 1 in the attribute properties |
+| Disable | DEV_STRING | DEV_VOID | Disable an alarm whose name is passed as the input argument. Its state changes to OOSRV and enabled is set to 0 in the attribute properties. From OOSRV the alarm state can be changed only with the Enable command |
+| Shelve | DEVVAR_STRINGARRAY | DEV_VOID | Shelve command disable temporarily the list of alarms passed as input argument. Only alarms which have a silent_time property > 0 can be shelved. Their state is changed to SHLVD for the period specified as silent_time or until the Enable command is called |
+| Silence | DEVVAR_STRINGARRAY | DEV_VOID | Silence command disable temporarily the management of the audible condition of the list of alarms passed as input argument. Only alarms which have a silent_time property > 0 can be silenced. Their state continue to change following their normal behavior but they do not participate to the audibleAlarm evaluation for the period specified as silent_time or until the Enable command is called |
+| SearchAlarm | DEV_STRING | DEVVAR_STRINGARRAY | Returns the list of configured alarms that match the name of the filter string. If the filter string is empty or *, the command returns the configuration of all alarms. The Alarm configuration is returned as a concatenated _“key=value;”_ string, with the same syntax as the Load command |
+| GetAlarmInfo | DEVVAR_STRINGARRAY | DEVVAR_STRINGARRAY | Returns the complete status of the alarm whose name is passed as input argument [0]. The return value is an array of strings _“key=value;”_. Other input arguments may specify keys to be included in the response. Format described below |
+| ReLoadAll | DEV_VOID | DEV_VOID | Reaload the configuration of all alarms from attribute properties |
+| ResetStatistics | DEV_VOID | DEV_VOID | Reset frequency counters |
+| StopAudible | DEV_VOID | DEV_VOID | Reset audibleAlarm attribute |
+| StopNew | DEV_VOID | DEV_VOID | Same as StopAudible, kept temporarily for compatibility with legacy alarm GUI |
+
+
+* _GetAlarmInfo_
+Returns the complete status of the alarm whose name is passed as the input argument.
+The return value is an array of strings _“key=value;”_. The keys are those described in the attribute properties plus:
+    * value=one of the alarm state enum labels
+    * attr_values=concatenation of “attrname=value;” of the last value of attributes evaluated in the formula
+    * quality=the tango quality
+    * exception=Reason:.. Desc:.. Origin:..
+    * shelved=true/false
+    * ack=ACK/NACK
+    * audible=true/false
+    * on_counter=how many times it evaluated consecutively true
+    * on_counter=how many times it evaluated consecutively false
+    * freq_counter=how many times is has been evaluated since last ResetStatistics
+    * silent_time_remaining=how many minutes till when it will come back from shelved or silenced
+
+	Example:
+	```
+	[0]	 tag=ks_prealarm_sf6
+	[1]	 state=NORM
+	[2]	 message="Pre Alarm SF6 on modulator KS"
+	[3]	 url=
+	[4]	 formula=(ks/interlock/sf6_ks.01/StatSF6[1] == 0)
+	[5]	 values={"ks/interlock/sf6_ks.01/statsf6[1]":1}
+	[6]	 time=2025-02-09  07:33:19.411087
+	[7]	 quality=ATTR_VALID
+	[8]	 enabled=1
+	[9]	 shelved=0
+	[10]	 ack=1
+	[11]	 audible=0
+	[12]	 counter=2
+	[13]	 freq_counter=7
+	[14]	 on_delay=0
+	[15]	 off_delay=0
+	[16]	 priority=high
+	[17]	 shlvd_time=-1
+	[18]	 shlvd_end=-1
+	[19]	 group=gr_ctrl|gr_linac
+	[20]	 on_command=
+	[21]	 off_command=
+	[22]	 receivers=
+	```
+
+### Alarm states
+
+| Name | Value | Process condition | Alarm status | Acknowledge status | Description |
+|------|:-----:|:-----:|-----|-----|-----|
+| NORM | 0 | NORMAL | Inactive | Acknowledged | Normal state |
+| UNACK | 1 | ABNORMAL | Active | Unacknowledged | Alarm not acnowledged |
+| ACKED | 2 | ABNORMAL | Active | Acknowledged | Alarm acknowledged |
+| RTNUN | 3 | NORMAL | Inactive | Unacknowledged | Returned to normal not acnowledged |
+| SHLVD | 4 | ANY | Any | Not applicable | Shelved: temporarily disabled with the Shelve command |
+| DSUPR | 5 | ANY | Any | Not applicable | Suppressed by design: not possible to evaluate to alarm because of formula conditions. Note: it is not possible to enter in this state in this AlarmHandler implementation |
+| OOSRV | 6 | ANY | Any | Not applicable | Out of service: manually disabled with the Disable command |
+| ERROR | 7 | ANY | Any | Not applicable | Cannot be evaluated due to Tango or formula evaluation errors |
+
+# Alarm Ecosystem
+
+See [Alarm Ecosystem](./AlarmEcosystem.md) for other projects related to AlarmHandlers and how they can be used together.
\ No newline at end of file
--- a/docs/AlarmHandler_Doc.pdf
+++ b/docs/AlarmHandler_Doc.pdf
--- a/docs/Formula.md
+++ b/docs/Formula.md
+# Formula syntax
+The formula is an expression with operators, operands and functions. Operands can be variables, constant values, or other expression optionally enclosed by parentheses.
+
+## Operands
+
+### Variables
+
+- Attributes names with or without fqdn (e.g. ```tango://host:port/name/of/dev/attr```, ```name/of/dev/attr```)
+- attribute properties ```.quality```, ```.alarm```, ```.normal``` so that
+  - ```name/of/dev/attr.quality``` returns the Tango quality (the integer value) of the attribute
+  - ```name/of/dev/attr.alarm``` returns true if the attribute ==UNACK or ==ACK
+  - ```name/of/dev/attr.normal``` returns true if the attribute ==NORM or ==RTNUN
+
+### Constants
+
+- Real numbers (e.g. ```name/of/dev/attr >= 35```, ```name/of/dev/attr < -23.5```)
+- Hexadecimal numbers (e.g. ```name/of/dev/attr != 0xaf```, ```name/of/dev/attr & 0x1A```)
+- Strings as any character between an opening and a closing ' (e.g. ```name/of/dev/status == 'The device is in ON state.'```)
+- Tango states enum labels (*ON, OFF, CLOSE, OPEN, INSERT, EXTRACT, MOVING, STANDBY, FAULT, INIT, RUNNING, ALARM, DISABLE, UNKNOWN*) (e.g. ```name/of/dev/state == FAULT```)
+- Tango quality enum labels (*ATTR_VALID, ATTR_INVALID, ATTR_WARNING, ATTR_ALARM, ATTR_CHANGING*) (e.g. ```name/of/dev/attr.quality == ATTR_ALARM```)
+- Alarm state enum labels (*NORM, UNACK, ACKED, RTNUN, SHLVD, DSUPR, OOSRV*) (e.g. ```name/of/dev/alarm_attr != NORM```)
+
+### Expressions
+
+- A combination of operands and operators enclosed by parentheses
+
+## Operators
+
+### Binary Math
+- Multiplication ```*```
+- Division ```/```
+- Addition ```+```
+- Subtraction ```-```
+### Binary Comparison
+- Equal ```==```
+- Not equal ```!=```
+- Greater than ```>```
+- Greater than or equal to  ```>=```
+- Less than ```<```
+- Less than or equal to  ```<=```
+### Binary Logical
+- Logical AND ```&&```
+- Logical OR ```||```
+### Binary Bitwise
+- Left shift ```<<```
+- Right shift ```>>```
+- Bitwise AND ```&```
+- Bitwise OR ```|```
+- Bitwise XOR ```^```
+### Unary Math
+- Minus ```-```
+### Unary Logical
+- Logical NOT ```!```
+
+### Binary operators order of precedence
+
+```
+*, /, +, -, <<, >>, <=, >=, >, <, ==, !=, &, |, ^, &&, ||
+```
+
+## Functions
+
+### Unary Functions
+- Absolute value of X ```abs(X)```
+- Sine of X ```sin(X)```
+- Cosine of X ```cos(X)```
+
+### Binary Functions
+- Minimum between two values X and Y ```min(X,Y)```
+- Maximum between two values X and Y ```max(X,Y)```
+- Power: X raised to the power of Y ```pow(X,Y)```
+
+### Ternary Functions
+- Conditional operator: if X then Y else Z ```X ? Y : Z```
+
+### Reduce Functions
+- Reduce OR: reduce array X applying logical OR to each element ```OR(X)```
+- Reduce AND: reduce array X applying logical AND to each element ```AND(X)```
+
+# Attributes types
+
+The following types of attribute are supported:
+
+```
+Scalar, Spectrum, Image
+```
+
+with data types:
+
+```
+DevBoolean, DevUChar, DevShort, DevUShort, DevLong, DevULong, DevLong64, DevULong64, DevFloat, DevDouble, DevString, DevState, DevEnum
+```
+
+```DevEncoded``` is not supported.
+
+The read part of every attribute is internally extracted in a vector of double with the ```extract_read``` method of the ```DeviceAttribute``` class. In this ways operations between attribute with different data types and sizes can be performed with the following constraints:
+- DevString attributes can only be compared with 'equal' or 'not equal' operators to DevString attributes or string constants
+- Binary operators can operate on arrays if both operands have the same size, or one of the two has size equal to one.
+
+# Operation on arrays
+
+## Indexes to access elements
+
+- A single element of a one-dimensional array attribute (Spectrum) can be extracted with a single index between square brackets (e.g. ```name/of/dev/attr[ind]```).
+- A single element of a two-dimensional array attribute (Image) can be extracted with two indexes between square brackets (e.g. ```name/of/dev/attr[ind_row][ind_column]```).
+- A one-dimensional array can be extracted from a two-dimensional array attribute (Image) with a single index between square brackets (e.g. ```name/of/dev/attr[ind_row]```).
+
+## Lists and ranges of indexes to slice arrays
+Indexes can be specified as a comma separated list and/or hyphen-separated range (e.g. ```[i0,i1-i2,...]```).
+In this way:
+- A slice can be extracted from a one-dimensional array with a list and/or range of indexes between square brackets (e.g. ```name/of/dev/1Dattr[i0,i1-i2,...]```).
+- A subset of rows can be extracted from a two-dimensional array with a list and/or range of indexes for the first dimension (e.g. ```name/of/dev/2Dattr[i0,i1-i2,...]```).
+- A single column slice can be extracted from a two-dimensional array with a list and/or range of indexes for the first dimension and a single index for the second dimension (e.g. ```name/of/dev/2Dattr[i0,i1-i2,...][i3]```).
+- A single row slice can be extracted from a two-dimensional array with a single index for the first dimension and list/range of indexes for the second dimension (e.g. ```name/of/dev/2Dattr[i0][i1-i2,i3,...]```).
+- An array slice can be extracted from a two-dimensional array with a list and/or range of indexes for both the first and second dimensions (e.g. ```name/of/dev/2Dattr[i0-i1,...][i2,i3,...]```).
+- To specify all elements of one dimension index -1 can be used (e.g. Column 3 of all rows of 2D array ```name/of/dev/2Dattr[-1][3]```).
+
+If any index exceeds actual dimensions of the array, the formula is evaluated to ERROR with an out of bounds exception.
+
+No check is done on the order and uniqueness of indexes, so it is allowed to concatenate duplicated and out of order elements/rows/columns (e.g. ```name/of/dev/2Dattr[0-2,1,0,..]``` evaluates to an array with rows 0,1,2,1,0 of 2Dattr)
+
+## Limitations
+
+- It is not possible to specify array constants (e.g. ```name/of/dev/attr > [val1,val2]```).
+- It is not possible to use indexes on expressions (e.g. ```(any_expression)[ind]```).
+
+## Unary operators and functions
+
+Unary operators and functions are applied to every element of the array
+
+## Binary operators and functions
+
+- If both operands have the same size, operators are applied element by element. Result is an array with the same size.
+- If one operand has size one, operators apply it to every element of the other operand. Result is an array with the same size.
+- Otherwise an exception is raised and the formula is evaluated to the *ERROR* state with the Reason, Descrption and Origin DevFailed fields properly filled.
+
+## Ternary Function
+- Conditional operator: if X then Y else Z. X is implicitly reduced with *OR* to have a boolean value, then Y or Z are evaluated depending on the result
+
+# Formula result
+Every formula produce a boolean result in the following way:
+1. each element of the array is tested as not equal to zero in order to have an array of booleans
+2. the array of boolean is reduced with OR (i.e. if at least one element of the array is TRUE, the result is TRUE) 
+
+# Errors
+
+If a formula cannot be evaluated, the corresponding alarm is set to the *ERROR* value with the Reason, Description and Origin DevFailed fields properly filled.
+Possible errors are:
+- Errors coming from the event system for one or more attributes involved in the formula
+- Errors coming from evaluation of array with different sizes
+- Errors coming from indexes out of bound while extracting elements from arrays
+- Unexpected errors while evaluating formulas
--- a/docs/images/alarm_manager.png
+++ b/docs/images/alarm_manager.png
--- a/docs/images/alarm_ng.png
+++ b/docs/images/alarm_ng.png
--- a/docs/images/alarm_ng_history.png
+++ b/docs/images/alarm_ng_history.png
--- a/docs/images/alarm_notify_properties.png
+++ b/docs/images/alarm_notify_properties.png
--- a/docs/images/free_properties.png
+++ b/docs/images/free_properties.png
--- a/src/AlarmHandler.cpp
+++ b/src/AlarmHandler.cpp
--- a/src/AlarmHandler.h
+++ b/src/AlarmHandler.h
@@ -33,7 +33,7 @@
 #ifndef AlarmHandler_H
 #define AlarmHandler_H

-#include <tango.h>
+#include <tango/tango.h>

 #include <boost/version.hpp>
 #if BOOST_VERSION  >= 103600
@@ -61,7 +61,15 @@ class update_thread;
 #	define	ELAPSED(before, after)	\
 		1000.0*(after.tv_sec-before.tv_sec) + \
 		((double)after.tv_usec-before.tv_usec) / 1000
-
+#ifndef TANGO_LOG
+#define TANGO_LOG cout
+#endif
+#ifndef TANGO_LOG_INFO
+#define TANGO_LOG_INFO cout2
+#endif
+#ifndef TANGO_LOG_DEBUG
+#define TANGO_LOG_DEBUG cout4
+#endif


 /*----- PROTECTED REGION END -----*/	//	AlarmHandler.h
@@ -585,13 +593,13 @@ private:
 	void init_alarms(map< string,vector<string> > &alarm_events);
 #endif
 	void add_alarm(alarm_t& a, bool starting=false);
-	void add_event(alarm_t& a, vector<string> &evn) throw(string&);
+	void add_event(alarm_t& a, vector<string> &evn);
 #if 0
-	void subscribe_event(alarm_t& a, EventCallBack& ecb, vector<string> &evn) throw(string&);
+	void subscribe_event(alarm_t& a, EventCallBack& ecb, vector<string> &evn);
 #endif
 //	void do_alarm(bei_t& e);											//gcc 4 problem??
-	bool remove_alarm(string& s) throw(string&);
-	//void add_to_database(alarm_t& a) throw(string&);
+	bool remove_alarm(string& s);
+	//void add_to_database(alarm_t& a);
 	void set_internal_alarm(string name, Tango::TimeVal t, string msg, unsigned int count=1);
 	
 	void load_alarm(string alarm_string, alarm_t &alm, vector<string> &evn);
@@ -599,7 +607,8 @@ private:
 	formula_res_t eval_formula(tree_parse_info_t tree, string &attr_values);
 	void find_event_formula(tree_parse_info_t tree, vector<string> &);
 	
-	formula_res_t eval_expression(iter_t const& i, string &attr_values, int ev_ind=0);			//recursive tree node evaluation
+	formula_res_t eval_expression(iter_t const& i, string &attr_values, vector< vector<double> > ev_ind={});			//recursive tree node evaluation
+	void eval_index_range(iter_t const& i, string &attr_values, vector<double> & ind);
 	void eval_node_event(iter_t const& i, vector<string> & ev);		//recursive tree node evaluation		

 	void prepare_alarm_attr();	//for read attribute alarm and push_change_event

--- a/src/AlarmHandlerClass.cpp
+++ b/src/AlarmHandlerClass.cpp
@@ -73,7 +73,7 @@ AlarmHandlerClass *AlarmHandlerClass::_instance = NULL;
 //--------------------------------------------------------
 AlarmHandlerClass::AlarmHandlerClass(string &s):Tango::DeviceClass(s)
 {
-	cout2 << "Entering AlarmHandlerClass constructor" << endl;
+	TANGO_LOG_INFO << "Entering AlarmHandlerClass constructor" << endl;
 	set_default_property();
 	get_class_property();
 	write_class_property();
@@ -82,7 +82,7 @@ AlarmHandlerClass::AlarmHandlerClass(string &s):Tango::DeviceClass(s)
 	
 	/*----- PROTECTED REGION END -----*/	//	AlarmHandlerClass::constructor

-	cout2 << "Leaving AlarmHandlerClass constructor" << endl;
+	TANGO_LOG_INFO << "Leaving AlarmHandlerClass constructor" << endl;
 }

 //--------------------------------------------------------
@@ -162,7 +162,7 @@ AlarmHandlerClass *AlarmHandlerClass::instance()
 //--------------------------------------------------------
 CORBA::Any *AckClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "AckClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "AckClass::execute(): arrived" << endl;
 	const Tango::DevVarStringArray *argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->ack(argin));
@@ -182,7 +182,7 @@ CORBA::Any *AckClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_an
 //--------------------------------------------------------
 CORBA::Any *LoadClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "LoadClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "LoadClass::execute(): arrived" << endl;
 	Tango::DevString argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->load(argin));
@@ -202,7 +202,7 @@ CORBA::Any *LoadClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_a
 //--------------------------------------------------------
 CORBA::Any *RemoveClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "RemoveClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "RemoveClass::execute(): arrived" << endl;
 	Tango::DevString argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->remove(argin));
@@ -222,7 +222,7 @@ CORBA::Any *RemoveClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in
 //--------------------------------------------------------
 CORBA::Any *SearchAlarmClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "SearchAlarmClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "SearchAlarmClass::execute(): arrived" << endl;
 	Tango::DevString argin;
 	extract(in_any, argin);
 	return insert((static_cast<AlarmHandler *>(device))->search_alarm(argin));
@@ -241,7 +241,7 @@ CORBA::Any *SearchAlarmClass::execute(Tango::DeviceImpl *device, const CORBA::An
 //--------------------------------------------------------
 CORBA::Any *StopAudibleClass::execute(Tango::DeviceImpl *device, TANGO_UNUSED(const CORBA::Any &in_any))
 {
-	cout2 << "StopAudibleClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "StopAudibleClass::execute(): arrived" << endl;
 	((static_cast<AlarmHandler *>(device))->stop_audible());
 	return new CORBA::Any();
 }
@@ -259,7 +259,7 @@ CORBA::Any *StopAudibleClass::execute(Tango::DeviceImpl *device, TANGO_UNUSED(co
 //--------------------------------------------------------
 CORBA::Any *SilenceClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "SilenceClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "SilenceClass::execute(): arrived" << endl;
 	const Tango::DevVarStringArray *argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->silence(argin));
@@ -279,7 +279,7 @@ CORBA::Any *SilenceClass::execute(Tango::DeviceImpl *device, const CORBA::Any &i
 //--------------------------------------------------------
 CORBA::Any *ModifyClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "ModifyClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "ModifyClass::execute(): arrived" << endl;
 	Tango::DevString argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->modify(argin));
@@ -299,7 +299,7 @@ CORBA::Any *ModifyClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in
 //--------------------------------------------------------
 CORBA::Any *ShelveClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "ShelveClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "ShelveClass::execute(): arrived" << endl;
 	const Tango::DevVarStringArray *argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->shelve(argin));
@@ -319,7 +319,7 @@ CORBA::Any *ShelveClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in
 //--------------------------------------------------------
 CORBA::Any *EnableClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "EnableClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "EnableClass::execute(): arrived" << endl;
 	Tango::DevString argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->enable(argin));
@@ -339,7 +339,7 @@ CORBA::Any *EnableClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in
 //--------------------------------------------------------
 CORBA::Any *DisableClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "DisableClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "DisableClass::execute(): arrived" << endl;
 	Tango::DevString argin;
 	extract(in_any, argin);
 	((static_cast<AlarmHandler *>(device))->disable(argin));
@@ -359,7 +359,7 @@ CORBA::Any *DisableClass::execute(Tango::DeviceImpl *device, const CORBA::Any &i
 //--------------------------------------------------------
 CORBA::Any *ResetStatisticsClass::execute(Tango::DeviceImpl *device, TANGO_UNUSED(const CORBA::Any &in_any))
 {
-	cout2 << "ResetStatisticsClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "ResetStatisticsClass::execute(): arrived" << endl;
 	((static_cast<AlarmHandler *>(device))->reset_statistics());
 	return new CORBA::Any();
 }
@@ -377,7 +377,7 @@ CORBA::Any *ResetStatisticsClass::execute(Tango::DeviceImpl *device, TANGO_UNUSE
 //--------------------------------------------------------
 CORBA::Any *StopNewClass::execute(Tango::DeviceImpl *device, TANGO_UNUSED(const CORBA::Any &in_any))
 {
-	cout2 << "StopNewClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "StopNewClass::execute(): arrived" << endl;
 	((static_cast<AlarmHandler *>(device))->stop_new());
 	return new CORBA::Any();
 }
@@ -395,7 +395,7 @@ CORBA::Any *StopNewClass::execute(Tango::DeviceImpl *device, TANGO_UNUSED(const
 //--------------------------------------------------------
 CORBA::Any *GetAlarmInfoClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
 {
-	cout2 << "GetAlarmInfoClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "GetAlarmInfoClass::execute(): arrived" << endl;
 	const Tango::DevVarStringArray *argin;
 	extract(in_any, argin);
 	return insert((static_cast<AlarmHandler *>(device))->get_alarm_info(argin));
@@ -414,7 +414,7 @@ CORBA::Any *GetAlarmInfoClass::execute(Tango::DeviceImpl *device, const CORBA::A
 //--------------------------------------------------------
 CORBA::Any *ReLoadAllClass::execute(Tango::DeviceImpl *device, TANGO_UNUSED(const CORBA::Any &in_any))
 {
-	cout2 << "ReLoadAllClass::execute(): arrived" << endl;
+	TANGO_LOG_INFO << "ReLoadAllClass::execute(): arrived" << endl;
 	((static_cast<AlarmHandler *>(device))->re_load_all());
 	return new CORBA::Any();
 }
@@ -784,7 +784,7 @@ void AlarmHandlerClass::device_factory(const Tango::DevVarStringArray *devlist_p
 	//	Create devices and add it into the device list
 	for (unsigned long i=0 ; i<devlist_ptr->length() ; i++)
 	{
-		cout4 << "Device name : " << (*devlist_ptr)[i].in() << endl;
+		TANGO_LOG_DEBUG << "Device name : " << (*devlist_ptr)[i].in() << endl;
 		device_list.push_back(new AlarmHandler(this, (*devlist_ptr)[i]));
 	}

@@ -1432,7 +1432,7 @@ void AlarmHandlerClass::create_static_attribute_list(vector<Tango::Attr *> &att_
 		defaultAttList.push_back(att_name);
 	}

-	cout2 << defaultAttList.size() << " attributes in default list" << endl;
+	TANGO_LOG_INFO << defaultAttList.size() << " attributes in default list" << endl;

 	/*----- PROTECTED REGION ID(AlarmHandlerClass::create_static_att_list) ENABLED START -----*/
 	
@@ -1468,7 +1468,7 @@ void AlarmHandlerClass::erase_dynamic_attributes(const Tango::DevVarStringArray
 			vector<string>::iterator ite_str = find(defaultAttList.begin(), defaultAttList.end(), att_name);
 			if (ite_str == defaultAttList.end())
 			{
-				cout2 << att_name << " is a UNWANTED dynamic attribute for device " << (*devlist_ptr)[i] << endl;
+				TANGO_LOG_INFO << att_name << " is a UNWANTED dynamic attribute for device " << (*devlist_ptr)[i] << endl;
 				Tango::Attribute &att = dev->get_device_attr()->get_attr_by_name(att_name.c_str());
 				dev->remove_attribute(att_list[att.get_attr_idx()], true, false);
 				--ite_att;

--- a/src/AlarmHandlerClass.h
+++ b/src/AlarmHandlerClass.h
@@ -37,7 +37,7 @@
 #ifndef AlarmHandlerClass_H
 #define AlarmHandlerClass_H

-#include <tango.h>
+#include <tango/tango.h>
 #include <AlarmHandler.h>



--- a/src/ClassFactory.cpp
+++ b/src/ClassFactory.cpp
@@ -32,7 +32,7 @@
 //        (Program Obviously used to Generate tango Object)
 //=============================================================================

-#include <tango.h>
+#include <tango/tango.h>
 #include <AlarmHandlerClass.h>

 //	Add class header files if needed

--- a/src/SubscribeThread.h
+++ b/src/SubscribeThread.h
 #ifndef _SUBSCRIBE_THREAD_H
 #define _SUBSCRIBE_THREAD_H

-#include <tango.h>
-#include <eventconsumer.h>
+#include <tango/tango.h>
 #include <stdint.h>
 #include "event_table.h"


--- a/src/alarm-thread.cpp
+++ b/src/alarm-thread.cpp
@@ -14,7 +14,7 @@ static const char __FILE__rev[] = __FILE__ " $Revision: 1.7 $";
 */
 alarm_thread::alarm_thread(AlarmHandler_ns::AlarmHandler *p) : p_Alarm(p)
 {
-	//cout << __FILE__rev << endl;
+	//TANGO_LOG << __FILE__rev << endl;
 }

 /*
@@ -120,21 +120,21 @@ void alarm_thread::run(void *)
 			ostringstream err;
 			err << "omni_thread_fatal exception running alarm thread, err=" << ex.error << ends;
 			//WARN_STREAM << "alarm_thread::run(): " << err.str() << endl;	
-			printf("alarm_thread::run(): %s", err.str().c_str());
+			printf("alarm_thread::run(): %s\n", err.str().c_str());
 		}			
 		catch(Tango::DevFailed& ex)
 		{
 			ostringstream err;
 			err << "exception running alarm thread: '" << ex.errors[0].desc << "'" << ends;
 			//WARN_STREAM << "alarm_thread::run(): " << err.str() << endl;	
-			printf("alarm_thread::run(): %s", err.str().c_str());
-			Tango::Except::print_exception(ex);
+			printf("alarm_thread::run(): %s\n", err.str().c_str());
+			//Tango::Except::print_exception(ex);
 		}		
 		catch(...)
 		{
 			//WARN_STREAM << "alarm_thread::run(): catched unknown exception!!" << endl;
-			printf("alarm_thread::run(): catched unknown exception!!");
+			printf("alarm_thread::run(): catched unknown exception!!\n");
 		}		
 	}
-	//cout << "alarm_thread::run(): returning" << endl;
+	//TANGO_LOG << "alarm_thread::run(): returning" << endl;
 }  /* alarm_thread::run() */
No results found