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

.. index::
    ! NXprogram (base class)
    ! program (base class)
    see: program (base class); NXprogram

.. _NXprogram:

=========
NXprogram
=========

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Base class to describe a software tool or library.

**Symbols**:

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

**Groups cited**:
  none

**Structure**:

  .. _/NXprogram/program_name-field:

  .. index:: program_name (field)

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

    Reference to or definition of a coordinate system with
    which the positions and directions are interpretable.

  .. _/NXprogram/program-field:

  .. index:: program (field)

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

    Commercial, parser, or otherwise given name to the program.

    .. _/NXprogram/program@version-attribute:

    .. index:: version (field attribute)

    **@version**: (optional) :ref:`NX_CHAR <NX_CHAR>`

      Program version plus build number, or commit hash.

    .. _/NXprogram/program@url-attribute:

    .. index:: url (field attribute)

    **@url**: (optional) :ref:`NX_CHAR <NX_CHAR>`

      Description of an ideally ever persistent resource where the source code
      of the program or this specific compiled version of the program can be
      found so that the program yields repeatably exactly the same numerical
      and categorical results.


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

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


* :ref:`/NXprogram/program-field </NXprogram/program-field>`
* :ref:`/NXprogram/program@url-attribute </NXprogram/program@url-attribute>`
* :ref:`/NXprogram/program@version-attribute </NXprogram/program@version-attribute>`
* :ref:`/NXprogram/program_name-field </NXprogram/program_name-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXprogram.nxdl.xml