esrf

Beamline Instrument Software Support
SPEC Macro documentation: [ Macro Index | BCU Home ]

RING_CURRENT.MAC
See other macros in category: All
Description:
    %B%ring_current.mac%B% - various macros to read the ring current and other "machine" parameters
Documentation:
Macros:
    ring_curr
    Usage: ring_curr (elapsed_time)
    Calculate the ring current in function of the beam lifetime. If elapsed_time = -1, calculate the current factor, rather than the current.

    rc_on
    Usage: rc_on counter_mnemonic
    read the ring current only if there is counter counter_mnemonic

    rc_off
    Usage: rc_off counter_mnemonic
    clean the ring current counter_mnemonic definition

Internal Macros:
    _read_mach_current
    Usage: _read_mach_current (mc)
    read some parameters from the "machine" and save them them in the mc array as follows: mc[0] - current {mA}, mc[1] - lifetime [s], mc[2] - time left until injection [s]

    _rc
    Usage: _rc ()
    Read the ring current. Return the actual value or -1 of error.

Filename: ring_current.mac
Author: A.Beteva, A.Filipponi
$Revision: 1.8 $, $Date: 2021/03/15 16:44:48 $
Last mod.: 15/03/2021 17:43 by guilloud