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

.. index::
    ! NXcs_computer (base class)
    ! cs_computer (base class)
    see: cs_computer (base class); NXcs_computer

.. _NXcs_computer:

=============
NXcs_computer
=============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Base class for reporting the description of a computer

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXcs_memory`, :ref:`NXcs_processor`, :ref:`NXcs_storage`

.. index:: NXcs_processor (base class); used in base class, NXcs_memory (base class); used in base class, NXcs_storage (base class); used in base class

**Structure**:

  .. _/NXcs_computer/name-field:

  .. index:: name (field)

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

    Given name/alias to the computing system, e.g. MyDesktop.

  .. _/NXcs_computer/operating_system-field:

  .. index:: operating_system (field)

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

    Name of the operating system, e.g. Windows, Linux, Mac, Android.

    .. _/NXcs_computer/operating_system@version-attribute:

    .. index:: version (field attribute)

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

      .. collapse:: Version plus build number, commit hash, or description of an ever ...

          Version plus build number, commit hash, or description of an ever
          persistent resource where the source code of the program and build
          instructions can be found so that the program can be configured in
          such a manner that the result file is ideally recreatable yielding
          the same results.

  .. _/NXcs_computer/uuid-field:

  .. index:: uuid (field)

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

    .. collapse:: A globally unique persistent identifier of the computer, i.e. ...

        A globally unique persistent identifier of the computer, i.e.
        the Universally Unique Identifier (UUID) of the computing node.

  .. _/NXcs_computer/processorID-group:

  **processor**\ :bolditalic:`ID`: (optional) :ref:`NXcs_processor` 

    Multiple instances should be named processor1, processor2, etc.

  .. _/NXcs_computer/memoryID-group:

  **memory**\ :bolditalic:`ID`: (optional) :ref:`NXcs_memory` 

    Multiple instances should be named memory1, memory2, etc.

  .. _/NXcs_computer/storageID-group:

  **storage**\ :bolditalic:`ID`: (optional) :ref:`NXcs_storage` 

    Multiple instances should be named storage1, storage2, etc.


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

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


* :ref:`/NXcs_computer/memoryID-group </NXcs_computer/memoryID-group>`
* :ref:`/NXcs_computer/name-field </NXcs_computer/name-field>`
* :ref:`/NXcs_computer/operating_system-field </NXcs_computer/operating_system-field>`
* :ref:`/NXcs_computer/operating_system@version-attribute </NXcs_computer/operating_system@version-attribute>`
* :ref:`/NXcs_computer/processorID-group </NXcs_computer/processorID-group>`
* :ref:`/NXcs_computer/storageID-group </NXcs_computer/storageID-group>`
* :ref:`/NXcs_computer/uuid-field </NXcs_computer/uuid-field>`

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