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

.. index::
    ! NXsolenoid_magnet (contributed definition)
    ! solenoid_magnet (contributed definition)
    see: solenoid_magnet (contributed definition); NXsolenoid_magnet

.. _NXsolenoid_magnet:

=================
NXsolenoid_magnet
=================

**Status**:

  contributed definition, extends :ref:`NXobject`

**Description**:

  definition for a solenoid magnet.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXsolenoid_magnet/description-field:

  .. index:: description (field)

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

    extended description of the magnet.

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

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

  .. _/NXsolenoid_magnet/read_current-group:

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

    current read from supply.

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

    .. index:: value (field)

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


  .. _/NXsolenoid_magnet/read_voltage-group:

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

    voltage read from supply.

    .. _/NXsolenoid_magnet/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:`/NXsolenoid_magnet/beamline_distance-field </NXsolenoid_magnet/beamline_distance-field>`   :ref:`#nxsolenoid-magnet-beamline-distance-field </NXsolenoid_magnet/beamline_distance-field>`  
:ref:`/NXsolenoid_magnet/description-field </NXsolenoid_magnet/description-field>`               :ref:`#nxsolenoid-magnet-description-field </NXsolenoid_magnet/description-field>`              
:ref:`/NXsolenoid_magnet/read_current-group </NXsolenoid_magnet/read_current-group>`             :ref:`#nxsolenoid-magnet-read-current-group </NXsolenoid_magnet/read_current-group>`            
:ref:`/NXsolenoid_magnet/read_current/value-field </NXsolenoid_magnet/read_current/value-field>` :ref:`#nxsolenoid-magnet-read-current-value-field </NXsolenoid_magnet/read_current/value-field>`
:ref:`/NXsolenoid_magnet/read_voltage-group </NXsolenoid_magnet/read_voltage-group>`             :ref:`#nxsolenoid-magnet-read-voltage-group </NXsolenoid_magnet/read_voltage-group>`            
:ref:`/NXsolenoid_magnet/read_voltage/value-field </NXsolenoid_magnet/read_voltage/value-field>` :ref:`#nxsolenoid-magnet-read-voltage-value-field </NXsolenoid_magnet/read_voltage/value-field>`
:ref:`/NXsolenoid_magnet/set_current-field </NXsolenoid_magnet/set_current-field>`               :ref:`#nxsolenoid-magnet-set-current-field </NXsolenoid_magnet/set_current-field>`              
================================================================================================ ================================================================================================


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