PC-Dmis 2010 MR3 Object Library | Send comments on this topic. | See Object Hierarchy Chart
GetSampleHit Method
See Also

Collapse All Expand All

index
  The index number of the desired hit object to retrieve.

DataType
  Optional Long value. If no value is supplied, the default value is FHITDATA_CENTROID.

MeasOrTheo
  Optional Long value. If no value is supplied, the default value is FDATA_MEAS.

CoordSystem
  Optional Long that denotes the coordinate system in which to report. An empty value of "" will use the current alignment.

Alignment
  Optional String that denotes what alignment to use. You can pass the empty string to denote the current alignment.

  If no value is supplied, the default value is an empty string which causes the current alignment to be used.

Workplane
  Optional parameter with the ENUM_PLANE_TYPE enumeration for the PARTMM3 and POLAR coordinate system to denote the workplane to be used.

# Description

Returns Point Data Object with sample hit data Returns a PointData object with the values of the sample hit.

# Syntax

Visual Basic

    Public Function GetSampleHit( _
       ByVal index As Long, _
       ByVal DataType As FHITDATA_TYPES, _
       ByVal MeasOrTheo As FDATA_DATASET, _
       ByVal CoordSystem As FDATA_COORDSYS, _
       ByVal Alignment As String, _
       ByVal Workplane As ENUM_PLANE_TYPE _
    ) As PointData

# Parameters

index
  The index number of the desired hit object to retrieve.
DataType

  Value | Description
  --- | ---
  FHITDATA_CENTROID |
  FHITDATA_VECTOR |
  FHITDATA_BALLCENTER |

  Optional Long value. If no value is supplied, the default value is FHITDATA_CENTROID.
MeasOrTheo

  Value | Description
  --- | ---
  FDATA_THEO |
  FDATA_MEAS |
  FDATA_TARG |
  FDATA_ALL |

  Optional Long value. If no value is supplied, the default value is FDATA_MEAS.
CoordSystem

  Value | Description
  --- | ---
  FDATA_POLAR |
  FDATA_CAD |
  FDATA_PARTMM3 |
  FDATA_MACHINE |
  FDATA_PART |

  Optional Long that denotes the coordinate system in which to report. An empty value of "" will use the current alignment.
Alignment
  Optional String that denotes what alignment to use. You can pass the empty string to denote the current alignment.

  If no value is supplied, the default value is an empty string which causes the current alignment to be used.

Workplane

  Value | Description
  --- | ---
  PLANE_TOP |
  PLANE_RIGHT |
  PLANE_BACK |
  PLANE_BOTTOM |
  PLANE_LEFT |
  PLANE_FRONT |

  Optional parameter with the ENUM_PLANE_TYPE enumeration for the PARTMM3 and POLAR coordinate system to denote the workplane to be used.

# Return Type

PointData object.

# Remarks

Use this function to obtain sample hit information from Auto Feature commands.

# See Also

FeatCmd Object

© Wilcox Associates, Inc. All Rights Reserved.

© 2010 All Rights Reserved.