.. role:: ts-api-decorator

##########
ResultInfo
##########

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

.. container:: ts-api-section

   .. js:class:: ResultInfo

      Information about a result, including its id and name.



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~cee.ug.ResultInfo.baseResultId`
   * :js:attr:`~cee.ug.ResultInfo.baseResultType`
   * :js:attr:`~cee.ug.ResultInfo.deriveOperation`
   * :js:attr:`~cee.ug.ResultInfo.id`
   * :js:attr:`~cee.ug.ResultInfo.idString`
   * :js:attr:`~cee.ug.ResultInfo.mapping`
   * :js:attr:`~cee.ug.ResultInfo.name`
   * :js:attr:`~cee.ug.ResultInfo.resultCalculatorId`
   * :js:attr:`~cee.ug.ResultInfo.resultType`
   * :js:attr:`~cee.ug.ResultInfo.unit`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: ResultInfo.baseResultId

      :type: number

      If the result is derived from a base result (e.g. tensor), baseResultId describes the id of the origin result.



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.baseResultType

      :type: ResultType

      If the result is derived from a base result (e.g. tensor), baseResultType describes the type of the origin result.



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.deriveOperation

      :type: DeriveOperation

      If the result is derived from a base result (e.g. tensor), deriveOperation describes how the result was derived from the base result.



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.id

      :type: number

      The id of the result.



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.idString

      :type: string

      The persistent string id of the result.

      This is a persistent ID of the result that will not change between versions of EnvisionWeb, and can thus be used to store setting regarding results. 
      The id of the result might change in future versions of EnvisionWeb, and is only guaranteed to be constant in a given version.

      Use the ``ModelDirectory.getResultInfoByIdString`` method to find result infos based on the idString.



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.mapping

      :type: ResultMapping

      Result position (mapping) of the result



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.name

      :type: string

      The name of the result.



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.resultCalculatorId

      :type: string

      If non empty, the ID of the result calculator producing this result



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.resultType

      :type: ResultType

      The result type  (scalar, vector, displacement)



.. container:: ts-api-section

   .. js:attribute:: ResultInfo.unit

      :type: string

      The unit of the results (if available).



