Datum Features
This section describes the VB API methods and properties that provide read access to the properties of datum features.
Datum Plane Features
The properties of the Datum Plane feature are defined in the IpfcDatumPlaneFeat data object.
Methods and Properties Introduced:
  • IpfcDatumPlaneFeat.Flip
    		•
  • IpfcDatumPlaneFeat.Constraints
    		•
  • IpfcDatumPlaneConstraint.ConstraintType
    		•
  • IpfcDatumPlaneThroughConstraint.ThroughRef
    		•
  • IpfcDatumPlaneNormalConstraint.NormalRef
    		•
  • IpfcDatumPlaneParallelConstraint.ParallelRef
    		•
  • IpfcDatumPlaneTangentConstraint.TangentRef
    		•
  • IpfcDatumPlaneOffsetConstraint.OffsetRef
    		•
  • IpfcDatumPlaneOffsetConstraint.OffsetValue
    		•
  • IpfcDatumPlaneOffsetCoordSysConstraint.CsysAxis
    		•
  • IpfcDatumPlaneAngleConstraint.AngleRef
    		•
  • IpfcDatumPlaneAngleConstraint.AngleValue
    		•
  • IpfcDatumPlaneSectionConstraint.SectionRef
    		•
  • IpfcDatumPlaneSectionConstraint.SectionIndex
    		•
    The properties of the IpfcDatumPlaneFeat object are described as follows:
    •  Flip—Specifies whether the datum plane was flipped during creation. Use the property IpfcDatumPlaneFeat.Flip to determine if the datum plane was flipped during creation.
    •  Constraints—Specifies a collection of constraints given by the IpfcDatumPlaneConstraint object. The property IpfcDatumPlaneFeat.Constraints obtains the collection of constraints defined for the datum plane.
    Use the property IpfcDatumPlaneConstraint.ConstraintType to obtain the type of constraint. The type of constraint is given by the IpfcDatumPlaneConstraintType enumerated type. The available types are as follows:
    •  EpfcDTMPLN_THRU—Specifies the Through constraint. The IpfcDatumPlaneThroughConstraint object specifies this constraint. Use the property IpfcDatumPlaneThroughConstraint.ThroughRef to get the reference selection handle for the Through constraint.
    •  EpfcDTMPLN_NORM—Specifies the Normal constraint. The IpfcDatumPlaneNormalConstraint object specifies this constraint. Use the propertyIpfcDatumPlaneNormalConstraint.NormalRef to get the reference selection handle for the Normal constraint.
    •  EpfcDTMPLN_PRL—Specifies the Parallel constraint. IpfcDatumPlaneParallelConstraint object specifies this constraint. Use the property IpfcDatumPlaneParallelConstraint.ParallelRef to get the reference selection handle for the Parallel constraint.
    •  EpfcDTMPLN_TANG—Specifies the Tangent constraint. The IpfcDatumPlaneTangentConstraint object specifies this constraint. Use the property IpfcDatumPlaneTangentConstraint.TangentRef to get the reference selection handle for the Tangent constraint.
    •  EpfcDTMPLN_OFFS—Specifies the Offset constraint. The IpfcDatumPlaneOffsetConstraint object specifies this constraint. Use the property IpfcDatumPlaneOffsetConstraint.OffsetRef to get the reference selection handle for the Offset constraint. Use the property IpfcDatumPlaneOffsetConstraint.OffsetValue to get the offset value.
    An Offset constraint where the offset reference is a coordinate system is given by the IpfcDatumPlaneOffsetCoordSysConstraint object. Use the property IpfcDatumPlaneOffsetCoordSysConstraint.CsysAxis to get the reference coordinate axis.
    •  EpfcDTMPLN_ANG—Specifies the Angle constraint. The IpfcDatumPlaneAngleConstraint object specifies this constraint. Use the property IpfcDatumPlaneAngleConstraint.AngleRef to get the reference selection handle for the Angle constraint. Use the property IpfcDatumPlaneAngleConstraint.AngleValue to get the angle value.
    •  EpfcDTMPLN_SEC—Specifies the Section constraint. The IpfcDatumPlaneSectionConstraint object specifies this constraint. Use the property IpfcDatumPlaneSectionConstraint.SectionRef to get the reference selection for the Section constraint. Use the property IpfcDatumPlaneSectionConstraint.SectionIndex to get the section index.
    Datum Axis Features
    The properties of the Datum Axis feature are defined in the IpfcDatumAxisFeat data object.
    Methods and Properties Introduced:
  • IpfcDatumAxisFeat.Constraints
    		•
  • IpfcDatumAxisConstraint.ConstraintType
    		•
  • IpfcDatumAxisConstraint.ConstraintRef
    		•
  • IpfcDatumAxisFeat.DimConstraints
    		•
  • IpfcDatumAxisDimensionConstraint.DimOffset
    		•
  • IpfcDatumAxisDimensionConstraint.DimRef
    		•
    The properties of the IpfcDatumAxisFeat object are described as follows:
    •  Constraints—Specifies a collection of constraints given by the IpfcDatumAxisConstraint object. The property IpfcDatumAxisFeat.Constraints obtains the collection of constraints applied to the Datum Axis feature.
    This object contains the following attributes:
    ○  ConstraintType—Specifies the type of constraint in terms of the EpfcDatumAxisConstraintType enumerated type. The constraint type determines the type of datum axis. The constraint types are:
    ◆  EpfcDTMAXIS_NORMAL—Specifies the Normal datum constraint.
    ◆  EpfcDTMAXIS_THRU—Specifies the Through datum constraint.
    ◆  EpfcDTMAXIS_TANGENT—Specifies the Tangent datum constraint.
    ◆  EpfcDTMAXIS_CENTER—Specifies the Center datum constraint.
    Use the property IpfcDatumAxisConstraint.ConstraintType to get the constraint type.
    ○  ConstraintRef—Specifies the reference selection for the constraint. Use the property IpfcDatumAxisConstraint.ConstraintRef to get the reference selection handle.
    •  DimConstraints—Specifies a collection of dimension constraints given by the IpfcDatumAxisDimensionConstraint object. The property IpfcDatumAxisFeat.DimConstraints obtains the collection of dimension constraints applied to the Datum Axis feature.
    This IpfcDatumAxisDimensionConstraint object contains the following attributes:
    ○  DimOffset—Specifies the offset value for the dimension constraint. Use the property IpfcDatumAxisDimensionConstraint.DimOffset to get the offset value.
    ○  DimRef—Specifies the reference selection for the dimension constraint. Use the property IpfcDatumAxisDimensionConstraint.DimRef to get the reference selection handle.
    General Datum Point Features
    The properties of the General Datum Point feature are defined in the IpfcDatumPointFeat data object.
    Methods and Properties Introduced:
  • IpfcDatumPointFeat.FeatName
    		•
  • IpfcDatumPointFeat.GetPoints()
    		•
  • IpfcGeneralDatumPoint.Name
    		•
  • IpfcGeneralDatumPoint.PlaceConstraints
    		•
  • IpfcGeneralDatumPoint.DimConstraints
    		•
  • IpfcDatumPointConstraint.ConstraintRef
    		•
  • IpfcDatumPointConstraint.ConstraintType
    		•
  • IpfcDatumPointConstraint.Value
    		•
    The properties of the IpfcDatumPointFeat object are described as follows:
    •  FeatName—Specifies the name of the General Datum Point feature. Use the property IpfcDatumPointFeat.FeatName to get the name.
    •  GeneralDatumPoints—Specifies a collection of general datum points given by the IpfcGeneralDatumPoint object. Use the method IpfcDatumPointFeat.GetPoints() to obtain the collection of general datum points. The IpfcGeneralDatumPoint object consists of the following attributes:
    ○  Name—Specifies the name of the general datum point. Use the property IpfcGeneralDatumPoint.Name to get the name.
    ○  PlaceConstraints—Specifies a collection of placement constraints given by the IpfcDatumPointPlacementConstraint object. Use the property IpfcGeneralDatumPoint.PlaceConstraints to obtain the collection of placement constraints.
    ○  DimConstraints—Specifies a collection of dimension constraints given by the IpfcDatumPointDimensionConstraint object. Use the property IpfcGeneralDatumPoint.DimConstraints to obtain the collection of dimension constraints.
    The constraints for a datum point are given by the IpfcDatumPointConstraint object. This object contains the following attributes:
    •  ConstraintRef—Specifies the reference selection for the datum point constraint. Use the property IpfcDatumPointConstraint.ConstraintRef to get the reference selection handle.
    •  ConstraintType—Specifies the type of datum point constraint. in terms of the IpfcDatumPointConstraintType enumerated type. Use the property IpfcDatumPointConstraint.ConstraintType to get the constraint type.
    •  Value—Specifies the constraint reference value with respect to the datum point. Use the property IpfcDatumPointConstraint.Value to get the value of the constraint reference with respect to the datum point.
    The IpfcDatumPointPlacementConstraint and IpfcDatumPointDimensionConstraint objects inherit from the IpfcDatumPointConstraint object. Use the methods of the IpfcDatumPointFeat object for the inherited objects.
    Datum Coordinate System Features
    The properties of the Datum Coordinate System feature are defined in the IpfcCoordSysFeat object.
    Methods and Properties Introduced:
  • IpfcCoordSysFeat.OriginConstraints
    		•
  • IpfcDatumCsysOriginConstraint.OriginRef
    		•
  • IpfcCoordSysFeat.DimensionConstraints
    		•
  • IpfcDatumCsysDimensionConstraint.DimRef
    		•
  • IpfcDatumCsysDimensionConstraint.DimValue
    		•
  • IpfcDatumCsysDimensionConstraint.DimConstraintType
    		•
  • IpfcCoordSysFeat.OrientationConstraints
    		•
  • IpfcDatumCsysOrientMoveConstraint.OrientMoveConstraintType
    		•
  • IpfcDatumCsysOrientMoveConstraint.OrientMoveValue
    		•
  • IpfcCoordSysFeat.IsNormalToScreen
    		•
  • IpfcCoordSysFeat.OffsetType
    		•
  • IpfcCoordSysFeat.OnSurfaceType
    		•
  • IpfcCoordSysFeat.OrientByMethod
    		•
    The properties of the IpfcCoordSysFeat object are described as follows:
    •  OriginConstraints—Specifies a collection of origin constraints given by the IpfcDatumCsysOriginConstraint object. Use the property IpfcCoordSysFeat.OriginConstraints to obtain the collection of origin constraints for the coordinate system. This object contains the following attribute:
    ○  OriginRef—Specifies the selection reference for the origin. Use the methodproperty IpfcDatumCsysOriginConstraint.OriginRef to get the selection reference handle.
    •  DimensionConstraints—Specifies a collection of dimension constraints given by the IpfcDatumCsysDimensionConstraint object. Use the property IpfcCoordSysFeat.DimensionConstraints to obtain the collection of dimension constraints for the coordinate system. This object contains the following attributes:
    ○  DimRef—Specifies the reference selection for the dimension constraint. Use the property IpfcDatumCsysDimensionConstraint.DimRef to get the reference selection handle.
    ○  DimValue—Specifies the value of the reference. Use the property IpfcDatumCsysDimensionConstraint.DimValue to get the value.
    ○  DimConstraintType—Specifies the type of dimension constraint in terms of the EpfcDatumCsysDimConstraintType enumerated type. Use the property IpfcDatumCsysDimensionConstraint.DimConstraintType to get the constraint type. The constraint types are:
    ◆  EpfcDTMCSYS_DIM_OFFSET—Specifies the offset type constraint.
    ◆  EpfcDTMCSYS_DIM_ALIGN—Specifies the align type constraint.
    •  OrientationConstraints—Specifies a collection of orientation constraints given by the IpfcDatumCsysOrientMoveConstraint object. Use the property IpfcCoordSysFeat.OrientationConstraints to obtain the collection of orientation constraints for the coordinate system. This object contains the following attributes:
    ○  OrientMoveConstraintType—Specifies the type of orientation for the constraint. The orientation type is given by the EpfcDatumCsysOrientMoveConstraintType enumerated type. Use the property IpfcDatumCsysOrientMoveConstraint.OrientMoveConstraintType to get the orientation type.
    ○  OrientMoveValue—Specifies the reference value for the constraint. Use the property IpfcDatumCsysOrientMoveConstraint.OrientMoveValue to get the reference value.
    •  IsNormalToScreen—Specifies if the coordinate system is normal to screen. Use the property IpfcCoordSysFeat.IsNormalToScreen to determine if the coordinate system is normal to screen.
    •  OffsetType—Specifies the offset type of the coordinate system in terms of the EpfcDatumCsysOffsetType enumerated type. Use the property IpfcCoordSysFeat.OffsetType to get the offset type. The offset types are:
    ○  EpfcDTMCSYS_OFFSET_CARTESIAN—Specifies a cartesian coordinate system that has been defined by setting the values for the EpfcDTMCSYS_MOVE_TRAN_X, EpfcDTMCSYS_MOVE_TRAN_Y, and EpfcDTMCSYS_MOVE_TRAN_Z or EpfcDTMCSYS_MOVE_ROT_X, EpfcDTMCSYS_MOVE_ROT_Y, and EpfcDTMCSYS_MOVE_ROT_Z orientation constants.
    ○  EpfcDTMCSYS_OFFSET_CYLINDRICAL—Specifies a cylindrical coordinate system that has been defined by setting the values for the EpfcDTMCSYS_MOVE_RAD, EpfcDTMCSYS_MOVE_THETA, and EpfcDTMCSYS_MOVE_TRAN_ZI orientation constants.
    ○  EpfcDTMCSYS_OFFSET_SPHERICAL—Specifies a spherical coordinate system that has been defined by setting the values for the EpfcDTMCSYS_MOVE_RAD, EpfcDTMCSYS_MOVE_THETA, and EpfcDTMCSYS_MOVE_TRAN_PHI orientation constants.
    •  OnSurfaceType—Specifies the on surface type for the coordinate system in terms of the EpfcDatumCsysOffsetType enumerated type. Use the property IpfcCoordSysFeat.OnSurfaceType to get the on surface type property of the coordinate system. The on surface types are:
    ○  EpfcDTMCSYS_ONSURF_LINEAR—Specifies a coordinate system placed on the selected surface by using two linear dimensions.
    ○  EpfcDTMCSYS_ONSURF_RADIAL—Specifies a coordinate system placed on the selected surface by using a linear dimension and an angular dimension. The radius value is used to specify the linear dimension.
    ○  EpfcDTMCSYS_ONSURF_DIAMETER—This type is similar to the EpfcDTMCSYS_ONSURF_RADIAL type, except that the diameter value is used to specify the linear dimension. It is available only when planar surfaces are used as the reference.
    •  OrientByMethod—Specifies the orientation method in terms of the EpfcDatumCsysOrientByMethod enumerated type. Use the property IpfcCoordSysFeat.OrientByMethod to get the orientation method. The available orientation types are:
    ○  EpfcDTMCSYS_ORIENT_BY_SEL_REFS—Specifies the orientation by selected references.
    ○  EpfcDTMCSYS_ORIENT_BY_SEL_CSYS_AXES—Specifies the orientation by coordinate system axes.