Skip to content

Commit

Permalink
revert unintentional changes from cherry-pick
Browse files Browse the repository at this point in the history
pull in cited base classes

pull in cited base classes
  • Loading branch information
lukaspie committed Sep 23, 2024
1 parent 03f94d9 commit da28e00
Show file tree
Hide file tree
Showing 10 changed files with 795 additions and 602 deletions.
74 changes: 74 additions & 0 deletions base_classes/NXhistory.nxdl.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?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="NXhistory" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<doc>
A set of activities that occurred to a physical entity prior/during experiment.

Ideally, a full report of the previous operations (or links to a chain of operations).
Alternatively, notes allow for additional descriptors in any format.
</doc>
<group type="NXactivity">
<doc>
Any activity that was performed on the physical entity prior or during the experiment. In
the future, if there is base class inheritance, this can describe any activity,
including processes and measurements.
</doc>
</group>
<!--For now, one workaround would be to have NXactivity as a application definition with a subentry.
subentry(NXsuxbentry):
doc: |
Any activity that was performed on the physical entity prior or during the experiment.
definition: ["NXactivity"]-->
<group type="NXphysical_process">
<doc>
Any physical process that was performed on the physical entity prior or during the
experiment.
</doc>
</group>
<group type="NXchemical_process">
<doc>
Any chemical process that was performed on the physical entity prior or during the
experiment.
</doc>
</group>
<group type="NXidentifier">
<doc>
An ID or reference to the location or a unique (globally
persistent) identifier of e.g. another file which gives
as many as possible details of the history event.
</doc>
</group>
<!--There should be more activities here, like measurement.-->
<group name="notes" type="NXnote">
<doc>
A descriptor to keep track of the treatment of the physical entity before or during the
experiment (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.
This should only be used in case that there is no rigorous description
using the base classes above. This field can also be used to pull in any activities
that are not well described by an existing base class definition.
</doc>
</group>
</definition>
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<?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-2022 NeXus International Advisory Committee (NIAC)
#
#
# 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
Expand All @@ -21,18 +21,29 @@
#
# 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="NXsample_surface_dopant" extends="NXsample_component" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXidentifier" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<doc>
Description of a dopant material embedded in a sample surface.
An identifier for a (persistent) resource, e.g., a DOI or orcid.
</doc>
<field name="element">
<field name="service" type="NX_CHAR">
<doc>
The service by which the resource can be resolved.

Examples: doi, urn, hdl, purl, orcid, iso, url
</doc>
</field>
<field name="identifier" type="NX_CHAR">
<doc>
Element of evaporated surface dopant such as alkali or other
The unique code, IRI or hash to resolve this reference.
Typically, this is stated by the service which is considered a complete
identifier, e.g., for a DOI it's something of the form `10.1107/S1600576714027575`
or `https://doi.org/10.1107/S1600576714027575`, which are both resolvable.
</doc>
</field>
<field name="coverage" units="NX_LENGTH">
<field name="is_persistent" type="NX_BOOLEAN">
<doc>
Nominal thickness of the evaporated dopant.
True if the identifier is persistent (i.e., unique and available indefinitely),
False otherwise.
</doc>
</field>
</definition>
Loading

0 comments on commit da28e00

Please sign in to comment.