.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/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:`NXobject` **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:`NXfabrication`, :ref:`NXlog`, :ref:`NXpid`, :ref:`NXtransformations` .. index:: NXlog (base class); used in base class, NXpid (base class); used in base class, NXtransformations (base class); used in base class, NXfabrication (base class); used in base class **Structure**: .. _/NXactuator@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. index:: plotting Declares which child group contains a path leading to a :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/NXactuator/model-field: .. index:: model (field) **model**: (optional) :ref:`NX_CHAR ` Actuator identification code/model number .. _/NXactuator/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Name of the actuator .. _/NXactuator/short_name-field: .. index:: short_name (field) **short_name**: (optional) :ref:`NX_CHAR ` Short name of actuator used e.g. on monitor display program .. _/NXactuator/attached_to-field: .. index:: attached_to (field) **attached_to**: (optional) :ref:`NX_CHAR ` .. collapse:: Describe where the actuator is attached to. ... Describe where the actuator is attached to. 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 ` .. 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 ` .. 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/OUTPUT-field: .. index:: OUTPUT (field) **OUTPUT**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. collapse:: Any output that the actuator produces. ... Any output that the actuator produces. For example, a heater can have the field heater_power(NX_FLOAT). .. _/NXactuator/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: Refers to the last transformation specifying the position of the actuator ... Refers to the last transformation specifying the position of the actuator in the NXtransformations chain. .. _/NXactuator/OUTPUT_log-group: **OUTPUT_log**: (optional) :ref:`NXlog` Time history of actuator outputs. .. _/NXactuator/PID-group: **PID**: (optional) :ref:`NXpid` .. 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. .. _/NXactuator/PID/setpoint-field: .. index:: setpoint (field) **setpoint**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} :ref:`⤆ ` .. collapse:: Nominal actuator setpoint. ... Nominal actuator setpoint. Can be a scalar or a vector (of [n] actuations). .. _/NXactuator/PID/setpoint_log-group: **setpoint_log**: (optional) :ref:`NXlog` :ref:`⤆ ` Time history of actuator setpoints. .. _/NXactuator/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: This is the group recommended for holding the chain of translation ... This is the group recommended for holding the chain of translation and rotation operations necessary to position the actuator within the instrument. The dependency chain may however traverse similar groups in other component groups. .. _/NXactuator/FABRICATION-group: **FABRICATION**: (optional) :ref:`NXfabrication` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXactuator/attached_to-field ` * :ref:`/NXactuator/depends_on-field ` * :ref:`/NXactuator/FABRICATION-group ` * :ref:`/NXactuator/model-field ` * :ref:`/NXactuator/name-field ` * :ref:`/NXactuator/OUTPUT-field ` * :ref:`/NXactuator/OUTPUT_log-group ` * :ref:`/NXactuator/physical_quantity-field ` * :ref:`/NXactuator/PID-group ` * :ref:`/NXactuator/PID/setpoint-field ` * :ref:`/NXactuator/PID/setpoint_log-group ` * :ref:`/NXactuator/short_name-field ` * :ref:`/NXactuator/TRANSFORMATIONS-group ` * :ref:`/NXactuator/type-field ` * :ref:`/NXactuator@default-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXactuator.nxdl.xml