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

.. index::
    ! NXcollection (base class)
    ! collection (base class)
    see: collection (base class); NXcollection

.. _NXcollection:

============
NXcollection
============

**Status**:

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

**Description**:

  Use ``NXcollection`` to gather together any set of terms.
  The original suggestion is to use this as a container 
  class for the description of a beamline.

  For NeXus validation, ``NXcollection`` will always generate 
  a warning since it is always an optional group.  
  Anything (groups, fields, or attributes) placed in
  an ``NXcollection`` group will not be validated.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. index:: beamline (data field)

  **beamline**: :ref:`NX_CHAR <NX_CHAR>`

    name of the beamline for this collection

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