.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source 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`

**Description**:

  definition for a electrostatic kicker.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXelectrostatic_kicker/description-field:

  .. index:: description (field)

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

    extended description of the kicker.

  .. _/NXelectrostatic_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

  .. _/NXelectrostatic_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

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

    .. index:: description (field attribute)

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


  .. _/NXelectrostatic_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.

  .. _/NXelectrostatic_kicker/set_voltage-field:

  .. index:: set_voltage (field)

  **set_voltage**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <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**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_CURRENT <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**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}



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

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


================================================================================================================== ==================================================================================================================
documentation (reST source) anchor                                                                                 web page (HTML) anchor                                                                                            
================================================================================================================== ==================================================================================================================
:ref:`/NXelectrostatic_kicker/beamline_distance-field </NXelectrostatic_kicker/beamline_distance-field>`           :ref:`#nxelectrostatic-kicker-beamline-distance-field </NXelectrostatic_kicker/beamline_distance-field>`          
:ref:`/NXelectrostatic_kicker/description-field </NXelectrostatic_kicker/description-field>`                       :ref:`#nxelectrostatic-kicker-description-field </NXelectrostatic_kicker/description-field>`                      
:ref:`/NXelectrostatic_kicker/read_current-group </NXelectrostatic_kicker/read_current-group>`                     :ref:`#nxelectrostatic-kicker-read-current-group </NXelectrostatic_kicker/read_current-group>`                    
:ref:`/NXelectrostatic_kicker/read_current/value-field </NXelectrostatic_kicker/read_current/value-field>`         :ref:`#nxelectrostatic-kicker-read-current-value-field </NXelectrostatic_kicker/read_current/value-field>`        
:ref:`/NXelectrostatic_kicker/read_voltage-group </NXelectrostatic_kicker/read_voltage-group>`                     :ref:`#nxelectrostatic-kicker-read-voltage-group </NXelectrostatic_kicker/read_voltage-group>`                    
:ref:`/NXelectrostatic_kicker/read_voltage/value-field </NXelectrostatic_kicker/read_voltage/value-field>`         :ref:`#nxelectrostatic-kicker-read-voltage-value-field </NXelectrostatic_kicker/read_voltage/value-field>`        
:ref:`/NXelectrostatic_kicker/set_current-field </NXelectrostatic_kicker/set_current-field>`                       :ref:`#nxelectrostatic-kicker-set-current-field </NXelectrostatic_kicker/set_current-field>`                      
:ref:`/NXelectrostatic_kicker/set_voltage-field </NXelectrostatic_kicker/set_voltage-field>`                       :ref:`#nxelectrostatic-kicker-set-voltage-field </NXelectrostatic_kicker/set_voltage-field>`                      
:ref:`/NXelectrostatic_kicker/timing-field </NXelectrostatic_kicker/timing-field>`                                 :ref:`#nxelectrostatic-kicker-timing-field </NXelectrostatic_kicker/timing-field>`                                
:ref:`/NXelectrostatic_kicker/timing@description-attribute </NXelectrostatic_kicker/timing@description-attribute>` :ref:`#nxelectrostatic-kicker-timing-description-attribute </NXelectrostatic_kicker/timing@description-attribute>`
================================================================================================================== ==================================================================================================================


**NXDL Source**:
  https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/contributed_definitions/NXelectrostatic_kicker.nxdl.xml