.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXmagnetic_kicker.nxdl.xml

.. index::
    ! NXmagnetic_kicker (base class)
    ! magnetic_kicker (base class)
    see: magnetic_kicker (base class); NXmagnetic_kicker

.. _NXmagnetic_kicker:

=================
NXmagnetic_kicker
=================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  definition for a magnetic kicker.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXlog`

.. index:: NXlog (base class); used in base class

**Structure**:

  .. _/NXmagnetic_kicker/description-field:

  .. index:: description (field)

  **description**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    extended description of the kicker.

  .. _/NXmagnetic_kicker/beamline_distance-field:

  .. index:: beamline_distance (field)

  **beamline_distance**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    define position of beamline element relative to production target

  .. _/NXmagnetic_kicker/timing-field:

  .. index:: timing (field)

  **timing**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <NX_TIME>`}

    kicker timing as defined by ``description`` attribute

    .. _/NXmagnetic_kicker/timing@description-attribute:

    .. index:: description (field attribute)

    **@description**: (optional) :ref:`NX_CHAR <NX_CHAR>`


  .. _/NXmagnetic_kicker/set_current-field:

  .. index:: set_current (field)

  **set_current**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    current set on supply.

  .. _/NXmagnetic_kicker/set_voltage-field:

  .. index:: set_voltage (field)

  **set_voltage**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}

    voltage set on supply.

  .. _/NXmagnetic_kicker/read_current-group:

  **read_current**: (optional) :ref:`NXlog`

    current read from supply.

    .. _/NXmagnetic_kicker/read_current/value-field:

    .. index:: value (field)

    **value**: (optional) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}


  .. _/NXmagnetic_kicker/read_voltage-group:

  **read_voltage**: (optional) :ref:`NXlog`

    voltage read from supply.

    .. _/NXmagnetic_kicker/read_voltage/value-field:

    .. index:: value (field)

    **value**: (optional) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}



Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXmagnetic_kicker/beamline_distance-field </NXmagnetic_kicker/beamline_distance-field>`
* :ref:`/NXmagnetic_kicker/description-field </NXmagnetic_kicker/description-field>`
* :ref:`/NXmagnetic_kicker/read_current-group </NXmagnetic_kicker/read_current-group>`
* :ref:`/NXmagnetic_kicker/read_current/value-field </NXmagnetic_kicker/read_current/value-field>`
* :ref:`/NXmagnetic_kicker/read_voltage-group </NXmagnetic_kicker/read_voltage-group>`
* :ref:`/NXmagnetic_kicker/read_voltage/value-field </NXmagnetic_kicker/read_voltage/value-field>`
* :ref:`/NXmagnetic_kicker/set_current-field </NXmagnetic_kicker/set_current-field>`
* :ref:`/NXmagnetic_kicker/set_voltage-field </NXmagnetic_kicker/set_voltage-field>`
* :ref:`/NXmagnetic_kicker/timing-field </NXmagnetic_kicker/timing-field>`
* :ref:`/NXmagnetic_kicker/timing@description-attribute </NXmagnetic_kicker/timing@description-attribute>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXmagnetic_kicker.nxdl.xml