PC-DMIS 2019 R1 Object Library
OldBasic Object Members
See Also  Overview  Send Topic Feedback | See Object Hierarchy Chart
PCDLRN ActiveX DLL : OldBasic Object

Glossary Item Box

Public Methods

Public Method AddBoundaryPointThis function is used to add the initial point, end point, and other boundary points in the case of patch scans. It should be called for each boundary point to be added. It should not be called more than num_bnd_pnts times (as specified in the call to StartScan).
Public Method AddFeatureAdds a feature. This function is used for constructed features only. The parameters off1, off2, and off3 are only used in the case of offset points, planes, or lines.
Public Method AddLevelFeat

This function is used in conjunction with the iterate alignment command.

Public Method AddOriginFeat

This function is used in conjunction with the iterate alignment command.

Public Method AddRotateFeatAdds a rotation feature. This function is used in conjunction with the iterate alignment command
Public Method ArcCos

Return the arc cosine of x in degrees.

Public Method ArcSin

Returns the arc sine of x in degrees.

Public Method BestFit2DCreates a best fit 2d alignment
Public Method BestFit3DCreates a best fit 3d alignment
Public Method CalibrateCreates a probe calibration command
Public Method CatchMotionErrorTurns On/Off Catching of CMM motion errors
Public Method CheckCreates a check distance object
Public Method ClearPlaneCreates a clearplane settings object
Public Method CloseCommConnectionCloses the port opened with the OpenCommConnection command.
Public Method Column132Turns on or off 132 column mode.
Public Method CommentCreates a measurement routine comment object
Public Method CreateIDGenerates and returns an Id based on measurement routine generation settings
Public Method DefaultAxes

This command is used only for location and true position dimensions. If present, the default dimension axes are created. Calls to SetNoms with other axes passed as the dtype parameter will have no effect if this command is used.

Public Method DefaultHits

This command is used within a Startfeature - EndFeature block and is used to cause the hits specified in the hits parameter of the StartFeature command to be automatically generated.

Public Method DimFormatCreates a DimFormat command
Public Method EndAlign

This function must be called to end an alignment block.

Public Method EndDim

EndDim takes no parameters, but must be called to finish off the dimension block.

Public Method EndFeature

This function ends a measured, constructed, or auto feature block. It must always be present as the last function call in a feature block.

Public Method EndGetFeatPoint

Use this command to release the memory allocated for use by the StartGetFeatPoint and GetFeatPoint commands.

Public Method EndScan

Call this when all of the other scan functions needed have been called.

The scan object is inserted in the command list with a call to this function.

Public Method EquateAlignCreates Equate alignment object
Public Method Feature

This function must only be called after a call to BestFit2D, BestFit3D, or Iterate

Public Method FlatnessThis function was added for the tutor translator, and should be used with caution.
Public Method GapOnlyCreates Gap Only Dimension Object
Public Method GetDimDataGet dimension data from dimension specified by ID
Public Method GetDimOutTol

Returns the number of features that are out of tolerance at the time that this command is executed.

Public Method GetFeatDataGets feature data from command with specified ID
Public Method GetFeatIDReturns id of indexed feature
Public Method GetFeatPointThis function is called after a call to StartGetFeatPoint to retrieve the actual points.
Public Method GetFeatureReturns feature type (ie. Circle, Line, Point...)
Public Method GetPH9StatusReturns 1 if a PH9 is available
Public Method GetProbeOffsetsReturns the current probe offsets
Public Method GetProbeRadiusReturns the current probe radius.
Public Method GetProgramOptionReturns the status of the application setting option
Public Method GetProgramValueReturns the value of the application setting
Public Method GetTopMachineSpeedReturns the top machine speed of the CMM.
Public Method GetTypeReturns the type of the object.
Public Method GetUnitsThe units of the current measurement routine.
Public Method HitUsed in feature block to add a hit to an object
Public Method IgnoreMotionErrorSets recalculation of nominals mode
Public Method IterateCreates Iterative Alignment Command
Public Method LevelCreates Level Alignment Command
Public Method LoadProbeCreates Load Probe Command
Public Method MaxMinAveReturns maximum, minimum, or average information for command of specified id
Public Method ModeCreates DCC / Manual Mode Command
Public Method MoveCreates Move (Probe or Rotary Table) Command
Public Method MoveSpeedCreates Move Speed Command
Public Method OpenCommConnectionOpens a connection to the specified comm port.
Public Method PreHitCreates Prehit Distance Command
Public Method ProbeCompCreates Probe Compensation Command
Public Method PutFeatDataPuts feature data into the command specified by the ID
Public Method ReadCommBlockReads characters from the comm port specified.
Public Method RecallExCreates Recall Alignment Command for External Alignments
Public Method RecallInCreates Recall Alignment Command for Internal Alignments
Public Method RetractCreates a Retract Distance Command
Public Method RetroOnlyCreates a Retrolinear Only Dimension Command
Public Method RotateCreates a Rotate Alignment Command
Public Method RotateCircleCreates a Circular Rotation Alignment Command
Public Method RotateOffsetCreates a Rotational Offset Command
Public Method RoundnessReturns roundness information for command of specified ID
Public Method RunOutReturns runout information for command of specified ID
Public Method SaveAlignCreates a Save Alignment Command
Public Method SetAutoParamsSets Auto Feature Parameters inside StartFeature Block
Public Method SetAutoVectorSets Auto Vector Components (used inside StartFeature Block)
Public Method SetNomsSet nominal values for dimension (used inside StartDimension Block)
Public Method SetPrintOptionsSets application printing options
Public Method SetProgramOptionSets application program option
Public Method SetProgramValueSets application program value
Public Method SetReportOptionsSets application reporting settings
Public Method SetRMeasModeSets Relative Measure mode to Relative or Absolute
Public Method SetScanHitParamsSets scan hit parameters (used in StartScan block)
Public Method SetScanHitVectorsSets hit vector components of scan (used in StartScan block)
Public Method SetScanParamsSets scan parameters (used in StartScan block)
Public Method SetScanVectorsSets vector components of scan (used in StartScan block)
Public Method SetSlaveModeTurns on/turns off slave mode (subsequent objects are slave object/master objects)
Public Method SetTheosSets theoretical values for feature (used in StartFeature block)
Public Method ShowXYZWindowShows or Hides the probe readouts window
Public Method SleepPauses execution for the specified number of seconds after the previous feature has finished executing.
Public Method StartAlignStarts Alignment block and sets alignment parameters
Public Method StartDimStarts Dimension block and sets dimension parameters
Public Method StartFeatureStarts Feature block and sets feature parameters
Public Method StartGetFeatPointThis function is used to retrieve the hit or input data from constructed, measured, and auto features, as well as the hit data for scans. To retrieve the actual points, subsequent calls to GetFeatPoint must be made. When all of the needed point values have been retrieved, a call to EndGetFeatPoint must be made to free the memory allocated for  the points.
Public Method StartScanStarts Scan block and sets sets scan parameters
Public Method StatsCreates Stats On/Off command
Public Method StraitnessReturns straitness information for command of specified ID
Public Method TipThe tip to load.
Public Method TouchspeedCreates touch speed command
Public Method TraceCreates trace field command
Public Method TranslateCreates translation alignment command
Public Method TranslateOffsetCreates a translation offset command
Public Method Wait

Waits until all preceding commands have been executed. The basic script creates commands and places them on the execute list more rapidly than the commands are executed. In a script it is often useful to pop up a dialog box for input after a certain series of commands has been executed. The script commands may complete long before the actual commands have been executed. The Wait command is useful to prevent the dialog box from popping up prematurely.

Public Method WorkplaneCreates a workplane object or gets the current workplane
Public Method WriteCommBlockWrites characters to the specified comm port.

Public Properties

Public Property ApplicationRead Only: Returns Application object
Public Property ParentRead Only: Returns the PartProgram object

See Also

Copyright © 2019. Hexagon Manufacturing Intelligence – Metrology Software, Inc. All Rights Reserved.