< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Data Structures | Enumerations | Functions
RTF parsing

Data Structures

struct  A3DRTFFieldData
 Structure used to parse RTF strings. More...
 

Enumerations

enum  A3DEMarkupSymbol {
  KEA3DSymbol_UNKNOWN =0, KEA3DSymbol_Angularity, KEA3DSymbol_MoreOrLess, KEA3DSymbol_Micron,
  KEA3DSymbol_Circularity, KEA3DSymbol_Concentricity, KEA3DSymbol_Cylindricity, KEA3DSymbol_Parallelism,
  KEA3DSymbol_Perpendicularity, KEA3DSymbol_Symmetry, KEA3DSymbol_TotalRunout, KEA3DSymbol_Straightness,
  KEA3DSymbol_Flatness, KEA3DSymbol_LineProfile, KEA3DSymbol_SurfaceProfile, KEA3DSymbol_Runout,
  KEA3DSymbol_Countersink, KEA3DSymbol_Counterbore, KEA3DSymbol_Depth, KEA3DSymbol_Centerline,
  KEA3DSymbol_Ohm, KEA3DSymbol_Omega, KEA3DSymbol_SmallerOrEqual, KEA3DSymbol_GreaterOrEqual,
  KEA3DSymbol_Slope, KEA3DSymbol_ConicalTaper, KEA3DSymbol_Diameter, KEA3DSymbol_FreeState,
  KEA3DSymbol_LeastMaterial, KEA3DSymbol_MaximumMaterial, KEA3DSymbol_ProjectedTolerance, KEA3DSymbol_TangentPlane,
  KEA3DSymbol_Statistical, KEA3DSymbol_Position, KEA3DSymbol_Square, KEA3DSymbol_Triangle,
  KEA3DSymbol_between, KEA3DSymbol_RegardlessOfFeatureSize, KEA3DSymbol_Degre, KEA3DSymbol_Encompassing,
  KEA3DSymbol_CircledU, KEA3DSymbol_CircledR, KEA3DSymbol_RightwardArrow, KEA3DSymbol_SubsetOf,
  KEA3DSymbol_1STANG, KEA3DSymbol_3RDANG, KEA3DSymbol_BREAK15, KEA3DSymbol_BREAK30,
  KEA3DSymbol_DATUM1, KEA3DSymbol_DATUM2, KEA3DSymbol_MINUS, KEA3DSymbol_PLINE,
  KEA3DSymbol_PLUS, KEA3DSymbol_STRETCH, KEA3DSymbol_STS, KEA3DSymbol_STS_,
  KEA3DSymbol_STS_ANG, KEA3DSymbol_STS_ANG_, KEA3DSymbol_STS_BAS, KEA3DSymbol_STS_BAS_,
  KEA3DSymbol_STS_CIR, KEA3DSymbol_STS_CIR_, KEA3DSymbol_STS_MAT, KEA3DSymbol_STS_MAT_,
  KEA3DSymbol_STS_MLT, KEA3DSymbol_STS_MLT_, KEA3DSymbol_STS_NOM, KEA3DSymbol_STS_NOM_,
  KEA3DSymbol_STS_PAR, KEA3DSymbol_STS_PAR_, KEA3DSymbol_STS_PER, KEA3DSymbol_STS_PER_,
  KEA3DSymbol_STS_PRT, KEA3DSymbol_STS_PRT_, KEA3DSymbol_STS_RAD, KEA3DSymbol_STS_RAD_
}
 Symbol identifiers used in RTF strings. More...
 

Functions

A3DStatus A3DMkpRTFInit (const A3DUTF8Char *pRTF, A3DVoid *&pRTFData)
 Initialize RTF data for parsing. More...
 
A3DStatus A3DMkpRTFGetField (A3DVoid *pRTFData, A3DRTFFieldData *pRTFField)
 Get each independent field of a RTF data. More...
 
A3DStatus A3DMkpRTFDelete (A3DVoid *pRTFData)
 delete RTF data created by A3DMkpRTFInit More...
 

Detailed Description

Set of functions used to parse RTF strings.
RTF strings can be present in A3DMDFCFDraftingRowData, A3DMarkupGDTData, A3DMarkupRichTextData

Sample code
/* code to get each independent field of RTF string */
/* pRTF_UTF8 is an RTF string* */
A3DVoid* pRTF = NULL;
if(A3DMkpRTFInit(pRTF_UTF8, pRTF) == A3D_SUCCESS)
{
A3DRTFFieldData sRTFFieldData;
while(A3DMkpRTFGetField(pRTF, &sRTFFieldData) == A3D_SUCCESS)
{
// .......
// TODO: process sRTFFieldData
// .......
A3DMkpRTFGetField(NULL, &sRTFFieldData) // memory cleanup of the sRTFFieldData structure
}
}

Enumeration Type Documentation

Symbol identifiers used in RTF strings.

Version
4.2
Enumerator
KEA3DSymbol_UNKNOWN 

Not a symbol.

KEA3DSymbol_Angularity 

Angularity.

KEA3DSymbol_MoreOrLess 

MoreOrLess.

KEA3DSymbol_Micron 

Micron.

KEA3DSymbol_Circularity 

Circularity.

KEA3DSymbol_Concentricity 

Concentricity.

KEA3DSymbol_Cylindricity 

Cylindricity.

KEA3DSymbol_Parallelism 

Parallelism.

KEA3DSymbol_Perpendicularity 

Perpendicularity.

KEA3DSymbol_Symmetry 

Symmetry.

KEA3DSymbol_TotalRunout 

TotalRunout.

KEA3DSymbol_Straightness 

Straightness.

KEA3DSymbol_Flatness 

Flatness.

KEA3DSymbol_LineProfile 

LineProfile.

KEA3DSymbol_SurfaceProfile 

SurfaceProfile.

KEA3DSymbol_Runout 

Runout.

KEA3DSymbol_Countersink 

Countersink.

KEA3DSymbol_Counterbore 

Counterbore.

KEA3DSymbol_Depth 

Depth.

KEA3DSymbol_Centerline 

Centerline.

KEA3DSymbol_Ohm 

Ohm.

KEA3DSymbol_Omega 

Omega.

KEA3DSymbol_SmallerOrEqual 

SmallerOrEqual.

KEA3DSymbol_GreaterOrEqual 

GreaterOrEqual.

KEA3DSymbol_Slope 

Slope.

KEA3DSymbol_ConicalTaper 

ConicalTaper.

KEA3DSymbol_Diameter 

Diameter.

KEA3DSymbol_FreeState 

FreeState.

KEA3DSymbol_LeastMaterial 

LeastMaterial.

KEA3DSymbol_MaximumMaterial 

MaximumMaterial.

KEA3DSymbol_ProjectedTolerance 

ProjectedTolerance.

KEA3DSymbol_TangentPlane 

TangentPlane.

KEA3DSymbol_Statistical 

Statistical.

KEA3DSymbol_Position 

Position.

KEA3DSymbol_Square 

Square.

KEA3DSymbol_Triangle 

Triangle.

KEA3DSymbol_between 

between.

KEA3DSymbol_RegardlessOfFeatureSize 

RegardlessOfFeatureSize.

KEA3DSymbol_Degre 

Degre.

KEA3DSymbol_Encompassing 

Encompassing.

KEA3DSymbol_CircledU 

CircledU.

KEA3DSymbol_CircledR 

CircledR.

KEA3DSymbol_RightwardArrow 

RightwardArrow.

KEA3DSymbol_SubsetOf 

SubsetOf.

KEA3DSymbol_1STANG 

1STANG.

KEA3DSymbol_3RDANG 

3RDANG.

KEA3DSymbol_BREAK15 

BREAK15.

KEA3DSymbol_BREAK30 

BREAK30.

KEA3DSymbol_DATUM1 

DATUM1.

KEA3DSymbol_DATUM2 

DATUM2.

KEA3DSymbol_MINUS 

MINUS.

KEA3DSymbol_PLINE 

PLINE.

KEA3DSymbol_PLUS 

PLUS.

KEA3DSymbol_STRETCH 

STRETCH.

KEA3DSymbol_STS 

STS.

KEA3DSymbol_STS_ 

STS_.

KEA3DSymbol_STS_ANG 

STS_ANG.

KEA3DSymbol_STS_ANG_ 

STS_ANG_.

KEA3DSymbol_STS_BAS 

STS_BAS.

KEA3DSymbol_STS_BAS_ 

STS_BAS_.

KEA3DSymbol_STS_CIR 

STS_CIR.

KEA3DSymbol_STS_CIR_ 

STS_CIR_.

KEA3DSymbol_STS_MAT 

STS_MAT.

KEA3DSymbol_STS_MAT_ 

STS_MAT_.

KEA3DSymbol_STS_MLT 

STS_MLT.

KEA3DSymbol_STS_MLT_ 

STS_MLT_.

KEA3DSymbol_STS_NOM 

STS_NOM.

KEA3DSymbol_STS_NOM_ 

STS_NOM_.

KEA3DSymbol_STS_PAR 

STS_PAR.

KEA3DSymbol_STS_PAR_ 

STS_PAR_.

KEA3DSymbol_STS_PER 

STS_PER.

KEA3DSymbol_STS_PER_ 

STS_PER_.

KEA3DSymbol_STS_PRT 

STS_PRT.

KEA3DSymbol_STS_PRT_ 

STS_PRT_.

KEA3DSymbol_STS_RAD 

STS_RAD.

KEA3DSymbol_STS_RAD_ 

STS_RAD_.

Function Documentation

A3DStatus A3DMkpRTFInit ( const A3DUTF8Char pRTF,
A3DVoid *&  pRTFData 
)

Initialize RTF data for parsing.

Version
4.2
Returns
A3D_ERROR
A3D_SUCCESS
A3DStatus A3DMkpRTFGetField ( A3DVoid pRTFData,
A3DRTFFieldData pRTFField 
)

Get each independent field of a RTF data.

Version
4.2
Returns
A3D_ERROR
A3D_SUCCESS
A3DStatus A3DMkpRTFDelete ( A3DVoid pRTFData)

delete RTF data created by A3DMkpRTFInit

Version
4.2
Returns
A3D_ERROR
A3D_SUCCESS