Fairmat 2024: new common base classes

base_classes/NXactivity.nxdl.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
+<!--
+# NeXus - Neutron and X-ray Common Data Format
+# 
+# Copyright (C) 2014-2024 NeXus International Advisory Committee (NIAC)
+# 
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# For further information, see http://www.nexusformat.org
+-->
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXactivity" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+    <doc>
+         A planned or unplanned action that has a temporal extension and for some time depends on some entity.
+
+         This class is planned be used in the future as the super class for all other activities if inheritance 
+         in base classes is supported in NeXus.
+    </doc>
+    <field name="start_time" type="NX_DATE_TIME">
+        <doc>
+             ISO 8601 formatted time code (with local time zone offset to UTC information
+             included) when this activity started.
+        </doc>
+    </field>
+    <field name="end_time" type="NX_DATE_TIME">
+        <doc>
+             ISO 8601 formatted time code (with local time zone offset to UTC information
+             included) when this activity ended.
+        </doc>
+    </field>
+    <field name="description">
+        <doc>
+             Short description of the activity.
+        </doc>
+    </field>
+    <group name="notes" type="NXnote">
+        <doc>
+             This can be any data or other descriptor acquired during the activity
+             (NXnote allows to add pictures, audio, movies). Alternatively, a
+             reference to the location or a unique identifier or other metadata file. In the
+             case these are not available, free-text description.
+        </doc>
+    </group>
+</definition>

base_classes/NXactuator.nxdl.xml

@@ -0,0 +1,127 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
+<!--
+# NeXus - Neutron and X-ray Common Data Format
+#
+# Copyright (C) 2014-2024 NeXus International Advisory Committee (NIAC)
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# For further information, see http://www.nexusformat.org
+-->
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXactuator" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+    <doc>
+         An actuator used to control an external condition.
+
+         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
+        </doc>
+    </field>
+    <field name="short_name">
+        <doc>
+             Short name of actuator used e.g. on monitor display program
+        </doc>
+    </field>
+    <field name="attached_to">
+        <doc>
+             Describe where the actuator is attached to.
+             This could be an instance of NXsample or a device on NXinstrument.
+        </doc>
+    </field>
+    <field name="physical_quantity">
+        <doc>
+             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
+        </doc>
+    </field>
+    <field name="type">
+        <doc>
+             The type of hardware used for the actuation.
+
+             Examples (suggestions, but not restrictions):
+
+             :Temperature: laser | gas lamp | filament | resistive
+             :Pressure: anvil cell
+             :Voltage: potentiostat
+        </doc>
+    </field>
+    <field name="OUTPUT" type="NX_FLOAT" units="NX_ANY">
+        <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>
+             Refers to the last transformation specifying the position of the actuator
+             in the NXtransformations chain.
+        </doc>
+    </field>
+    <group type="NXtransformations">
+        <doc>
+             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.
+        </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>