ReadOn Flags: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
 
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/features/acquiring_data/frontends/programming/#when-to-read-data When to read data] in Frontends: programming for the new documentation about the "read on" flags.
 
Read-on flags RO_xxx are used in the [[Equipment List Parameters#ReadOn|Read On]]  field of the equipment declaration to specify when the read-out of an event occurs. These flags are defined in  [http://ladd00.triumf.ca/~daqweb/doc/midas-devel/doc/html/midas_8h.html midas.h].
* Multiple flags can be ORed together, e.g. RO_RUNNING|RO_ODB. 
* RO_TRANSITIONS is equivalent to RO_BOR|RO_EOR|RO_PAUSE|RO_RESUME.
 
{| class="wikitable"
|+ READ_ON Flags
|-
! READ_ON Flag name !! Value !! Readout Occurs
|-
|RO_RUNNING    || 1 || While running
|-
|RO_STOPPED    || 2|| Before stopping run
|-
|RO_PAUSED    ||  4 || When run is paused
|-
|RO_BOR    ||    8|| At the beginning of run
|-
|RO_EOR    ||    16|| At the end of run
|-
|RO_PAUSE    ||    32|| Before pausing the run
|-
|RO_RESUME  ||    64|| Before resuming the run
|-
|RO_TRANSITIONS || 127 || At all transitions
|-
|RO_ALWAYS  || 255||Always (independent of the run status)
|-
|RO_ODB || 256 ||Copies the event to the <span style="color: purple; font-style:italic;">/Equipment/<equipment name>/Variables</span> ODB tree. The ODB is updated with a new event approximately every second.<br>Note that this feature is generally used only for testing or monitoring, as writing large amounts of data to the ODB takes time.
|}
 
[[Category:Equipment]] [[Category:Frontend]]

Latest revision as of 22:01, 30 October 2026

The midas documentation has moved. See When to read data in Frontends: programming for the new documentation about the "read on" flags.