BasicScanCommand Members
Z: Required Long variable that will hold the Z value of the bounday point
Remarks
This function works with patch scans. Use the boundarypointcount property to determine how many boundary points are available.
BasicScan.GetFilterParams
Syntax
Return Value=expression. GetFilterParams (dCutAxisLocation, nAxis, dMaxIncrement, dMinIncrement, dMaxAngle, dMinAngle)
Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
dCutAxisLocation: Not used.
nAxis: Required Long variable that gets the cut axis. Returns non-zero only for axis filters. For axis filters, 0 means the X axis, 1 means the Y-axis, and 2 means the Z-axis.
dMaxIncrement: Required Double variable that gets the maximum increment. For fixed-length filters, this is simply the fixed increment for Variable Distance Filters.
dMinIncrement: Required Double variable that gets the minimum increment.
dMaxAngle: Required Double variable that gets the maximum angle used in Variable Distance Filters.
dMinAngle: Required Double variable that gets the minimum angle used in Variable Distance Filters.
Remarks
Return Value=expression. GetHitParams (nInitSamples, nPermSamples, dSpacer, dIndent, dDepth)
PC-DMIS Basic Language Reference Automation • 191 Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
nInitSamples: Required Long variable that gets the number of initial sample hits for the hits in this scan. It always returns zero for basic hits and vector hits.
nPermSamples: Required Long variable that gets the number of permanent sample hits for the hits in this scan. It always returns zero for basic hits and vector hits.
dSpacer: Required Double variable that gets the spacing of the sample hits from the hit center. It always returns zero for basic hits and vector hits.
dIndent: Required Double variable that gets the indent of the sample hits from the hit center. It always returns zero for basic hits, vector hits, and surface.
dDepth: Required Double variable that gets the depth of the sample hits from the hit center. It always returns zero for basic hits, vector hits, and surface.
BasicScan.GetMethodParams
Syntax
Return Value=expression. GetMethodParams (bIn, bCenteringType, nCenteringDirection, dDiameter, dArcAngle, dDepth, dPitch)
Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
bIn: Required variable that gets 0 for Inside scans, 1 for Outside scans, and 2 for Plane Circle scans.
bCenteringType: Required Variable for Centering Scans that gets 0 for Axis Centering and 1 for Plane centering.
nCenteringDirection: Required Long variable that takes a +1 for measurement with the direction of the probe and –1 for against the direction of probe.
dDiameter: Required Double variable that gets the diameter of the circle or cylinder scan, and zero otherwise.
dArcAngle: Required Double variable that gets arc angle for circle and cylinder scans.
dDepth: Required Double variable that gets the depth for cylinder scans, and zero otherwise.
dPitch: Required Double variable that gets a Pitch for Cylinder scans.
Remarks
192 • Automation PC-DMIS Basic Language Reference Method GetMethodParams (bIn, bCenteringType,
nCenteringDirection, dDiameter, dArcAngle, dDepth, dPitch)
Linear None
Edge None
Circle bIn, , , dDiameter, dArcAngle, dDepth Cylinder bIn, , , dDiameter, dArcAngle, dDepth, dPitch
Str Line None
Center , bCenteringType, nCenteringDirection
BasicScan.GetMethodPointData
Syntax
Return Value=expression. GetMethodPointData (MethodStart, MethodEnd, MethodInitTouch, MethodEndTouch, MethodInitDir, MethodCutPlane)
Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
MethodStart: Required PointData object that gets the MethodStart property.
MethodEnd: Required PointData object that gets the MethodEnd property.
MethodInitTouch: Required PointData object that gets the MethodInitTouch property.
MethodEndTouch: Required PointData object that gets the MethodEndTouch property.
MethodInitDir: Required PointData object that gets the MethodInitDir property.
MethodCutPlane: Required PointData object that gets the MethodCutPlane property.
Remarks
If scan is a BasicScanCommand object, and MS, ME, MIT, MET, MID,and MCP are all Dimensioned as Object, the following are equivalent:
scan.GetMethodParams MS,ME,MIT,MET,MID,MCP set MS = scan.MethodStart
set ME = scan.MethodEnd set MIT = scan.MethodInitTouch set MET = scan.MethodEndTouch set MID = scan.MethodInitDir set MCP = scan.MethodCutPlane
This method is provided as a shortcut to getting these commonly used properties all at once.
BasicScan.GetNomsParams
Syntax
Return Value=expression. GetNomsParams (dFindNomsTolerance, dSurfaceThickness, dEdgeThickness)
PC-DMIS Basic Language Reference Automation • 193 Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
dFindNomsTolerance: Required Double variable that gets the Find Noms tolerance and is used only when the NominalMode property is
BSCANNMODE_FINDCADNOMINAL.
dSurfaceThickness: Required Double variable that gets the surface thickness and is used only when the NominalMode property is
BSCANNMODE_FINDCADNOMINAL.
dEdgeThickness: Required Double variable that gets the edge thickness and is used only when the NominalMode property is BSCANNMODE_FINDCADNOMINAL and when the Method property is BSCANMETH_EDGE.
BasicScan.GetParams
Syntax
Return Value=expression. GetParams (Method, Filter,
OperationMode, HitType, NominalMode, BoundaryCondition) Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
Method: Required Long variable that gets the Method property.
Filter: Required Long variable that gets the Filter property.
OperationMode: Required Long variable that gets the OperationMode property.
HitType: Required Long variable that gets the HitType property.
NominalMode: Required Long variable that gets the NominalMode property.
BoundaryCondition: Required Long variable that gets the BoundaryCondition property.
Remarks
If scan is a BasicScanCommand object, and M, F, O, H, N,and B are all Dimensioned as Object, the following are equivalent:
scan.GetParams M, F, O, H, N, B
This method is provided as a shortcut to getting these commonly used properties all at once.
BasicScan.SetBoundaryConditionParams
Syntax
Return Value=expression.SetBoundaryConditionParams (nCrossings, dRadius, dHalfAngle)
194 • Automation PC-DMIS Basic Language Reference Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
nCrossing: Required Long that sets the number of crossings for this boundary condition.
dRadius: Required Double that sets the radius of the boundary condition.
dHalfAngle: Required Double that sets the half-angle of the cone-type boundary condition, or is ignored if the boundary condition is not of cone type.
Remarks
BasicScan.SetBoundaryPoint
Syntax
Return Value=expression.SetBoundaryPoint (Index, X,Y, Z)
Return Value: This method returns a boolean value. Boolean returns true if the function succeeds, false if it fails.
expression: Required expression that evaluates to a PC-DMIS BasicScanCommand object.
Index: Required Long which indicates which boundary point to set.
X: Required Long that indicates the X value of the bounday point.