.. role:: ts-api-decorator

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

.. js:module:: cee.cug
   :noindex:

.. container:: ts-api-section

   .. js:class:: ModelSpec

      Information about the results used on the model.

      Provides ids of the scalar, vector, displacements results mapped onto the model.



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~cee.cug.ModelSpec.contourLinesResultId`
   * :js:attr:`~cee.cug.ModelSpec.displacementResultId`
   * :js:attr:`~cee.cug.ModelSpec.fringesResultId`
   * :js:attr:`~cee.cug.ModelSpec.vectorResultIdArr`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~cee.cug.ModelSpec.getEffectiveFringesResultId`





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

Accessors
=========

.. container:: ts-api-section

   .. js:function:: ModelSpec.contourLinesResultId()



      The result id of the scalar shown as fringes (mapped on the surface) on the model.

      Use the ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ModelSpec.displacementResultId()



      The result id of the scalar shown as fringes (mapped on the surface) on the model.

      Use the ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ModelSpec.fringesResultId()



      The result id of the scalar shown as fringes (mapped on the surface) on the model.

      Use the ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: ModelSpec.vectorResultIdArr()



      The result id of the scalar shown as fringes (mapped on the surface) on the model.

      Use the ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


      :rtype: unknown



Methods
=======

.. rst-class:: ts-api-section

getEffectiveFringesResultId
---------------------------

.. js:method:: ModelSpec.getEffectiveFringesResultId( geometryIndex, partId)

   :param geometryIndex: None
   :type geometryIndex: number
   :param partId: None
   :type partId: 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 ``ConstantRemoteModel.getResultInfo`` method to get information about the result.


   :rtype: number

