.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXflipper.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXflipper (base class)
    ! flipper (base class)
    see: flipper (base class); NXflipper

.. _NXflipper:

=========
NXflipper
=========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  A spin flipper.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXflipper/type-field:

  .. index:: type (field)

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


    Any of these values: ``coil`` | ``current-sheet``

  .. _/NXflipper/flip_turns-field:

  .. index:: flip_turns (field)

  **flip_turns**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PER_LENGTH <NX_PER_LENGTH>`} 

    Linear density of turns (such as number of turns/cm) in flipping field coils

  .. _/NXflipper/comp_turns-field:

  .. index:: comp_turns (field)

  **comp_turns**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PER_LENGTH <NX_PER_LENGTH>`} 

    Linear density of turns (such as number of turns/cm) in compensating field coils

  .. _/NXflipper/guide_turns-field:

  .. index:: guide_turns (field)

  **guide_turns**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PER_LENGTH <NX_PER_LENGTH>`} 

    Linear density of turns (such as number of turns/cm) in guide field coils

  .. _/NXflipper/flip_current-field:

  .. index:: flip_current (field)

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

    Flipping field coil current in "on" state"

  .. _/NXflipper/comp_current-field:

  .. index:: comp_current (field)

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

    Compensating field coil current in "on" state"

  .. _/NXflipper/guide_current-field:

  .. index:: guide_current (field)

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

    Guide field coil current in "on" state

  .. _/NXflipper/thickness-field:

  .. index:: thickness (field)

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

    thickness along path of neutron travel

  .. _/NXflipper/depends_on-field:

  .. index:: depends_on (field)

  **depends_on**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/depends_on-field>`

    .. collapse::   Add a definition for the reference point of a spin flipper. ...

        .. todo::
          Add a definition for the reference point of a spin flipper.


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

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


* :ref:`/NXflipper/comp_current-field </NXflipper/comp_current-field>`
* :ref:`/NXflipper/comp_turns-field </NXflipper/comp_turns-field>`
* :ref:`/NXflipper/depends_on-field </NXflipper/depends_on-field>`
* :ref:`/NXflipper/flip_current-field </NXflipper/flip_current-field>`
* :ref:`/NXflipper/flip_turns-field </NXflipper/flip_turns-field>`
* :ref:`/NXflipper/guide_current-field </NXflipper/guide_current-field>`
* :ref:`/NXflipper/guide_turns-field </NXflipper/guide_turns-field>`
* :ref:`/NXflipper/thickness-field </NXflipper/thickness-field>`
* :ref:`/NXflipper/type-field </NXflipper/type-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXflipper.nxdl.xml