.. role:: clio-deprecated
   :class: clio-flag clio-flag-deprecated


###########################
A3DAsmProductOccurrenceData
###########################

.. c:struct:: A3DAsmProductOccurrenceData

   A structure specifying product occurrence data.
   
   Global concepts definitions:
   
   
   - ModelFile: this is the top level of the assembly tree
   - ProductOccurrences: these are the intermediate nodes of the assembly tree. Each ProductOccurrence can hold a PartDefinition (see below), several ProductOccurrences as sons, a Prototype (see below) or an ExternalData (see below). Each one can carry its own unit.
   - Prototype: special case for a ProductOccurrence. A Prototype is a sub-assembly that might be modified outside the Modelfile. For instance, a CATProduct or a CATPart being referenced by a CATIA V5 assembly will be loaded as a Prototype, for the related physical file might change during design process. The whole internal hierarchy of this "file" can be explored from the Modelfile, as it was a classical ProductOccurrence, but any modification inside this sub-assembly will lead to an update of the whole Modelfile, in order to reference proper entities.
   - ExternalData: special case for a ProductOccurrence. an ExternalData is a sub-assembly that cannot be "managed" from the Modelfile. The corresponding Partdefinitions cannot be modified (color, visibility, position, etc.). For instance, this can be a IGES file being embedded in a CATproduct.
   - PartDefinition: this is the terminal level of an assembly. No "organized" hierarchy can be defined below that level. Only groups (refer to :c:type:`~A3DRiSet`\ definition) might be referenced as unorganized groups. A Partdefinition must be referenced in a Modelfile via a ProductOccurrence. Conversely, any terminal ProductOccurrence of a fully loaded Modelfile must refereence a PartDefinition.
   
   A product occurrence can have the following data:
   
   
   - PartDefinition: Pointer to the corresponding part definition. Can be NULL. See above.
   - ProductPrototype: Pointer to the corresponding product occurrence prototype. Can be NULL. See above.
   - ExternalData: Pointer to the corresponding external product occurrence. Can be NULL. See above.
   - Sons: Array of pointers to the son product occurrences. See above.
   - Location: Relative placement of the product occurrence in the father local coordinate system. Can be NULL.When applications interpret an assembly that uses subassemblies, they resolve links in the product prototype and external data entities and import the content described by those links. That is, those entities are resolved in the same way that software macros are resolved.
   
   In addition to the data described in the :c:struct:`~A3DAsmProductOccurrenceData`\ structure, an :c:type:`~A3DAsmProductOccurrence`\ entity can have attributes specified through the :c:type:`~A3DRootBase`\ and :c:type:`~A3DMiscCascadedAttributes`\ entities.
   
   For version 2.1, new fields were added to the end of this structure. These new fields are identified with the tag "version 2.1."
   
   
      2.0
   
   
   
   Sample code
   ===========
   
   The following pseudocode demonstrates how to get the external data of a product occurrence.
   
   
   ::
   
      POccurrence*functionGetExternalData(POccurrence*pocc)
      {
      Ifpocc->pExternalDataisnullandpocc->pPrototypeisnotnull
      ReturnGetExternalData(pocc->pPrototype)
      Else
      Returnpocc->pExternalData
      }
   
   The following pseudocode demonstrates how to get the part definition of a product occurrence.
   
   
   ::
   
      POccurrence*GetPart(POccurrence*pocc)
      {
      Ifpocc->pPartisnotnull
      Returnpocc->pPart
      
      POccurrence*po=pocc->pPrototype
      Whilepoisnotnull
      Ifpo->pPartisnotnull
      Returnpo->pPart
      Else
      po=po->pPrototype
      
      Ifpocc->uiPOccurrencesSize=0andGetExternalData(pocc)isnotnull
      ReturnGetExternalData(pocc)->pPart
      
      Returnnull
      }
   
   The following pseudocode demonstrates how to get the location of a product occurrence.
   
   
   ::
   
      CartesianTransfo*GetLocation(POccurrence*pocc)
      {
      IfGetExternalData(pocc)isnotnull
      IfGetExternalData(pocc)->pLocationisnotnull
      ReturnGetExternalData(pocc)->pLocation
      Ifpocc->pLocationisnullandpocc->pPrototypeisnotnull
      ReturnGetLocation(pocc->pPrototype)
      Returnpocc->pLocation
      }
   
   
      In case of multi-units assemblies, the unit must be applied to the matrix of the transformations.
   
   
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiPOccurrencesSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppPOccurrences`
   * :c:member:`~A3DAsmProductOccurrenceData.m_pPart`
   * :c:member:`~A3DAsmProductOccurrenceData.m_pPrototype`
   * :c:member:`~A3DAsmProductOccurrenceData.m_pExternalData`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ucBehaviour`
   * :c:member:`~A3DAsmProductOccurrenceData.m_pLocation`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiEntityReferenceSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppEntityReferences`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiAnnotationsSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppAnnotations`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiViewsSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppViews`
   * :c:member:`~A3DAsmProductOccurrenceData.m_pEntityFilter`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiDisplayFilterSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppDisplayFilters`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiSceneDisplayParameterSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_psSceneDisplayParameters`
   * :c:member:`~A3DAsmProductOccurrenceData.m_eProductLoadStatus`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiProductFlags`
   * :c:member:`~A3DAsmProductOccurrenceData.m_bUnitFromCAD`
   * :c:member:`~A3DAsmProductOccurrenceData.m_dUnit`
   * :c:member:`~A3DAsmProductOccurrenceData.m_dDensityVolumeUnit`
   * :c:member:`~A3DAsmProductOccurrenceData.m_dDensityMassUnit`
   * :c:member:`~A3DAsmProductOccurrenceData.m_eModellerType`
   * :c:member:`~A3DAsmProductOccurrenceData.m_bInactivateAnnotations`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiMaterialAndVisualisationSetupSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_psMaterialAndVisualisationSetup`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiCameraSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppCamera`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiFeatureBasedEntitiesSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppFeatureBasedEntities`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiConstraintsSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppConstraints`
   * :c:member:`~A3DAsmProductOccurrenceData.m_pPublicationSet`
   * :c:member:`~A3DAsmProductOccurrenceData.m_uiLayersSize`
   * :c:member:`~A3DAsmProductOccurrenceData.m_ppLayers`
   
   



.. rst-class:: kind-group kind-variable

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


.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiPOccurrencesSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppPOccurrences <A3DAsmProductOccurrenceData.m_ppPOccurrences>`\ .
      



.. c:member:: A3DAsmProductOccurrence** A3DAsmProductOccurrenceData.m_ppPOccurrences

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmProductOccurrence`\ \*\*
      
      Array of :c:type:`~A3DAsmProductOccurrence`\ references.
      



.. c:member:: A3DAsmPartDefinition* A3DAsmProductOccurrenceData.m_pPart

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmPartDefinition`\ \*
      
      Pointer to an :c:type:`~A3DAsmPartDefinition`\ entity.
      
      May be NULL.
      



.. c:member:: A3DAsmProductOccurrence* A3DAsmProductOccurrenceData.m_pPrototype

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmProductOccurrence`\ \*
      
      Pointer to a product prototype.
      
      May be NULL.
      



.. c:member:: A3DAsmProductOccurrence* A3DAsmProductOccurrenceData.m_pExternalData

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmProductOccurrence`\ \*
      
      Pointer to an external product.
      
      May be NULL.
      



.. c:member:: A3DUns8 A3DAsmProductOccurrenceData.m_ucBehaviour

      .. rst-class:: clio-flags
      
         :clio-deprecated:`deprecated`
      
      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns8`
      
      
      .. warning::
      
         This member is deprecated. It will be removed in version 2027.1.0.
      
      



.. c:member:: A3DMiscTransformation* A3DAsmProductOccurrenceData.m_pLocation

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DMiscTransformation`\ \*
      
      Pointer to an :c:type:`~A3DMiscCartesianTransformation`\ or :c:type:`~A3DMiscGeneralTransformation`\ entity.
      
      May be NULL.
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiEntityReferenceSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppEntityReferences <A3DAsmProductOccurrenceData.m_ppEntityReferences>`\ .
      



.. c:member:: A3DMiscEntityReference** A3DAsmProductOccurrenceData.m_ppEntityReferences

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DMiscEntityReference`\ \*\*
      
      Entity references.
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiAnnotationsSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppAnnotations <A3DAsmProductOccurrenceData.m_ppAnnotations>`\ .
      



.. c:member:: A3DMkpAnnotationEntity** A3DAsmProductOccurrenceData.m_ppAnnotations

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DMkpAnnotationEntity`\ \*\*
      
      Annotation entities stored under the current product occurrence.
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiViewsSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppViews <A3DAsmProductOccurrenceData.m_ppViews>`\ .
      



.. c:member:: A3DMkpView** A3DAsmProductOccurrenceData.m_ppViews

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DMkpView`\ \*\*
      
      Views stored under the current product occurrence.
      



.. c:member:: A3DAsmFilter* A3DAsmProductOccurrenceData.m_pEntityFilter

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmFilter`\ \*
      
      Pointer to a :c:type:`~A3DAsmFilter`\ .
      
      Used to manage the properties, like visibility, of entities directly owned by the current product occurrence, like the geometry contained in its :c:member:`m_pPart <A3DAsmProductOccurrenceData.m_pPart>`\ . May be NULL.
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiDisplayFilterSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppDisplayFilters <A3DAsmProductOccurrenceData.m_ppDisplayFilters>`\ .
      



.. c:member:: A3DAsmFilter** A3DAsmProductOccurrenceData.m_ppDisplayFilters

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmFilter`\ \*\*
      
      Array of Filter references that specify the filters to use for display.
      
      Several filters can be specified but only one is active.
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiSceneDisplayParameterSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_psSceneDisplayParameters <A3DAsmProductOccurrenceData.m_psSceneDisplayParameters>`\ .
      



.. c:member:: A3DGraphSceneDisplayParametersData* A3DAsmProductOccurrenceData.m_psSceneDisplayParameters

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DGraphSceneDisplayParametersData`\ \*
      
      Array of SceneDisplayParameters.
      



.. c:member:: A3DEProductLoadStatus A3DAsmProductOccurrenceData.m_eProductLoadStatus

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DEProductLoadStatus`
      
      Current load status for the ProductOccurrence, where values are defined by the :c:enum:`~A3DEProductLoadStatus`\ enum.
      
      
         2.1
      
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiProductFlags

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      Refer to :ref:`Bit field flag definitions for product occurrences <group__a3d__product__flag>`\ for explanations.
      
      
         2.1
      
      



.. c:member:: A3DBool A3DAsmProductOccurrenceData.m_bUnitFromCAD

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      Indicates whether :c:member:`m_dUnit <A3DAsmProductOccurrenceData.m_dUnit>`\ (below) was obtained from the native CAD file.
      
      
         2.1
      
      



.. c:member:: A3DDouble A3DAsmProductOccurrenceData.m_dUnit

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Unit.
      
      
         2.1
      
      



.. c:member:: A3DDouble A3DAsmProductOccurrenceData.m_dDensityVolumeUnit

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Volume unit used in the original CAD application for the physical material density :c:member:`A3DMiscMaterialPropertiesData::m_dDensity <A3DMiscMaterialPropertiesData.m_dDensity>`\ .
      
      1.0 refers to meter cube
      



.. c:member:: A3DDouble A3DAsmProductOccurrenceData.m_dDensityMassUnit

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Mass unit used in the original CAD application for the physical material density :c:member:`A3DMiscMaterialPropertiesData::m_dDensity <A3DMiscMaterialPropertiesData.m_dDensity>`\ .
      
      1.0 refers to kilogram
      



.. c:member:: A3DEModellerType A3DAsmProductOccurrenceData.m_eModellerType

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DEModellerType`
      
      The Modeller used to create the Model.
      
      Used only in Get method.
      



.. c:member:: A3DBool A3DAsmProductOccurrenceData.m_bInactivateAnnotations

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      If set to true, annotations are defined but inactivated in the product.
      
      
         7.0
      
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiMaterialAndVisualisationSetupSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_psMaterialAndVisualisationSetup <A3DAsmProductOccurrenceData.m_psMaterialAndVisualisationSetup>`\ .
      



.. c:member:: A3DMaterialAndVisualisationInfos* A3DAsmProductOccurrenceData.m_psMaterialAndVisualisationSetup

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DMaterialAndVisualisationInfos`\ \*
      
      MaterialAndVisualisation information to apply to the assembly tree, modified by assembly.
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiCameraSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppCamera <A3DAsmProductOccurrenceData.m_ppCamera>`\ .
      



.. c:member:: A3DGraphCamera** A3DAsmProductOccurrenceData.m_ppCamera

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DGraphCamera`\ \*\*
      
      Array of camera.
      
      This camera are referenced in the scene display parameters and the views of this Product occurrence.
      
      
         11.1
      
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiFeatureBasedEntitiesSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppFeatureBasedEntities <A3DAsmProductOccurrenceData.m_ppFeatureBasedEntities>`\ .
      



.. c:member:: A3DFRMTree** A3DAsmProductOccurrenceData.m_ppFeatureBasedEntities

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DFRMTree`\ \*\*
      
      Feature based entity, contains all information of feature.
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiConstraintsSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppConstraints <A3DAsmProductOccurrenceData.m_ppConstraints>`\ .
      
      
         14.0
      
      



.. c:member:: A3DAsmConstraint** A3DAsmProductOccurrenceData.m_ppConstraints

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmConstraint`\ \*\*
      
      List of the constraints define in this assembly.
      
      
         14.0
      
      



.. c:member:: A3DAsmPublicationSet* A3DAsmProductOccurrenceData.m_pPublicationSet

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmPublicationSet`\ \*
      
      Published elements.
      
      
         24.0
      
      



.. c:member:: A3DUns32 A3DAsmProductOccurrenceData.m_uiLayersSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppLayers <A3DAsmProductOccurrenceData.m_ppLayers>`\ .
      
      
         25.4
      
      



.. c:member:: A3DAsmLayer** A3DAsmProductOccurrenceData.m_ppLayers

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DAsmLayer`\ \*\*
      
      Array of layers.
      
      
         25.4
      
      




