Send Topic Feedback | See Object Hierarchy Chart
PC-DMIS 2023.1 Object Library
Overview 
PCDLRN ActiveX DLL : PartProgram Object
PartProgram Object Members
Public Methods
Makes measurement routine the active measurement routine
This function starts execution of the measurement routine and then returns immediately, allowing for asynchronous execution.
Converts BMWMess programs into groups
Calculates part adjustment transformation in machine coordinates
Clears the persistent User Assigned Properties data for all reports
This clears the start and end commands set by the SetExecutionBlock method.
Clears the User Marked Set for execution set by SetExecutionMarkedSet
Clears the persistent User Assigned Properties data for the current report
Clear the VerifyFeatures Flag

This subroutine saves, closes, and deactivates the measurement routine.

This method accesses the .ipd file that is specified in the Parameters File settings entry under the Planner section of the PC-DMIS Settings Editor. It then copies any inspection planner settings for auto features contained in that file and sets the equivalent PC-DMIS default settings entries to those settings.
Tries to guess what command was measured and applies the appropriate dimension to it
This function outputs DMIS results to a file.
Outputs DMIS results to a file; option for output last instance only
This method can take two parameters, a start command and an end command. These define a range of commands. The method then adds MOVE/POINT commands between each feature command within this range. If you don't specify a start or end command then the range includes all the features in the measurement routine.
This method can take two parameters, a start command and an end command. These define a range of commands. The method then performs a collision detection check for all features within this range. If you don't specify a start or end command then the range includes all the features in the measurement routine.
Import And Mapping
Do Standard Import and reset SensorMapping
Edit Warning Message for Features To be Deleted
Edits basic script rules file for default parameter managment (Inspection Planner)
This function executes the measurement routine.
This method executes a mini routine based on the mini routine's name.
This method executes multiple mini routines contained within an array of strings. Each item in the array is a mini routine name.
This method executes a mini routine based on the mini routine's UID (unique ID).
This method executes multiple mini routines contained within an array of strings. Each item in the array is a UID (unique ID).

This function exports CAD or part data from the measurement routine to the indicated file. The export format is determined by the file name extension of Name.

Exports complete data dictionary to an XML file
Export stats xml to specified file position

 

This exports the measurement routine as an XML file.

ExternalCommandEvent

 

This returns a list of either schema numbers or version names available to the SaveAs3 method.

Returns the current User Marked Set Index for execution set by SetExecutionMarkedSet. -1 means No Marked Set
Returns object pointer to the Execution Window for the specified arm if available
This returns a True (-1) or False (0) to identify whether there's a defined marked set for the passed index value.
Returns the max munber of allowed marked set and the number of marked set currently defined
Returns object pointer to Readout Window
Creates an array of strings.
This method returns a variable object specified by the string in VarName.
Tries to guess what command has just been measured
IgnoreLearnModeHits

This function imports CAD or part data from the indicated file to the measurement routine. The file format is determined by the file name extension of Name.

Imports from another format into the measurement routine. The parameter indicates if the input should be merged

A .planxml file contains a measurement plan created from the Planner application. This is an xml file. You can import measurement plans into the measurement routine using this method.

Import Planxml into existing command in Part Program
Import Quick Features Defaults From ConfigServer To PcDmis Registry
ImportUGDCI
ImportUGDCI2. The parameter indicates if the input should be merged

 

This imports a measurement routine in an XML format into the current measurement routine.

Inject Repository Info
Insert tip command (defined by vector) if required

Returns TRUE if the current loaded probe in a measurement routine is an analog probe; it returns FALSE otherwise. If you have multiple probe types defined for a measurement routine, the return value will depend, of course, on the location of the insertion point in the measurement routine.

The LoadLayout method loads a customized PC-DMIS user-interface layout as if it were selected from the Windows Layout toolbar inside PC-DMIS. Also, if a layout has been created and moved to a different directory, you can access it by specifying the absolute or relative file name. For information on using this toolbar, see the "Using Toolbars" section inside your PC-DMIS Help File.

This function uses the PC-DMIS message box function. It includes all functionality including cancelling of execution tied to the Cancel button.

Overrides the current execution speed

This subroutine closes and deactivates the measurement routine without saving.

Read MSE Xml
Refreshes the display of the Part in the Edit window and in the CAD window.
Removes the last learn-mode hit

This executes the measurement routine using point data collected from a journal file.

This subroutine saves the measurement routine. If the measurement routine has not been saved before, it opens a Save As Dialog box which requires that you name the file.

 

This lets you save the measurement routine with a new name or in a new file location.

 

This method lets you save the measurement routine with a new name or in a new file location. It differs from the SaveAs method by letting you save the CAD file as a reference.

This method lets you save the measurement routine with a new name or in a new file location. It differs from the SaveAs method by letting you specify the version name or schema number and by saving the CAD file as a reference.

Set Cad equals Part
This method defines a block of commands to execute. Calls are made to the Execute or AsyncExecute functions until the execution block is cleared with the ClearExecutionBlock method.
Sets the User Marked Set for execution, calls to Execute or AsyncExecute will used until cleared. Returns false if requested marked set does not exist
Set IP Plan Version
This method calls a text file as a string. The XML content in the text file defines the features or dimensions you want to use for feature based measurement. Based on the contents of the XML, PC-DMIS can marks those commands, and any dependent commands.
This method sets the value defined in Value for the variable specified by the string in VarName.
Set the VerifyFeatures Flag
Starts Mesh from OptoCat
Stops Mesh from OptoCat
Enters/Exits Master-Slave Mode
Delays script execution until path lines are created

This method waits until the specified Command object executes, or until Timeout seconds pass.

Public Properties
 
Returns the Machine object associated with this measurement routine.
Represents the read-only PC-DMIS application. The Application object includes properties and methods that return top-level objects. For example, the ActivePartProgram property returns a PartProgram object.
Read Only: Returns object pointer Bundled Station collection
Read Only: Returns Cad Model Object
Returns the CadWindows object associated with this measurement routine.
Returns the Commands collection object of this measurement routine.
Read Only: Returns true when computer connected as driving computer
Read Only: Returns true when computer connected as relay computer

Returns TRUE if the measurement routine is on the master computer but is running as the slave measurement routine. Returns FALSE otherwise.

Returns TRUE if the measurement routine is on the slave computer but is running as the master measurement routine. Returns FALSE otherwise.
This read/write property returns or sets the active arm when using PC-DMIS in multiple arm mode.
Read: Returns the Name of current probe file
Returns the Editwindow object associated with this measurement routine.

Returns a single string containing all the text of the entire Edit window as seen in the Edit window's command mode. Read only.

Read/Write: Get/Set the current excel output file index
Read/Write: Get/Set the current excel output file method
Read/Write: Get/Set the current excel output file name
Read/Write: Property indicating if Continue button is set visible on new Execution Options Dialogs
Read/Write: Property indicating if Jump button is set visible on new Execution Options Dialogs
Read/Write: Property indicating if Skip button is set visible on new Execution Options Dialogs
Read/Write: Property indicating if Stop button is set visible on new Execution Options Dialogs
The ExecutedCommands property returns the ExecutedCommands object. This object contains a collection class of those commands last executed for the current measurement routine.
Read/Write: Gives status / makes execute dialog visible or hidden

Returns TRUE if, during measurement routine execution, the execution is cancelled. Otherwise it returns FALSE. The default value is FALSE.

Returns the measurement routine’s full file path and name.

Read Only: Returns the information as the part program / measurement routine has been modified
Read/Write: Returns/Sets laser only sequential part program execution mode
Read Only: Returns object pointer of type LIVWindow
This enables or disables the Child Mode for Edit window Markings. If enabled and something is marked, any children commands related to the parent command is also marked.
This property enables or disables the New Alignment Mode menu option in PC-DMIS and by doing so it determines whether or not the alignment associated with marked feature or dimensions is also marked for execution.
This enables or disables the Parent Mode for Edit window Markings. If enabled and something is marked, any parent commands related to the child command is also marked.
This returns a read-only pointer to the Multiple Arm Calibration dialog box, opening the dialog box if necessary.
Read Only: Returns if Mesh from OptoCat has started

Returns the measurement routine’s file name.

Read: Property indicating no Probes object are instantiated

Returns this measurement routine’s OldBasic object. The OldBasic object contains all of the methods from the old basic command set used in previous versions of PC-DMIS.

Once you have the pointer you can use properties and methods from that object to perform path optimizations.

When you generate a saved output file using automatic indexing with the Edit window PRINT/AUTO command, PC-DMIS uses an index value as a base. It then it increments the index if there's a duplicate file name in the same directory so that you end up with a unique file name.

This property lets you get or set the index value stored in the part program.

When you generate a saved output file with the Edit window PRINT Command, PC-DMIS stores that file in a directory of your choice.

This property returns a string of the file name used by the part program.

Returns the PartPrograms collection object to which this measurement routine belongs.
Returns a string with the part's GUID (Globally Unique Identifier).
Represents the part name of the measurement routine.
Read Only: Returns object pointer to PartProgramSettings Object

Returns the measurement routine’s file path. 

The Probes property returns this measurement routine’s Probes collection object.
Read Only: Returns the IProbeToolBoxPages Object
Read Only: Property indicating the version name the measurement routine has been saved to
Read Only: Property indicating the schema number the measurement routine has been saved to
Read Only: Returns object pointer to QuickStart Object
Read/Write: Property indicating whether to send or not readout events
Read Only: Returns object pointer of type ReportWindow
Represents the measurement routine’s revision number.
Read Only: Returns the RoutineExecutionTimeManager Object
Represents the measurement routine’s serial number.
Read/Write: Property indicating whether to show all IDs in the CAD Window
Read Only: Returns Execution speed (0 if not executing)
Returns or sets the stats count for the current measurement routine. Read/Write Long.
The Tools property returns this measurement routine’s  Tools collection object.
Returns the measurement unit type used in the measurement routine. Either inches or millimeters.

Represents the measurement routine’s visibility status.

Events
Event fired when collision detected

This event gets launched when the specified Command gets added to the measurement routine.

Event fired when collision detect ends

This event gets launched when PC-DMIS finishes executing the measurement routine. PC-DMIS determines it has finished execution based on the termination type.

This event gets launched when the Execution Mode Options dialog box displays ErrorMsg.

This event gets launched when the Execution Mode Options dialog box displays StatusMsg.

Event fired when PC-DMIS guesses the feature being measured

This event gets launched immediately before the specified Command gets executed.

This event gets launched immediately before the specified Command gets executed on a specified Arm of a multiple arm system.

This event gets launched immediately after the specified Command gets executed.

This event gets launched immediately after the specified Command gets executed on a specified Arm of a multiple arm system.

For information, see the OnReportPrintStart event from the ApplicationObjectEvents object. It's the same.

This event is also provided here as a convenience.

For information, see the OnReportPrintStart event from the ApplicationObjectEvents object. It's the same.

This event is also provided here as a convenience.

Event fired when collision detect begins
Event fired when measurement routine execution begins
See Also