.. role:: clio-readonly
   :class: clio-flag clio-flag-readonly


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

.. js:class:: cee.ug.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.
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.ug.PartInfo.boundaryCondition`
   * :js:data:`~cee.ug.PartInfo.geometryIndex`
   * :js:data:`~cee.ug.PartInfo.name`
   * :js:data:`~cee.ug.PartInfo.parentPartId`
   * :js:data:`~cee.ug.PartInfo.partDataArr`
   * :js:data:`~cee.ug.PartInfo.partId`
   
   



.. rst-class:: kind-group kind-properties

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


.. js:data:: cee.ug.PartInfo.boundaryCondition

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | boundaryCondition: *boolean*
      
      True if the part is a boundary condition part
      



.. js:data:: cee.ug.PartInfo.geometryIndex

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | geometryIndex: *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.
      



.. js:data:: cee.ug.PartInfo.name

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | name: *string*
      
      The name of the part
      



.. js:data:: cee.ug.PartInfo.parentPartId

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | parentPartId: *number*
      
      The id of the parent part. -1 if none
      



.. js:data:: cee.ug.PartInfo.partDataArr

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | partDataArr: readonly { key: *string*\ , value: *string* }[]
      
      Additional key,value info describing the part
      



.. js:data:: cee.ug.PartInfo.partId

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | partId: *number*
      
      The unique (within the geometry) id of the part. Part ids are >= 0.
      




