.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source ../../../../base_classes/NXroot.nxdl.xml

.. index::
    ! NXroot (base class)
    ! root (base class)
    see: root (base class); NXroot

.. _NXroot:

======
NXroot
======

**Status**:

  base class, extends :ref:`NXobject`, version 1.0

**Description**:

  Definition of the root NeXus group.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXentry`

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

**Structure**:

  .. index:: NX_class (attribute)

  **@NX_class**: :ref:`NX_CHAR <NX_CHAR>`

    The root of any NeXus data file is an NXroot class 
    (no other choice is allowed for a valid NeXus data file).  
    This attribute cements that definition.

    Obligatory value:  ``NXroot``

  .. index:: file_time (attribute)

  **@file_time**: :ref:`NX_CHAR <NX_CHAR>`

    Date and time file was originally created

  .. index:: file_name (attribute)

  **@file_name**: :ref:`NX_CHAR <NX_CHAR>`

    File name of original NeXus file

  .. index:: file_update_time (attribute)

  **@file_update_time**: :ref:`NX_CHAR <NX_CHAR>`

    Date and time of last file change at close

  .. index:: NeXus_version (attribute)

  **@NeXus_version**: :ref:`NX_CHAR <NX_CHAR>`

    Version of NeXus API used in writing the file

  .. index:: HDF_version (attribute)

  **@HDF_version**: :ref:`NX_CHAR <NX_CHAR>`

    Version of NeXus API used in writing the file

  .. index:: HDF5_Version (attribute)

  **@HDF5_Version**: :ref:`NX_CHAR <NX_CHAR>`

    Version of NeXus API used in writing the file.
    Note this attribute is spelled with uppercase "V",
    different than other version attributes.

  .. index:: XML_version (attribute)

  **@XML_version**: :ref:`NX_CHAR <NX_CHAR>`

    Version of NeXus API used in writing the file

  .. index:: creator (attribute)

  **@creator**: :ref:`NX_CHAR <NX_CHAR>`

    facility or program where file originated

  **(entry)**: :ref:`NXentry`

    entries

**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXroot.nxdl.xml