.. role:: ts-api-decorator

########
PartInfo
########

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

.. container:: ts-api-section

   .. js:class:: PartInfo

      The id and name of a part, and the index of the geometry it belongs to.

      Parts are uniquely identified by the combination of geometry index and part id.



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~cee.ug.PartInfo.boundaryCondition`
   * :js:attr:`~cee.ug.PartInfo.geometryIndex`
   * :js:attr:`~cee.ug.PartInfo.name`
   * :js:attr:`~cee.ug.PartInfo.parentPartId`
   * :js:attr:`~cee.ug.PartInfo.partDataArr`
   * :js:attr:`~cee.ug.PartInfo.partId`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: PartInfo.boundaryCondition

      :type: boolean

      True if the part is a boundary condition part



.. container:: ts-api-section

   .. js:attribute:: PartInfo.geometryIndex

      :type: number

      The zero-based index of the geometry the part belongs to.
      In most cases there is only one geometry and this index will be zero.



.. container:: ts-api-section

   .. js:attribute:: PartInfo.name

      :type: string

      The name of the part



.. container:: ts-api-section

   .. js:attribute:: PartInfo.parentPartId

      :type: number

      The id of the parent part. -1 if none



.. container:: ts-api-section

   .. js:attribute:: PartInfo.partDataArr

      :type: unknown

      Additional key,value info describing the part



.. container:: ts-api-section

   .. js:attribute:: PartInfo.partId

      :type: number

      The unique (within the geometry) id of the part. Part ids are >= 0.



