.. _group__a3d__product__flag:

##################################################
Bit field flag definitions for product occurrences
##################################################

The product flags are used to define the specific usages of a product occurrence.

They are set in :c:member:`A3DAsmProductOccurrenceData::m_uiProductFlags <A3DAsmProductOccurrenceData.m_uiProductFlags>`\ . This field can be a combinaison of more than one flag if they describe several usages at once. Such usages can be:


Configuration
=============

A configuration is a specific arrangement of a product with respect to its whole hierarchy.

With SolidWorks the model data inside the configuration node may be missing. In that case the flag ``A3D_PRODUCT_FLAG_CONFIG_NOT_UPDATED`` is also set.



Container
=========

A container product occurrence acts as a repository of product occurrences that are not necessarily related to each other. This is useful for situations where a single CAD file corresponds to a whole database of parts and assemblies.



Default
=======

When a product occurrence is marked as default, it means the originating CAD environment loads it by default. This flag is applicable to containers, configurations and views.



Internal
========

When a product occurrence is a prototype with no father it is flagged as internal. It then represents a sub-assembly root or a part root inside the main assembly.



View
====

A view refers to its prototype to denote a particular setting of visibilities and positions.



Suppressed
==========

When a product occurrence is marked as suppressed its children are not loaded.

In case of CREO files, this flag is set when the Family Table is not used or when the geometry contains boolean operations that are not supported by HOOPS Exchange.



External Reference
==================

External Reference is a specific flag currently used for STEP/XML. In this format, when a node initially refers to an external part, it is flagged as External Reference. For more information, see `the STEP/XML reader page <https://docs.techsoft3d.com/exchange/latest/start/format/stepxml_reader.html>`__\ .

If none of these flags is specified, a product occurrence is regular. If the product occurrence has no father, it is similar to a configuration.


   The flags of a product occurrence may contain internal, undocumented values that should not be used.



   2.1



.. rst-class:: kind-group kind-preprocessor-definition

.. rubric:: Preprocessor Definitions
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:macro:`~A3D_PRODUCT_FLAG_BIM_BUILDING`
* :c:macro:`~A3D_PRODUCT_FLAG_BIM_CATEGORY`
* :c:macro:`~A3D_PRODUCT_FLAG_BIM_COMPONENT`
* :c:macro:`~A3D_PRODUCT_FLAG_BIM_LEVEL`
* :c:macro:`~A3D_PRODUCT_FLAG_BIM_PROJECT`
* :c:macro:`~A3D_PRODUCT_FLAG_BIM_SITE`
* :c:macro:`~A3D_PRODUCT_FLAG_CONFIG`
* :c:macro:`~A3D_PRODUCT_FLAG_CONFIG_NOT_UPDATED`
* :c:macro:`~A3D_PRODUCT_FLAG_CONTAINER`
* :c:macro:`~A3D_PRODUCT_FLAG_DEFAULT`
* :c:macro:`~A3D_PRODUCT_FLAG_EXTERNAL_REFERENCE`
* :c:macro:`~A3D_PRODUCT_FLAG_INTERNAL`
* :c:macro:`~A3D_PRODUCT_FLAG_SUPPRESSED`
* :c:macro:`~A3D_PRODUCT_FLAG_VIEW`


