Structure

Types

A3DFRMFeatureData

A3DFRMGeomEntitiesData

Functions

A3DStatus

A3DFRMFeatureGet

A3DStatus

A3DFRMGeomEntitiesExtract

Detailed Description

group a3d_feature_structure_module

The feature is a structure that 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. Depending of their Family type what they embed different types of sub-features, group under feature parameters. Also the pair m_eFamily and m_uiType allows to figure out what represents data underneath. The family type specifies the way to interpret the type. The type is an integer that need to be interpreted as a value in an enum specify by the family type.

The following table shows the correspondence between the family type and the associated enum; and the expecetd data defined below a feature with this type of feature.

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, …)../_images/frm_specific_definition.png

Feature Definition

EA3DFRMFeatureDefinitionType

Store an information specific to a cad feature (hole, patter, extrude, definition)../_images/frm_feature_definition.png

Root

EA3DFRMRoot

Corresponds to cad node ../_images/frm_root.png

Function Documentation

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

brief Populates 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 in case of success or an error code

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 in case of success or an error code