Difference between revisions of "ReadOn Flags"

From MidasWiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
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.
+
{{Pagelinks}}
  
;RO_RUNNING : While running
+
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].
;RO_STOPPED : Before stopping run
+
* Multiple flags can be ORed together, e.g. RO_RUNNING|RO_ODB. 
;RO_PAUSED : When run is paused
+
* RO_TRANSITIONS is equivalent to  RO_BOR|RO_EOR|RO_PAUSE|RO_RESUME.
;RO_BOR : At the beginning of run
+
 
;RO_EOR : At the end of run
+
{| class="wikitable"
;RO_PAUSE : Before pausing the run
+
|+ READ_ON Flags
;RO_RESUME : Before resuming the run
+
|-
;RO_TRANSITIONS : At all transitions
+
! READ_ON Flag name !! Value !! Readout Occurs
;RO_ALWAYS :Always (independent of the run status)
+
|-
;RO_ODB :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. Note that this feature is generally used only for testing or monitoring, as writing large amounts of data to the ODB takes time.
+
|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 16:39, 12 December 2016


Read-on flags RO_xxx are used in the Read On field of the equipment declaration to specify when the read-out of an event occurs. These flags are defined in 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.
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 /Equipment/<equipment name>/Variables ODB tree. The ODB is updated with a new event approximately every second.
Note that this feature is generally used only for testing or monitoring, as writing large amounts of data to the ODB takes time.