.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXelectrostatic_kicker.nxdl.xml -- DO NOT EDIT .. index:: ! NXelectrostatic_kicker (base class) ! electrostatic_kicker (base class) see: electrostatic_kicker (base class); NXelectrostatic_kicker .. _NXelectrostatic_kicker: ====================== NXelectrostatic_kicker ====================== .. Contributors List .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-03-08 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-09-02 **Status**: base class, extends :ref:`NXobject` **Description**: definition for a electrostatic kicker. **Symbols**: No symbol table **Groups cited**: :ref:`NXlog` .. index:: NXlog (base class); used in base class **Structure**: .. _/NXelectrostatic_kicker/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` extended description of the kicker. .. _/NXelectrostatic_kicker/beamline_distance-field: .. index:: beamline_distance (field) **beamline_distance**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} define position of beamline element relative to production target .. _/NXelectrostatic_kicker/timing-field: .. index:: timing (field) **timing**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} kicker timing as defined by ``description`` attribute .. _/NXelectrostatic_kicker/timing@description-attribute: .. index:: description (field attribute) **@description**: (optional) :ref:`NX_CHAR ` .. _/NXelectrostatic_kicker/set_current-field: .. index:: set_current (field) **set_current**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_CURRENT `} current set on supply. .. _/NXelectrostatic_kicker/set_voltage-field: .. index:: set_voltage (field) **set_voltage**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} volage set on supply. .. _/NXelectrostatic_kicker/read_current-group: **read_current**: (optional) :ref:`NXlog` current read from supply. .. _/NXelectrostatic_kicker/read_current/value-field: .. index:: value (field) **value**: (optional) :ref:`NX_CHAR ` {units=\ :ref:`NX_CURRENT `} .. _/NXelectrostatic_kicker/read_voltage-group: **read_voltage**: (optional) :ref:`NXlog` voltage read from supply. .. _/NXelectrostatic_kicker/read_voltage/value-field: .. index:: value (field) **value**: (optional) :ref:`NX_CHAR ` {units=\ :ref:`NX_VOLTAGE `} Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXelectrostatic_kicker/beamline_distance-field ` * :ref:`/NXelectrostatic_kicker/description-field ` * :ref:`/NXelectrostatic_kicker/read_current-group ` * :ref:`/NXelectrostatic_kicker/read_current/value-field ` * :ref:`/NXelectrostatic_kicker/read_voltage-group ` * :ref:`/NXelectrostatic_kicker/read_voltage/value-field ` * :ref:`/NXelectrostatic_kicker/set_current-field ` * :ref:`/NXelectrostatic_kicker/set_voltage-field ` * :ref:`/NXelectrostatic_kicker/timing-field ` * :ref:`/NXelectrostatic_kicker/timing@description-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXelectrostatic_kicker.nxdl.xml