Type and Specification

Types

	A3DFRMTypeData
	`EA3DFRMEnumDataType`
	`EA3DFRMFamily`
	`EA3DFRMStatus`
	`EA3DFRMEnumValue_CadType`
	`EA3DFRMEnumValue_RevolveAngleType`
	`EA3DFRMEnumValue_FilletLengthType`
	`EA3DFRMEnumValue_LengthModeType`
	`EA3DFRMEnumValue_ReferenceMaster`

Fields

	`kA3DFRMEnumDataType_None`
	`kA3DFRMEnumDataType_CAD`
	`kA3DFRMEnumDataType_Mode`
	`kA3DFRMEnumDataType_Depth`
	`kA3DFRMEnumDataType_Pattern`
	`kA3DFRMEnumDataType_HoleShape`
	`kA3DFRMEnumDataType_DepthLevel`
	`kA3DFRMEnumDataType_RevolveAngle`
	`kA3DFRMEnumDataType_Chamfer`
	`kA3DFRMEnumDataType_Fillet`
	`kA3DFRMEnumDataType_FilletLength`
	`kA3DFRMEnumDataType_FilletConic`
	`kA3DFRMEnumDataType_LengthMode`
	`kA3DFRMEnumDataType_PatternMaster`
	`kA3DFRMEnumDataType_ReferenceMaster`
	`kA3DFamily_None`
	`kA3DFamily_Root`
	`kA3DFamily_Information`
	`kA3DFamily_Type`
	`kA3DFamily_FeatureDefinition`
	`kA3DFamily_DoubleData`
	`kA3DFamily_IntegerData`
	`kA3DFamily_StringData`
	`kA3DFamily_Value`
	`kA3DFamily_Definition`
	`kA3DFamily_Definition_Hole`
	`kA3DFamily_Definition_Pattern`
	`kA3DFamily_Definition_Thread`
	`kA3DFRMStatus_Success`
	`kA3DFRMStatus_Failed`
	`kA3DFRMStatus_NotYetImplemented`
	`kA3DFRMEnumValue_CadType_None`
	`kA3DFRMEnumValue_CadType_Sketch`
	`kA3DFRMEnumValue_CadType_Plane`
	`kA3DFRMEnumValue_CadType_Point`
	`kA3DFRMEnumValue_CadType_CoordinateSystem`
	`kA3DFRMEnumValue_CadType_Direction`
	`kA3DFRMEnumValue_CadType_Curve`
	`kA3DFRMEnumValue_CadType_Analysis`
	`kA3DFRMEnumValue_CadType_ImportedSolid`
	`kA3DFRMEnumValue_CadType_Extrusion`
	`kA3DFRMEnumValue_CadType_Revolution`
	`kA3DFRMEnumValue_CadType_Surface`
	`kA3DFRMEnumValue_CadType_Block`
	`kA3DFRMEnumValue_CadType_Sphere`
	`kA3DFRMEnumValue_CadType_Cone`
	`kA3DFRMEnumValue_CadType_Cylinder`
	`kA3DFRMEnumValue_CadType_Torus`
	`kA3DFRMEnumValue_CadType_Dome`
	`kA3DFRMEnumValue_CadType_Helix`
	`kA3DFRMEnumValue_CadType_TruncatedPrism`
	`kA3DFRMEnumValue_CadType_Hole`
	`kA3DFRMEnumValue_CadType_Chamfer`
	`kA3DFRMEnumValue_CadType_Blend`
	`kA3DFRMEnumValue_CadType_Fillet`
	`kA3DFRMEnumValue_CadType_Groove`
	`kA3DFRMEnumValue_CadType_Pocket`
	`kA3DFRMEnumValue_CadType_Sweep`
	`kA3DFRMEnumValue_CadType_Pipe`
	`kA3DFRMEnumValue_CadType_Group`
	`kA3DFRMEnumValue_CadType_Mirror`
	`kA3DFRMEnumValue_CadType_Pattern`
	`kA3DFRMEnumValue_CadType_GroupPattern`
	`kA3DFRMEnumValue_CadType_Instance`
	`kA3DFRMEnumValue_CadType_Package`
	`kA3DFRMEnumValue_CadType_Shell`
	`kA3DFRMEnumValue_CadType_Trim`
	`kA3DFRMEnumValue_CadType_Split`
	`kA3DFRMEnumValue_CadType_Sew`
	`kA3DFRMEnumValue_CadType_Rib`
	`kA3DFRMEnumValue_CadType_Draft`
	`kA3DFRMEnumValue_CadType_Hollow`
	`kA3DFRMEnumValue_CadType_Quilt`
	`kA3DFRMEnumValue_CadType_LocalPush`
	`kA3DFRMEnumValue_CadType_BooleanOperation`
	`kA3DFRMEnumValue_CadType_Intersect`
	`kA3DFRMEnumValue_CadType_CutOut`
	`kA3DFRMEnumValue_CadType_Merge`
	`kA3DFRMEnumValue_CadType_Translate`
	`kA3DFRMEnumValue_CadType_Rotate`
	`kA3DFRMEnumValue_CadType_Scale`
	`kA3DFRMEnumValue_CadType_Offset`
	`kA3DFRMEnumValue_CadType_Transformation`
	`kA3DFRMEnumValue_CadType_Thread`
	`kA3DFRMEnumValue_CadType_Cosmetic`
	`kA3DFRMEnumValue_CadType_Material`
	`kA3DFRMEnumValue_CadType_Thickness`
	`kA3DFRMEnumValue_CadType_RemoveFace`
	`kA3DFRMEnumValue_CadType_UserDefined`
	`kA3DFRMEnumValue_CadType_Member`
	`kA3DFRMEnumValue_CadType_Symmetry`
	`kA3DFRMEnumValue_CadType_FlatPattern`
	`kA3DFRMEnumValue_RevolveAngleType_None`
	`kA3DFRMEnumValue_RevolveAngleType_Variable`
	`kA3DFRMEnumValue_RevolveAngleType_Variable_Symmetric`
	`kA3DFRMEnumValue_RevolveAngleType_Reference`
	`kA3DFRMEnumValue_RevolveAngleType_Next`
	`kA3DFRMEnumValue_FilletLengthType_None`
	`kA3DFRMEnumValue_FilletLengthType_Circular`
	`kA3DFRMEnumValue_FilletLengthType_Conic`
	`kA3DFRMEnumValue_FilletLengthType_Conic_Asymmetric`
	`kA3DFRMEnumValue_FilletLengthType_Continue`
	`kA3DFRMEnumValue_FilletLengthType_Continue_Asymmetric`
	`kA3DFRMEnumValue_FilletLengthType_Curvature`
	`kA3DFRMEnumValue_FilletLengthType_Curvature_Asymmetric`
	`kA3DFRMEnumValue_LengthModeType_None`
	`kA3DFRMEnumValue_LengthModeType_ByValue`
	`kA3DFRMEnumValue_LengthModeType_Parameter`
	`kA3DFRMEnumValue_LengthModeType_Reference`
	`kA3DFRMEnumValue_ReferenceMaster_None`
	`kA3DFRMEnumValue_ReferenceMaster_Features`
	`kA3DFRMEnumValue_ReferenceMaster_CurrentBody`
	`kA3DFRMEnumValue_ReferenceMaster_Geometries`

Functions

A3DStatus

A3DFRMFeatureGetTypeAsString

Detailed Description

group a3d_feature_type_module

Type Documentation

enum EA3DFRMEnumDataType

Feature type enum.

Mechanism for value interpretation. A feature with type kA3DFamily_Type or kA3DFRMEnumDataType_CAD has m_eDataType set to kA3DFRMDataEnum, and the function A3DFRMEnumDataGet will return integer values to interpret the values in the EA3DFRMEnumValue_CadType enum.

Version: 10.2

Values:

enumerator kA3DFRMEnumDataType_None: Not defined.

enumerator kA3DFRMEnumDataType_CAD: EA3DFRMEnumValue_CadType

enumerator kA3DFRMEnumDataType_Mode: EA3DFRMEnumValue_ModeType

enumerator kA3DFRMEnumDataType_Depth: EA3DFRMEnumValue_DepthType

enumerator kA3DFRMEnumDataType_Pattern: EA3DFRMEnumValue_Pattern

enumerator kA3DFRMEnumDataType_HoleShape: EA3DFRMEnumValue_Hole

enumerator kA3DFRMEnumDataType_DepthLevel: EA3DFRMEnumValue_DepthLevel

enumerator kA3DFRMEnumDataType_RevolveAngle: EA3DFRMEnumValue_RevolveAngleType

enumerator kA3DFRMEnumDataType_Chamfer: EA3DFRMEnumValue_ChamferType

enumerator kA3DFRMEnumDataType_Fillet: EA3DFRMEnumValue_FilletType

enumerator kA3DFRMEnumDataType_FilletLength: EA3DFRMEnumValue_FilletLengthType

enumerator kA3DFRMEnumDataType_FilletConic: EA3DFRMEnumValue_FilletConicType

enumerator kA3DFRMEnumDataType_LengthMode: EA3DFRMEnumValue_LengthModeType

enumerator kA3DFRMEnumDataType_PatternMaster: EA3DFRMEnumValue_PatternMaster

enumerator kA3DFRMEnumDataType_ReferenceMaster: EA3DFRMEnumValue_ReferenceMaster

enum EA3DFRMFamily

Feature family type enum.

Version: 10.2

Values:

enumerator kA3DFamily_None: No family type.

enumerator kA3DFamily_Root: See EA3DFRMRoot for possible subtypes.

enumerator kA3DFamily_Information: Not used.

enumerator kA3DFamily_Type: See EA3DFRMEnumDataType for possible subtypes.

enumerator kA3DFamily_FeatureDefinition: See EA3DFRMFeatureDefinitionType for possible subtypes.

enumerator kA3DFamily_DoubleData: See EA3DFRMDoubleDataType for possible subtypes.

enumerator kA3DFamily_IntegerData: See EA3DFRMIntegerDataType for possible subtypes.

enumerator kA3DFamily_StringData: See EA3DFRMStringDataType for possible subtypes.

enumerator kA3DFamily_Value: See EA3DFRMValueType for possible subtypes.

enumerator kA3DFamily_Definition: See EA3DFRMDefinitionType for possible subtypes.

enumerator kA3DFamily_Definition_Hole: See EA3DFRMDefinitionHoleType for possible subtypes.

enumerator kA3DFamily_Definition_Pattern: See EA3DFRMDefinitionPatternType for possible subtypes.

enumerator kA3DFamily_Definition_Thread: See EA3DFRMDefinitionThreadType for possible subtypes.

enum EA3DFRMStatus

Feature status enum.

Version: 10.2

Values:

enumerator kA3DFRMStatus_Success: No error.

enumerator kA3DFRMStatus_Failed: Error in reading process.

enumerator kA3DFRMStatus_NotYetImplemented: Limitation.

enum EA3DFRMEnumValue_CadType

Enumerate the possible types of cad type.

Version: 10.2

Values:

enumerator kA3DFRMEnumValue_CadType_None: No type specified

enumerator kA3DFRMEnumValue_CadType_Sketch: Sketch

enumerator kA3DFRMEnumValue_CadType_Plane: Plane

enumerator kA3DFRMEnumValue_CadType_Point: Point

enumerator kA3DFRMEnumValue_CadType_CoordinateSystem: CoordinateSystem

enumerator kA3DFRMEnumValue_CadType_Direction: Direction

enumerator kA3DFRMEnumValue_CadType_Curve: Curve

enumerator kA3DFRMEnumValue_CadType_Analysis: Analysis

enumerator kA3DFRMEnumValue_CadType_ImportedSolid: ImportedSolid

enumerator kA3DFRMEnumValue_CadType_Extrusion: Extrude

enumerator kA3DFRMEnumValue_CadType_Revolution: Revolve

enumerator kA3DFRMEnumValue_CadType_Surface: Surface

enumerator kA3DFRMEnumValue_CadType_Block: Block

enumerator kA3DFRMEnumValue_CadType_Sphere: Sphere

enumerator kA3DFRMEnumValue_CadType_Cone: Cone

enumerator kA3DFRMEnumValue_CadType_Cylinder: Cylinder

enumerator kA3DFRMEnumValue_CadType_Torus: Torus

enumerator kA3DFRMEnumValue_CadType_Dome: Dome

enumerator kA3DFRMEnumValue_CadType_Helix: Helix

enumerator kA3DFRMEnumValue_CadType_TruncatedPrism: TruncatedPrism

enumerator kA3DFRMEnumValue_CadType_Hole: Hole

enumerator kA3DFRMEnumValue_CadType_Chamfer: Chamfer

enumerator kA3DFRMEnumValue_CadType_Blend: Blend

enumerator kA3DFRMEnumValue_CadType_Fillet: Fillet

enumerator kA3DFRMEnumValue_CadType_Groove: Groove

enumerator kA3DFRMEnumValue_CadType_Pocket: Pocket

enumerator kA3DFRMEnumValue_CadType_Sweep: Sweep

enumerator kA3DFRMEnumValue_CadType_Pipe: Pipe

enumerator kA3DFRMEnumValue_CadType_Group: Group

enumerator kA3DFRMEnumValue_CadType_Mirror: Mirror

enumerator kA3DFRMEnumValue_CadType_Pattern: Pattern

enumerator kA3DFRMEnumValue_CadType_GroupPattern: Pattern

enumerator kA3DFRMEnumValue_CadType_Instance: Instance, see also Pattern

enumerator kA3DFRMEnumValue_CadType_Package: Package

enumerator kA3DFRMEnumValue_CadType_Shell: Shell

enumerator kA3DFRMEnumValue_CadType_Trim: Trim

enumerator kA3DFRMEnumValue_CadType_Split: Split

enumerator kA3DFRMEnumValue_CadType_Sew: Sew

enumerator kA3DFRMEnumValue_CadType_Rib: Rib

enumerator kA3DFRMEnumValue_CadType_Draft: Draft

enumerator kA3DFRMEnumValue_CadType_Hollow: Hollow

enumerator kA3DFRMEnumValue_CadType_Quilt: Quilt

enumerator kA3DFRMEnumValue_CadType_LocalPush: Local Push

enumerator kA3DFRMEnumValue_CadType_BooleanOperation: Boolean Operation

enumerator kA3DFRMEnumValue_CadType_Intersect: Intersect

enumerator kA3DFRMEnumValue_CadType_CutOut: CutOut

enumerator kA3DFRMEnumValue_CadType_Merge: Merge

enumerator kA3DFRMEnumValue_CadType_Translate: Translate

enumerator kA3DFRMEnumValue_CadType_Rotate: Rotate

enumerator kA3DFRMEnumValue_CadType_Scale: Scale

enumerator kA3DFRMEnumValue_CadType_Offset: Offset

enumerator kA3DFRMEnumValue_CadType_Transformation: Transformation

enumerator kA3DFRMEnumValue_CadType_Thread: Thread

enumerator kA3DFRMEnumValue_CadType_Cosmetic: Cosmetic

enumerator kA3DFRMEnumValue_CadType_Material: Material

enumerator kA3DFRMEnumValue_CadType_Thickness: Thickness

enumerator kA3DFRMEnumValue_CadType_RemoveFace: Remove Face

enumerator kA3DFRMEnumValue_CadType_UserDefined: User Defined

enumerator kA3DFRMEnumValue_CadType_Member

Member, son of an assembly.

See Member

enumerator kA3DFRMEnumValue_CadType_Symmetry: Symmetry

enumerator kA3DFRMEnumValue_CadType_FlatPattern: FlatPattern

enum EA3DFRMEnumValue_RevolveAngleType

Enumerate the possible types of revolve angle types

This can be used to specify Angle for a Feature Revolution.

Example of usage for a Feature Revolution: ../_images/frm_revolve_angle_types.png

Version: 11

Values:

enumerator kA3DFRMEnumValue_RevolveAngleType_None: Invalid Revolve Angle Type.

enumerator kA3DFRMEnumValue_RevolveAngleType_Variable: Revolve angle is define with an Angle Value.

enumerator kA3DFRMEnumValue_RevolveAngleType_Variable_Symmetric: Revolve angle is define with an Angle Value, that should be apply symmetrically on both directions.

enumerator kA3DFRMEnumValue_RevolveAngleType_Reference: Depth is define up to the specified reference.

enumerator kA3DFRMEnumValue_RevolveAngleType_Next: Depth is define up to the next surface encountered.

enum EA3DFRMEnumValue_FilletLengthType

Enumerate the possible types of fillet length types

Version: 11

Values:

enumerator kA3DFRMEnumValue_FilletLengthType_None: No fillet length type.

enumerator kA3DFRMEnumValue_FilletLengthType_Circular: Circular length type.

enumerator kA3DFRMEnumValue_FilletLengthType_Conic: Conic length type.

enumerator kA3DFRMEnumValue_FilletLengthType_Conic_Asymmetric: Asymmetric length type.

enumerator kA3DFRMEnumValue_FilletLengthType_Continue: Continue length type.

enumerator kA3DFRMEnumValue_FilletLengthType_Continue_Asymmetric: Continue and asymmetric length type.

enumerator kA3DFRMEnumValue_FilletLengthType_Curvature: Curvature length type.

enumerator kA3DFRMEnumValue_FilletLengthType_Curvature_Asymmetric: curvature asymmetric length type

enum EA3DFRMEnumValue_LengthModeType

Enumerate the possible types of length mode types

Version: 11

Values:

enumerator kA3DFRMEnumValue_LengthModeType_None: No length mode type.

enumerator kA3DFRMEnumValue_LengthModeType_ByValue: By-value length mode type.

enumerator kA3DFRMEnumValue_LengthModeType_Parameter: Parameter length mode type.

enumerator kA3DFRMEnumValue_LengthModeType_Reference: Reference length mode type.

enum EA3DFRMEnumValue_ReferenceMaster

Enumerate the possible master type.

Version: 12

Values:

enumerator kA3DFRMEnumValue_ReferenceMaster_None: Invalid reference master Type.

enumerator kA3DFRMEnumValue_ReferenceMaster_Features: The reference master is a feature list.

enumerator kA3DFRMEnumValue_ReferenceMaster_CurrentBody: The reference master is the current body.

enumerator kA3DFRMEnumValue_ReferenceMaster_Geometries: The reference master is a geometry list.

Function Documentation

A3DStatus A3DFRMFeatureGetTypeAsString(const A3DFRMFeature *pFeature, A3DUTF8Char **ppcFeatureType)

Get the string associated to the feature type.

Version: 10.2

Parameters:

pFeature – feature pointer
ppcFeatureType – associated string

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