
#########
ModelSpec
#########

.. js:class:: cee.cug.ModelSpec

   Information about the results used on the model.
   
   Provides ids of the scalar, vector, displacements results mapped onto the model.
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.cug.ModelSpec.contourLinesResultId`
   * :js:func:`~cee.cug.ModelSpec.displacementResultId`
   * :js:func:`~cee.cug.ModelSpec.fringesResultId`
   * :js:func:`~cee.cug.ModelSpec.vectorResultIdArr`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.cug.ModelSpec.getEffectiveFringesResultId`
   
   



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

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


.. js:method:: cee.cug.ModelSpec.contourLinesResultId

      .. rst-class:: sig-pretty-signature
      
         | *get* contourLinesResultId(): *number*
      
      The result id of the scalar shown as fringes (mapped on the surface) on the model.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.ModelSpec.displacementResultId

      .. rst-class:: sig-pretty-signature
      
         | *get* displacementResultId(): *number*
      
      The result id of the scalar shown as fringes (mapped on the surface) on the model.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.ModelSpec.fringesResultId

      .. rst-class:: sig-pretty-signature
      
         | *get* fringesResultId(): *number*
      
      The result id of the scalar shown as fringes (mapped on the surface) on the model.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Returns**\ : *number*
      



.. js:method:: cee.cug.ModelSpec.vectorResultIdArr

      .. rst-class:: sig-pretty-signature
      
         | *get* vectorResultIdArr(): readonly  *number*\ []
      
      The result id of the scalar shown as fringes (mapped on the surface) on the model.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Returns**\ : readonly  *number*\ []
      



.. rst-class:: kind-group kind-methods

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


.. js:method:: cee.cug.ModelSpec.getEffectiveFringesResultId

      .. rst-class:: sig-pretty-signature
      
         | getEffectiveFringesResultId(**geometryIndex**\ : *number*\ , **partId**\ : *number*\ ): *number*
      
      Returns the id of the scalar result shown on the given part. Will return fringesResultId if no override result was specified for the given part.
      
      Use the :js:meth:`ConstantRemoteModel.getResultInfo <cee.cug.ConstantRemoteModel.getResultInfo>` method to get information about the result.
      
      **Parameters**
      
      
         **geometryIndex**\ : *number*
      
         **partId**\ : *number*
      
      
      **Returns**\ : *number*
      




