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

.. index::
    ! NXelectrostatic_kicker (contributed definition)
    ! electrostatic kicker (contributed definition)
    see: electrostatic kicker (contributed definition); NXelectrostatic_kicker

.. _NXelectrostatic_kicker:

======================
NXelectrostatic_kicker
======================

**Status**:

  contributed definition, extends :ref:`NXobject`, version 1.0

**Description**:

  definition for a electrostatic kicker.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. index:: description (data field)

  **description**: :ref:`NX_CHAR <NX_CHAR>`

    extended description of the kicker.

  .. index:: beamline_distance (data field)

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

    define position of beamline element relative to production target

  .. index:: timing (data field)

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

    kicker timing as defined by ``description`` attribute

    .. index:: description (attribute)

    **@description**: :ref:`NX_CHAR <NX_CHAR>`


  .. index:: set_current (data field)

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

    current set on supply.

  .. index:: set_voltage (data field)

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

    volage set on supply.

  **read_current**: :ref:`NXlog`

    current read from supply.

    .. index:: value (data field)

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


  **read_voltage**: :ref:`NXlog`

    voltage read from supply.

    .. index:: value (data field)

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


**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/contributed_definitions/NXelectrostatic_kicker.nxdl.xml