.. role:: ts-api-decorator

#########
StateInfo
#########

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: StateInfo

      Information about a data state

      States are uniquely identified by the id.



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.ug.StateInfo.displacementResultIdArr`
   * :js:attr:`~cee.ug.StateInfo.id`
   * :js:attr:`~cee.ug.StateInfo.name`
   * :js:attr:`~cee.ug.StateInfo.referenceValue`
   * :js:attr:`~cee.ug.StateInfo.scalarResultIdArr`
   * :js:attr:`~cee.ug.StateInfo.vectorResultIdArr`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: StateInfo.displacementResultIdArr

      :type: [number]

      Defines which scalar results are available in this state. Empty = all results are available.



.. container:: ts-api-section

   .. js:attribute:: StateInfo.id

      :type: number

      The id of the state. This id is used in ``ModelSpec.stateIdArray`` to specify which state(s) to show. Ids are >= 0.



.. container:: ts-api-section

   .. js:attribute:: StateInfo.name

      :type: string

      The name of the state



.. container:: ts-api-section

   .. js:attribute:: StateInfo.referenceValue

      :type: number

      The reference value of the state. Often simulation time, but can also be frequency for frequency domain simulations.



.. container:: ts-api-section

   .. js:attribute:: StateInfo.scalarResultIdArr

      :type: [number]

      Defines which scalar results are available in this state. Empty = all results are available.



.. container:: ts-api-section

   .. js:attribute:: StateInfo.vectorResultIdArr

      :type: [number]

      Defines which scalar results are available in this state. Empty = all results are available.



