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

.. index::
    ! NXcs_memory (base class)
    ! cs_memory (base class)
    see: cs_memory (base class); NXcs_memory

.. _NXcs_memory:

===========
NXcs_memory
===========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  Base class for reporting the description of the memory system of a computer.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXcircuit`

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

**Structure**:

  .. _/NXcs_memory/CIRCUIT-group:

  :bolditalic:`CIRCUIT`: (optional) :ref:`NXcircuit` 

    Typically, computers have multiple instances of memory.

    .. _/NXcs_memory/CIRCUIT/type-field:

    .. index:: type (field)

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

      .. collapse:: Qualifier for the type of random access memory. ...

          Qualifier for the type of random access memory.

          Any of these values or a custom value (if you use a custom value, also set @custom=True): ``ddr4`` | ``ddr5``

    .. _/NXcs_memory/CIRCUIT/max_physical_capacity-field:

    .. index:: max_physical_capacity (field)

    **max_physical_capacity**: (optional) :ref:`NX_POSINT <NX_POSINT>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

      Total amount of data which the medium can hold.


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

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


* :ref:`/NXcs_memory/CIRCUIT-group </NXcs_memory/CIRCUIT-group>`
* :ref:`/NXcs_memory/CIRCUIT/max_physical_capacity-field </NXcs_memory/CIRCUIT/max_physical_capacity-field>`
* :ref:`/NXcs_memory/CIRCUIT/type-field </NXcs_memory/CIRCUIT/type-field>`

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