Structure

Detailed Description

group a3d_feature_structure_module

The feature structure allows to store information with various levels of complexity.

The hierarchy structures the data from a simple double/integer storage to a CAD feature information. It contains different types of sub-features grouped under feature parameters, depending of its family type. The family type (m_eFamily) specifies the way to interpret the type (m_uiType) as an enumeration value.

The following table shows the correspondence between the family type and the associated enum; and the expected data structure defined below.

Family Corresponding enum Description
Information
Type EA3DFRMEnumDataType Store a value of an enumeration (CAD type, depth type, …) ../../_images/frm_data.png

Double Data,

Integer Data,

String Data 		EA3DFRMDoubleDataType, EA3DFRMIntegerDataType, EA3DFRMStringDataType Type of double data (unit, offset, diameter, …)../../_images/frm_type.png
Value EA3DFRMValueType Type of complex feature (Vector, Depth, …)../../_images/frm_value.png
Definition EA3DFRMDefinitionType Type of complex feature (Vector, Depth, …)../../_images/frm_definition.png

Definition Hole,

Definition Pattern

 EA3DFRMDefinitionHoleType, EA3DFRMDefinitionPatternType Type of complex feature defining a hole (counter sunk, counter bore, …) or pattern../../_images/frm_specific_definition.png
Feature Definition EA3DFRMFeatureDefinitionType Store an information specific to a CAD feature (hole, pattern, extrusion, definition)../../_images/frm_feature_definition.png
Root EA3DFRMRoot Corresponds to the CAD node ../../_images/frm_root.png

Function Documentation

A3DStatus A3DFRMFeatureGet(const A3DFRMFeature *pFeature, A3DFRMFeatureData *pData)

Populate the A3DFRMFeatureData structure.

Version
10.2

Parameters:
  • pFeature – feature pointer
  • pData – feature data
Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_ERROR –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure
A3DStatus A3DFRMGeomEntitiesExtract(const A3DFRMFeature *pFeature, A3DFRMGeomEntitiesData *pFeatureGeomEntities)

Create on the fly geometries related to the feature.

Version
12.2

Parameters:
  • pFeature – feature pointer
  • pFeatureGeomEntities – struct containing the array of extracted geometries
Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_INITIALIZE_NOT_CALLED –
  • A3D_ERROR –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure