Skip to content

Commit

Permalink
bring in changes to NXactuator and NXfabrication from nexusformat#1414
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaspie committed Jan 7, 2025
1 parent 0828ec9 commit 6dc28f4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 41 deletions.
36 changes: 1 addition & 35 deletions base_classes/NXactuator.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@

The condition itself is described in :ref:`NXenvironment`.
</doc>
<field name="model">
<doc>
Actuator identification code/model number
</doc>
</field>
<field name="name">
<doc>
Name of the actuator
Expand Down Expand Up @@ -68,33 +63,17 @@
:Voltage: potentiostat
</doc>
</field>
<field name="OUTPUT" type="NX_FLOAT" units="NX_ANY">
<field name="outputVALUE" type="NX_FLOAT" units="NX_ANY" nameType="partial">
<doc>
Any output that the actuator produces.
For example, a heater can have the field heater_power(NX_FLOAT).
</doc>
</field>
<group name="OUTPUT_log" type="NXlog">
<doc>
Time history of actuator outputs.
</doc>
</group>
<group type="NXpid">
<doc>
If the actuator is PID-controlled, the settings of the PID controller can be
stored here.
</doc>
<field name="setpoint" type="NX_FLOAT" units="NX_ANY">
<doc>
Nominal actuator setpoint.
Can be a scalar or a vector (of [n] actuations).
</doc>
</field>
<group name="setpoint_log" type="NXlog">
<doc>
Time history of actuator setpoints.
</doc>
</group>
</group>
<field name="depends_on" type="NX_CHAR">
<doc>
Expand All @@ -110,18 +89,5 @@
other component groups.
</doc>
</group>
<attribute name="default">
<doc>
.. 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.
</doc>
</attribute>
<group type="NXfabrication"/>
</definition>
10 changes: 4 additions & 6 deletions base_classes/NXfabrication.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
</doc>
<attribute name="version" type="NX_CHAR">
<doc>
If different versions exist are possible, the value in this field should be made
If it is possible that different versions exist, the value in this field should be made
specific enough to resolve the version.
</doc>
</attribute>
Expand All @@ -48,17 +48,15 @@
</field>
<field name="construction_year" type="NX_DATE_TIME">
<doc>
Datetime of components initial construction. This refers to the date of
Datetime of component's initial construction. This refers to the date of
first measurement after new construction or to the relocation date,
if it describes a multicomponent/custom-build setup.
Should be a ISO8601 date/time stamp. It is recommended to add an explicit time zone,
otherwise the local time zone is assumed per ISO8601.
It is recommended to add an explicit time zone.
</doc>
</field>
<field name="capability" type="NX_CHAR">
<doc>
Free-text list with eventually multiple terms of
functionalities which the component offers.
Free-text list of functionalities which the component offers.
</doc>
</field>
</definition>

0 comments on commit 6dc28f4

Please sign in to comment.