
#########
FrameInfo
#########

.. js:class:: cee.cug.FrameInfo

   Information about each frame in the ConstantRemoteModel
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.cug.FrameInfo.fringesMaximumValue`
   * :js:func:`~cee.cug.FrameInfo.fringesMinimumValue`
   * :js:func:`~cee.cug.FrameInfo.name`
   * :js:func:`~cee.cug.FrameInfo.referenceValue`
   * :js:func:`~cee.cug.FrameInfo.stateId`
   
   



.. rst-class:: kind-group kind-accessors

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


.. js:method:: cee.cug.FrameInfo.fringesMaximumValue

      .. rst-class:: sig-pretty-signature
      
         | *get* fringesMaximumValue(): *number*
      
      Maximum value of the scalar result shown as fringes on the model in this frame
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.FrameInfo.fringesMinimumValue

      .. rst-class:: sig-pretty-signature
      
         | *get* fringesMinimumValue(): *number*
      
      Minimum value of the scalar result shown as fringes on the model in this frame
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.FrameInfo.name

      .. rst-class:: sig-pretty-signature
      
         | *get* name(): *string*
      
      The name of the current frame
      
      **Returns**\ : *string*
      



.. js:method:: cee.cug.FrameInfo.referenceValue

      .. rst-class:: sig-pretty-signature
      
         | *get* referenceValue(): *number*
      
      The reference value of the current frame
      
      The reference value is provided by the CAE reader/data provider and is simulation specific.
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.FrameInfo.stateId

      .. rst-class:: sig-pretty-signature
      
         | *get* stateId(): *number*
      
      The state id of the current frame
      
      **Returns**\ : *number*
      




