.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/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 a super class for all other activities.

**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>` 

    Start time of this activity. It is recommended to include local time zone information.

  .. _/NXactivity/end_time-field:

  .. index:: end_time (field)

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

    End time of this activity. It is recommended to include local time zone information.

    .. _/NXactivity/end_time@estimated-attribute:

    .. index:: estimated (field attribute)

    **@estimated**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>` 

      .. collapse:: In some cases, the end time of an activity can only be estimated. In this ca ...

          In some cases, the end time of an activity can only be estimated. In this case,
          this attribute shall be True.

  .. _/NXactivity/description-field:

  .. index:: description (field)

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

    Short description of the activity.

  .. _/NXactivity/NOTE-group:

  :bolditalic:`NOTE`: (optional) :ref:`NXnote` :ref:`⤆ </NXobject/NOTE-group>`

    .. 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.

        Any number of instances of :ref:`NXnote` are allowed for describing extra details of
        this activity.


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/end_time@estimated-attribute </NXactivity/end_time@estimated-attribute>`
* :ref:`/NXactivity/NOTE-group </NXactivity/NOTE-group>`
* :ref:`/NXactivity/start_time-field </NXactivity/start_time-field>`

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