A3DSDKMarkupTolerance.h
Header file for the tolerance markup module.
- Author
Tech Soft 3D
- Version
23.0
- Date
January 2023
- Copyright (c) 2010 - 2023 by Tech Soft 3D, Inc. All rights reserved.
Content
Data Structures
Markup datum. |
|
FCF drafting row. |
|
Tolerance value. |
|
Tolerance per unit. |
|
Projected tolerance zone. |
|
FCF tolerance value. |
|
FCF datum row. |
|
FCF drawing row. |
|
Feature control frame indicator. |
|
Feature control frame drafting indicator. |
|
Feature control frame. |
|
tolerance size value. |
|
tolerance size. |
|
Markup geometrical and dimensioning tolerance. |
Functions
Populates the A3DMarkupDatumData structure. |
|
Populates the A3DMDFCFDraftingRowData structure. |
|
Populates the A3DMDFCValueData structure. |
|
Populates the A3DMDFCTolerancePerUnitData structure. |
|
Populates the A3DMDFCProjectedZoneData structure. |
|
Populates the A3DMDFCFToleranceValueData structure. |
|
Populates the A3DMDFCFRowDatumData structure. |
|
Populates the A3DMDFCFDrawingRowData structure. |
|
Populates the A3DMDFCFDrawingRowData structure whatever the row type. |
|
Populates the A3DMDFCFIndicatorData structure. |
|
Populates the A3DMDFCFDraftingIndicatorData structure. |
|
Populates the A3DMDFeatureControlFrameData structure. |
|
Retrieves the semantic definition if set and populates the A3DMDFeatureControlFrameData structure. |
|
Populates the A3DMDToleranceSizeData structure. |
|
Populates the A3DMDToleranceSizeValueData structure. |
|
Populates the A3DMarkupGDTData structure. |
Functions
-
A3DStatus A3DMarkupDatumGet(const A3DMarkupDatum *pMarkupDatum, A3DMarkupDatumData *pData)
Populates the A3DMarkupDatumData structure.
- Version
4.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCFDraftingRowGet(const A3DMDFCFDraftingRow *pDraftingRow, A3DMDFCFDraftingRowData *pData)
Populates the A3DMDFCFDraftingRowData structure.
- Version
4.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCValueGet(const A3DMDFCValue *pValue, A3DMDFCValueData *pData)
Populates the A3DMDFCValueData structure.
- Version
5.2
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCTolerancePerUnitGet(const A3DMDFCTolerancePerUnit *pTolerancePerUnit, A3DMDFCTolerancePerUnitData *pData)
Populates the A3DMDFCTolerancePerUnitData structure.
- Version
5.2
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCProjectedZoneGet(const A3DMDFCProjectedZone *pProjectedZone, A3DMDFCProjectedZoneData *pData)
Populates the A3DMDFCProjectedZoneData structure.
- Version
5.2
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCFToleranceValueGet(const A3DMDFCFToleranceValue *pToleranceValue, A3DMDFCFToleranceValueData *pData)
Populates the A3DMDFCFToleranceValueData structure.
- Version
5.2
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCFRowDatumGet(const A3DMDFCFRowDatum *pRowDatum, A3DMDFCFRowDatumData *pData)
Populates the A3DMDFCFRowDatumData structure.
- Version
4.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCFDrawingRowGet(const A3DMDFCFDrawingRow *pDrawingRow, A3DMDFCFDrawingRowData *pData)
Populates the A3DMDFCFDrawingRowData structure.
- Version
4.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCFSemanticRowGet(const A3DMDFCFRow *pRow, A3DMDFCFDrawingRowData *pData)
Populates the A3DMDFCFDrawingRowData structure whatever the row type.
Note that if the drawing row is not defined with a tolerance value, the function returns A3D_MARKUP_SEMANTIC_TOL_VALUE_NOT_SET
See also
- Version
5.2
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_MARKUP_SEMANTIC_DEFINITION_NOT_SET –
A3D_MARKUP_SEMANTIC_TOL_VALUE_NOT_SET –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCFIndicatorGet(const A3DMDFCFIndicator *pIndicator, A3DMDFCFIndicatorData *pData)
Populates the A3DMDFCFIndicatorData structure.
- Version
12.2
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFCFDraftingIndicatorGet(const A3DMDFCFDraftingIndicator *pIndicator, A3DMDFCFDraftingIndicatorData *pData)
Populates the A3DMDFCFDraftingIndicatorData structure.
- Version
14.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDFeatureControlFrameGet(const A3DMDFeatureControlFrame *pFCF, A3DMDFeatureControlFrameData *pData)
Populates the A3DMDFeatureControlFrameData structure.
- Version
4.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDSemanticFeatureControlFrameGet(const A3DMDFeatureControlFrame *pFCF, A3DMDFeatureControlFrameData *pData)
Retrieves the semantic definition if set and populates the A3DMDFeatureControlFrameData structure.
- Version
5.2
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_MARKUP_SEMANTIC_DEFINITION_NOT_SET –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDToleranceSizeGet(const A3DMDToleranceSize *pToleranceSize, A3DMDToleranceSizeData *pData)
Populates the A3DMDToleranceSizeData structure.
- Version
12.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMDToleranceSizeValueGet(const A3DMDToleranceSizeValue *pToleranceSizeValue, A3DMDToleranceSizeValueData *pData)
Populates the A3DMDToleranceSizeValueData structure.
- Version
12.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DMarkupGDTGet(const A3DMarkupGDT *pMarkupGDT, A3DMarkupGDTData *pData)
Populates the A3DMarkupGDTData structure.
- Version
4.0
- Return values
A3D_INITIALIZE_NOT_CALLED –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_INVALID_ENTITY_NULL –
A3D_INVALID_ENTITY_TYPE –
A3D_SUCCESS –
- Returns
A3D_SUCCESS in case of success or an error code