.. role:: clio-readonly
   :class: clio-flag clio-flag-readonly


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

.. js:class:: cee.ug.StateInfo

   Information about a data state
   
   States are uniquely identified by the id.
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.ug.StateInfo.displacementResultIdArr`
   * :js:data:`~cee.ug.StateInfo.id`
   * :js:data:`~cee.ug.StateInfo.name`
   * :js:data:`~cee.ug.StateInfo.referenceValue`
   * :js:data:`~cee.ug.StateInfo.scalarResultIdArr`
   * :js:data:`~cee.ug.StateInfo.vectorResultIdArr`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.ug.StateInfo.displacementResultIdArr

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | displacementResultIdArr: *number*\ []
      
      Defines which scalar results are available in this state. Empty = all results are available.
      



.. js:data:: cee.ug.StateInfo.id

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | id: *number*
      
      The id of the state. This id is used in :js:func:`ModelSpec.stateIdArray <cee.ug.ModelSpec.stateIdArray>` to specify which state(s) to show. Ids are >= 0.
      



.. js:data:: cee.ug.StateInfo.name

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | name: *string*
      
      The name of the state
      



.. js:data:: cee.ug.StateInfo.referenceValue

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | referenceValue: *number*
      
      The reference value of the state. Often simulation time, but can also be frequency for frequency domain simulations.
      



.. js:data:: cee.ug.StateInfo.scalarResultIdArr

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | scalarResultIdArr: *number*\ []
      
      Defines which scalar results are available in this state. Empty = all results are available.
      



.. js:data:: cee.ug.StateInfo.vectorResultIdArr

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | vectorResultIdArr: *number*\ []
      
      Defines which scalar results are available in this state. Empty = all results are available.
      




