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

.. index::
    ! NXactivity (base class)
    ! activity (base class)
    see: activity (base class); NXactivity

.. _NXactivity:

==========
NXactivity
==========

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: A planned or unplanned action that has a temporal extension and for some time de ...

      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.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXnote`

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

**Structure**:

  .. _/NXactivity/start_time-field:

  .. index:: start_time (field)

  **start_time**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>` 

    .. collapse:: ISO 8601 formatted time code (with local time zone offset to UTC information ...

        ISO 8601 formatted time code (with local time zone offset to UTC information
        included) when this activity started.

  .. _/NXactivity/end_time-field:

  .. index:: end_time (field)

  **end_time**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>` 

    .. collapse:: ISO 8601 formatted time code (with local time zone offset to UTC information ...

        ISO 8601 formatted time code (with local time zone offset to UTC information
        included) when this activity ended.

  .. _/NXactivity/description-field:

  .. index:: description (field)

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

    Short description of the activity.

  .. _/NXactivity/notes-group:

  **notes**: (optional) :ref:`NXnote` 

    .. collapse:: This can be any data or other descriptor acquired during the activity ...

        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.


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

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


* :ref:`/NXactivity/description-field </NXactivity/description-field>`
* :ref:`/NXactivity/end_time-field </NXactivity/end_time-field>`
* :ref:`/NXactivity/notes-group </NXactivity/notes-group>`
* :ref:`/NXactivity/start_time-field </NXactivity/start_time-field>`

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