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

.. index::
    ! NXpositioner (base class)
    ! positioner (base class)
    see: positioner (base class); NXpositioner

.. _NXpositioner:

============
NXpositioner
============

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  A generic positioner such as a motor or piezo-electric transducer.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXactuator`, :ref:`NXpid_controller`, :ref:`NXsensor`

.. index:: NXactuator (base class); used in base class, NXpid_controller (base class); used in base class, NXsensor (base class); used in base class

**Structure**:

  .. _/NXpositioner/name-field:

  .. index:: name (field)

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

    symbolic or mnemonic name (one word)

  .. _/NXpositioner/description-field:

  .. index:: description (field)

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

    description of positioner

  .. _/NXpositioner/value-field:

  .. index:: value (field)

  **value**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    best known value of positioner - need [n] as may be scanned

  .. _/NXpositioner/raw_value-field:

  .. index:: raw_value (field)

  **raw_value**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    raw value of positioner - need [n] as may be scanned

  .. _/NXpositioner/target_value-field:

  .. index:: target_value (field)

  **target_value**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    targeted (commanded) value of positioner - need [n] as may be scanned

  .. _/NXpositioner/tolerance-field:

  .. index:: tolerance (field)

  **tolerance**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    maximum allowable difference between target_value and value

  .. _/NXpositioner/soft_limit_min-field:

  .. index:: soft_limit_min (field)

  **soft_limit_min**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    minimum allowed limit to set value

  .. _/NXpositioner/soft_limit_max-field:

  .. index:: soft_limit_max (field)

  **soft_limit_max**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    maximum allowed limit to set value

  .. _/NXpositioner/velocity-field:

  .. index:: velocity (field)

  **velocity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    velocity of the positioner (distance moved per unit time)

  .. _/NXpositioner/acceleration_time-field:

  .. index:: acceleration_time (field)

  **acceleration_time**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    time to ramp the velocity up to full speed

  .. _/NXpositioner/controller_record-field:

  .. index:: controller_record (field)

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

    Hardware device record, e.g. EPICS process variable, taco/tango ...

  .. _/NXpositioner/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 positioner. ...

        .. todo::
          Add a definition for the reference point of a positioner.

  .. _/NXpositioner/actuator-group:

  **actuator**: (optional) :ref:`NXactuator` 

    .. collapse:: The actuator of the positioner which is responsible for the movement of the ...

        The actuator of the positioner which is responsible for the movement of the
        probe.

    .. _/NXpositioner/actuator/feedback-group:

    **feedback**: (optional) :ref:`NXpid_controller` :ref:`⤆ </NXactuator/PID_CONTROLLER-group>`

      The feedback of the actual position of the positioner.

      .. _/NXpositioner/actuator/feedback/pv_sensor-group:

      **pv_sensor**: (optional) :ref:`NXsensor` :ref:`⤆ </NXpid_controller/pv_sensor-group>`

        .. collapse:: If present, the value and the value_log of this pv_sensor is the same as ...

            If present, the value and the value_log of this pv_sensor is the same as
            the value and raw_value of the position itself.


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

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


* :ref:`/NXpositioner/acceleration_time-field </NXpositioner/acceleration_time-field>`
* :ref:`/NXpositioner/actuator-group </NXpositioner/actuator-group>`
* :ref:`/NXpositioner/actuator/feedback-group </NXpositioner/actuator/feedback-group>`
* :ref:`/NXpositioner/actuator/feedback/pv_sensor-group </NXpositioner/actuator/feedback/pv_sensor-group>`
* :ref:`/NXpositioner/controller_record-field </NXpositioner/controller_record-field>`
* :ref:`/NXpositioner/depends_on-field </NXpositioner/depends_on-field>`
* :ref:`/NXpositioner/description-field </NXpositioner/description-field>`
* :ref:`/NXpositioner/name-field </NXpositioner/name-field>`
* :ref:`/NXpositioner/raw_value-field </NXpositioner/raw_value-field>`
* :ref:`/NXpositioner/soft_limit_max-field </NXpositioner/soft_limit_max-field>`
* :ref:`/NXpositioner/soft_limit_min-field </NXpositioner/soft_limit_min-field>`
* :ref:`/NXpositioner/target_value-field </NXpositioner/target_value-field>`
* :ref:`/NXpositioner/tolerance-field </NXpositioner/tolerance-field>`
* :ref:`/NXpositioner/value-field </NXpositioner/value-field>`
* :ref:`/NXpositioner/velocity-field </NXpositioner/velocity-field>`

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