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

.. index::
    ! NXcs_storage (base class)
    ! cs_storage (base class)
    see: cs_storage (base class); NXcs_storage

.. _NXcs_storage:

============
NXcs_storage
============

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  Base class for reporting the description of the I/O of a computer.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXcs_storage/CIRCUIT-group:

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


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

    .. index:: type (field)

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

      .. collapse:: Qualifier for the type of storage medium used. ...

          Qualifier for the type of storage medium used.

          Any of these values:

            * ``solid_state_disk``

            * ``hard_disk``

            * ``optical``

            * ``tape``


    .. _/NXcs_storage/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.

    .. _/NXcs_storage/CIRCUIT/max_read_rate-field:

    .. index:: max_read_rate (field)

    **max_read_rate**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

      Maximum read rate of the storage medium.

    .. _/NXcs_storage/CIRCUIT/max_write_rate-field:

    .. index:: max_write_rate (field)

    **max_write_rate**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

      Maximum write rate of the storage medium.


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

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


* :ref:`/NXcs_storage/CIRCUIT-group </NXcs_storage/CIRCUIT-group>`
* :ref:`/NXcs_storage/CIRCUIT/max_physical_capacity-field </NXcs_storage/CIRCUIT/max_physical_capacity-field>`
* :ref:`/NXcs_storage/CIRCUIT/max_read_rate-field </NXcs_storage/CIRCUIT/max_read_rate-field>`
* :ref:`/NXcs_storage/CIRCUIT/max_write_rate-field </NXcs_storage/CIRCUIT/max_write_rate-field>`
* :ref:`/NXcs_storage/CIRCUIT/type-field </NXcs_storage/CIRCUIT/type-field>`

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