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

.. index::
    ! NXactuator (base class)
    ! actuator (base class)
    see: actuator (base class); NXactuator

.. _NXactuator:

==========
NXactuator
==========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: An actuator used to control an external condition. ...

      An actuator used to control an external condition.

      The condition itself is described in :ref:`NXenvironment`.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXpid_controller`

.. index:: NXpid_controller (base class); used in base class

**Structure**:

  .. _/NXactuator/name-field:

  .. index:: name (field)

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

    Name of the actuator

  .. _/NXactuator/short_name-field:

  .. index:: short_name (field)

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

    Short name of actuator used e.g. on monitor display program

  .. _/NXactuator/actuation_target-field:

  .. index:: actuation_target (field)

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

    .. collapse:: The physical component on which this actuator acts. ...

        The physical component on which this actuator acts.
        This should be a path in the NeXus tree structure.
        For example, this could be an instance of NXsample or a device on NXinstrument.

  .. _/NXactuator/physical_quantity-field:

  .. index:: physical_quantity (field)

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

    .. collapse:: Name for the physical quantity effected by the actuation ...

        Name for the physical quantity effected by the actuation

        Examples:
        temperature | pH | magnetic_field | electric_field | current | conductivity | resistance | voltage |
        pressure | flow | stress | strain | shear | surface_pressure

  .. _/NXactuator/type-field:

  .. index:: type (field)

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

    .. collapse:: The type of hardware used for the actuation. ...

        The type of hardware used for the actuation.

        Examples (suggestions, but not restrictions):

        :Temperature: laser | gas lamp | filament | resistive
        :Pressure: anvil cell
        :Voltage: potentiostat

  .. _/NXactuator/outputVALUE-field:

  .. index:: outputVALUE (field)

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

    .. collapse:: Any output that the actuator produces. ...

        Any output that the actuator produces.
        For example, a heater can have the field output_power(NX_NUMBER).

  .. _/NXactuator/PID_CONTROLLER-group:

  :bolditalic:`PID_CONTROLLER`: (optional) :ref:`NXpid_controller` 

    .. collapse:: If the actuator is PID-controlled, the settings of the PID controller can be ...

        If the actuator is PID-controlled, the settings of the PID controller can be
        stored here.


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

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


* :ref:`/NXactuator/actuation_target-field </NXactuator/actuation_target-field>`
* :ref:`/NXactuator/name-field </NXactuator/name-field>`
* :ref:`/NXactuator/outputVALUE-field </NXactuator/outputVALUE-field>`
* :ref:`/NXactuator/physical_quantity-field </NXactuator/physical_quantity-field>`
* :ref:`/NXactuator/PID_CONTROLLER-group </NXactuator/PID_CONTROLLER-group>`
* :ref:`/NXactuator/short_name-field </NXactuator/short_name-field>`
* :ref:`/NXactuator/type-field </NXactuator/type-field>`

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