Datum Plane Features
The element tree for a datum plane feature is documented in the header file ProDtmPln.h, and has a simple structure. Apart from the usual elements for the tree root and feature type, a datum plane contains the positioning constraints, an optional flip direction, and an optional fit type.
The constraints element PRO_E_DTMPLN_CONSTRAINTS is an array element that contains a PRO_E_DTMPLN_CONSTRAINT element for each constraint. Many elements forming the constraint element PRO_E_DTMPLN_CONSTRAINT are used only for certain constraint types, so any given datum plane may contain fewer elements than are shown in the tree. Similarly, all the elements forming the constraint element PRO_E_DTMPLN_FIT are not always essential.
The following figure shows the element tree for datum planes.
Many elements forming the constraint element PRO_E_DTMPLN_CONSTRAINT are used only for the following constraint types:
• PRO_E_DTMPLN_CONSTR_REF_OFFSET—Used if the constraint type is “offset.”
• PRO_E_DTMPLN_CONSTR_REF_ANGLE—Used if the constraint type is “angle.”
• PRO_E_DTMPLN_CONSTR_SEC_IND—Used if the constraint type is “section.”
• PRO_E_DTMPLN_OFF_CSYS—Used if the constraint type is “offset” and the reference is “Csys.”
• PRO_E_DTMPLN_OFF_CSYS_OFFSET—Used if the constraint type is “offset” and the reference is “Csys.”
Similarly, elements of the optional element PRO_E_DTMPLN_FIT are used for the following fit types:
• PRO_E_DTMPN_FIT_REF—Used if the fit type is not “default” or “fit.”
• PRO_E_DTMPLN_FIT_DIM_RAD—Used if the fit type is “fit radius.”
The following table describes the tree elements in detail:
Element ID | Element Name | Data Type | Valid Value |
|---|---|---|---|
PRO_E_FEATURE_TYPE | Feature type | PRO_VALUE_TYPE_INT | PRO_FEAT_DATUM |
PRO_E_STD_FEATURE_NAME | Feature Name | PRO_VALUE_TYPE_WSTRING | |
PRO_E_DTMPLN_CONSTRAINTS | Constraints | Array | |
PRO_E_DTMPLN_CONSTRAINT | Constraints | Compound | |
PRO_E_DTMPLN_CONSTR_TYPE | Type | PRO_VALUE_TYPE_INT | See ProDtmplnConstrType |
PRO_E_DTMPLN_CONSTR_REF | References | PRO_VALUE_TYPE_SELECTION | |
PRO_E_DTMPLN_CONSTR_REF_OFFSET | Offset | PRO_VALUE_TYPE_DOUBLE | Any |
PRO_E_DTMPLN_CONSTR_REF_ANGLE | Angle | PRO_VALUE_TYPE_DOUBLE | (-360.0, 360.0) |
PRO_E_DTMPLN_SEC_IND | Section index | PRO_VALUE_TYPE_INT | [0, sec num - 1] |
PRO_E_DTMPLN_OFF_CSYS | Offset coordinate system | PRO_VALUE_TYPE_INT | See ProDtmplnOffCsysAxis |
PRO_E_DTMPLN_OFF_CSYS_OFFSET | Offset coordinate system value | PRO_VALUE_TYPE_DOUBLE | Any |
PRO_E_DTMPLN_FLIP_DIR | Flip direction | PRO_VALUE_TYPE_INT | ProDtmplnFlipDir |
PRO_E_DTMPLN_FIT | Fit | Compound | |
PRO_E_DTMPLN_FIT_TYPE | Fit type | PRO_VALUE_TYPE_INT | ProDtmplnFitType |
PRO_E_DTMPLN_FIT_REF | Reference | PRO_VALUE_TYPE_SELECTION | |
PRO_E_DTMPLN_FIT_DTM_RAD | Datum radius | PRO_VALUE_TYPE_DOUBLE | >= 0.0 |