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

.. index::
    ! NXms_snapshot (base class)
    ! ms_snapshot (base class)
    see: ms_snapshot (base class); NXms_snapshot

.. _NXms_snapshot:

=============
NXms_snapshot
=============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Base class for data on the state of the microstructure at a given time/iteration.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays.

**Groups cited**:
  none

**Structure**:

  .. _/NXms_snapshot/comment-field:

  .. index:: comment (field)

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

    Is this time for a measurement or a simulation.

    Any of these values: ``measurement`` | ``simulation``

  .. _/NXms_snapshot/time-field:

  .. index:: time (field)

  **time**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_TIME <NX_TIME>`}

    Measured or simulated physical time stamp for this snapshot.
    Not to be confused with wall-clock timing or profiling data.

  .. _/NXms_snapshot/iteration-field:

  .. index:: iteration (field)

  **iteration**: (optional) :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

    Iteration or increment counter.


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

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


* :ref:`/NXms_snapshot/comment-field </NXms_snapshot/comment-field>`
* :ref:`/NXms_snapshot/iteration-field </NXms_snapshot/iteration-field>`
* :ref:`/NXms_snapshot/time-field </NXms_snapshot/time-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXms_snapshot.nxdl.xml