.. role:: ts-api-decorator

##############
SimulationInfo
##############

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

.. container:: ts-api-section

   .. js:class:: SimulationInfo

      Meta data info for the current simulation

      The simulation info contains:

      -   A title
      -   A description
      -   A simulation type (structural, fluid, thermal,...)
      -   A solution type (static, steady state, transient, ...)
      -   The name of the interface/data provider providing this simulation (if any)



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~cee.ug.SimulationInfo.description`
   * :js:attr:`~cee.ug.SimulationInfo.fileInfo`
   * :js:attr:`~cee.ug.SimulationInfo.interfaceName`
   * :js:attr:`~cee.ug.SimulationInfo.simulationType`
   * :js:attr:`~cee.ug.SimulationInfo.solutionType`
   * :js:attr:`~cee.ug.SimulationInfo.title`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: SimulationInfo.description

      :type: string

      The description of the simulation shown in the model



.. container:: ts-api-section

   .. js:attribute:: SimulationInfo.fileInfo

      :type: FileInfo

      File specific metadata for VTFx simulation.



.. container:: ts-api-section

   .. js:attribute:: SimulationInfo.interfaceName

      :type: string

      The name of the interface/data provider of this simulation (if any)



.. container:: ts-api-section

   .. js:attribute:: SimulationInfo.simulationType

      :type: string

      The simulation type of the source model.

      Possible values:
      Structural, Thermal, Electric, Magnetic, Fluid, Acoustic, Diffusion, Other



.. container:: ts-api-section

   .. js:attribute:: SimulationInfo.solutionType

      :type: string

      The solution type of the source model.

      Possible values:
      Static, Steady State, Vibration, Buckling, Transient, Superelement, Frequency response, 
      Complex eigenvalues, Quasi Static, Output, Singular, Other



.. container:: ts-api-section

   .. js:attribute:: SimulationInfo.title

      :type: string

      The title of the simulation shown in the model



