PC-Dmis 2010 MR1 Object Library | Send comments on this topic. | See Object Hierarchy Chart
PartProgram Object Members
See Also Overview

Collapse All Expand All

# Public Methods

Activate | Makes part program the active part program
AsyncExecute | Starts execution of the part program and returns immediately This function starts execution of the part program and then returns immediately, allowing for asynchronous execution.
AutoCreateGroupsForBMWMessPrograms | Converts BMWMess programs into groups
CalcAdjustTransform | Calculates part adjustment transformation in machine coordinates
ClearAllTADs | Clears the persistent User Assigned Properties data for all reports
ClearExecutionBlock | Clears the start and end commands set by SetExecutionBlock This clears the start and end commands set by the SetExecutionBlock method.
ClearExecutionMarkedSet | Clears the User Marked Set for execution set by SetExecutionMarkedSet
ClearTADs | Clears the persistent User Assigned Properties data for the current report
ClearVerifyFeaturesFlag | Clear the VerifyFeatures Flag
Close | Closes and saves the part program - object becomes invalid This subroutine saves, closes, and deactivates the part program.
CreateGuessWithDimension | Tries to guess what command was measured and applies the appropriate dimension to it
DmisOut | Outputs DMIS results to a file This function outputs DMIS results to a file.
DmisOut2 | Outputs DMIS results to a file; option for output last instance only
EditRulesFile | Edits basic script rules file for default parameter managment (Inspection Planner)
EXECUTE | Executes the part program This function executes the part program.
Export | Exports part program to another format This function exports CAD or part data from the part program to the indicated file. The export format is determined by the file name extension of Name.
ExportToXML | Export Part Program Data to XML This exports the part program as an XML file.
ExternalCommandEvent | ExternalCommandEvent
GetExecutionMarkedSetIndex | Returns the current User Marked Set Index for execution set by SetExecutionMarkedSet. -1 means No Marked Set
GetExecutionWindow | Returns object pointer to the Execution Window for the specified arm if available
GetMarkedSetName | Retrieve the Name of the User Marked Set identified by the index. Returns FALSE if the marked set is not defined
GetMarkedSetNumbers | Returns the max munber of allowed marked set and the number of marked set currently defined
GetReadoutWindow | Read Only: Returns object pointer to Readout Window
GetVariableValue | Returns a variable object of specified name, if it exists This method returns a variable object specified by the string in VarName.
Guess | Tries to guess what command has just been measured
IgnoreLearnModeHits | IgnoreLearnModeHits
Import | Imports from another format into the partprogram This function imports CAD or part data from the indicated file to the part program. The file format is determined by the file name extension of Name.
ImportUGDCI | ImportUGDCI
ImportXML | Import Part Program Data from XML This imports a part program in an XML format into the current part program.
IsProbeAnalog | Returns true if the current probe on the selected arm is analog Returns TRUE if the current loaded probe in a part program is an analog probe; it returns FALSE otherwise. If you have multiple probe types defined for a part program, the return value will depend, of course, on the location of the insertion point in the part program.
LoadLayout | Loads a layout file 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.
MessageBox | Prompts user with message box above the part program This function uses the PC-DMIS message box function. It includes all functionality including cancelling of execution tied to the Cancel button.
OverrideExecuteSpeed | Overrides the current execution speed
Quit | Quits the part program without saving This subroutine closes and deactivates the part program without saving.
RefreshPart | Refreshes the Part (Edit/CAD Window Refreshes the display of the Part in the Edit window and in the CAD window.
RemoveLastLearnHit | Removes the last learn-mode hit
RunJournalFile | Executes the part program with Journal File data This executes the part program using point data collected from a journal file.
Save | Saves the part program This subroutine saves the part program. If the part program has not been saved before, it opens a Save As Dialog box which requires that you name the file.
SaveAs | Saves the part program with the provided name
SetExecutionBlock | Sets the start and end commands for block execution, calls to Execute or AsyncExecute will used until cleared 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.
SetExecutionMarkedSet | 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
SetIPPlanVersion | Set IP Plan Version
SetupFeatureBasedMeasurement | Setup Feature Based Measurement from XML
SetVariableValue | Sets the variable value of specified name, if valid and can be set This method sets the value defined in Value for the variable specified by the string in VarName.
SetVerifyFeaturesFlag | Set the VerifyFeatures Flag
ToggleMasterSlaveMode | Enters/Exits Master-Slave Mode
WaitUntilExecuted | Delays script execution until command is executed This method waits until the specified Command object executes, or until Timeout seconds pass.

# Public Properties

_Name |
ActiveMachine | Read Only: Returns the machine object in use by part program - CMM or Offline Returns the Machine object associated with this part program.
Application | Read Only: Returns object pointer of type Application 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.
BundledStations | Read Only: Returns object pointer Bundled Station collection
CadModel | Read Only: Returns Cad Model Object
CadWindows | Read Only: Returns object pointer of type CadWindows Returns the CadWindows object associated with this part program.
Commands | Read Only: Returns object pointer of type Commands - access partprogram command list Returns the Commands collection object of this part program.
ConnectedInDriveMode | Read Only: Returns true when computer connected as driving computer
ConnectedInRelayMode | Read Only: Returns true when computer connected as relay computer
ConnectedToMaster | Read Only: Returns true if connected to master computer as slave Returns TRUE if the part program is on the master computer but is running as the slave part program. Returns FALSE otherwise.
ConnectedToSlave | Read Only: Returns true if connected to slave computer as master Returns TRUE if the part program is on the slave computer but is running as the master part program. Returns FALSE otherwise.
CurrentArm | Read/Write: Returns/Sets the current arm environment This read/write property returns or sets the active arm when using PC-DMIS in multiple arm mode.
CurrentProbeName | Read: Returns the Name of current probe file
EditWindow | Read Only: Returns object pointer of type EditWindow Returns the Editwindow object associated with this part program.
EditWindowTextAll | Read Only: Returns the probe readout window text in the current mode Returns a single string containing all the text of the entire Edit window as seen in the Edit window's command mode. Read only.
ExecutedCommands | Read Only: Returns the set of commands from the last execution The ExecutedCommands property returns the ExecutedCommands object. This object contains a collection class of those commands last executed for the current part program.
ExecuteDialogVisible | Read/Write: Gives status / makes execute dialog visible or hidden
ExecutionWasCancelled | Read Only: Returns true if the last execution run was cancelled Returns TRUE if, during part program execution, the execution is cancelled. Otherwise it returns FALSE. The default value is FALSE.
FullName | Read Only: Full filename for part program - includes path Returns the part program’s full file path and name.
MasterSlaveDlg | Read Only: Returns the Master/Slave Calibration Dialog Object This returns a read-only pointer to the Master/Slave Calibration dialog box, opening the dialog box if necessary.
Name | Read Only: Filename of part program - not including path Returns the part program’s file name.
NoActiveProbesObject | Read: Property indicating no Probes object are instantiated
OldBasic | Read Only: Old Basic object - gives access to old basic commands - v2.x Returns this part program’s OldBasic object. The OldBasic object contains all of the methods from the old basic command set used in previous versions of PC-DMIS.
Parent | Read Only: Returns object pointer to PartPrograms Object Returns the PartPrograms collection object to which this part program belongs.
PartName | Read/Write: PartName property of part program Represents the part name of the part program.
PartProgramSettings | Read Only: Returns object pointer to PartProgramSettings Object
Path | Read Only: Path where part program is located Returns the part program’s file path.
Probes | Read Only: Returns object pointer to probe files The Probes property returns this part program’s Probes collection object.
QuickStart | Read Only: Returns object pointer to QuickStart Object
ReadoutEnabled | Read/Write: Property indicating whether to send or not readout events
ReportWindow | Read Only: Returns object pointer of type ReportWindow
RevisionNumber | Read/Write: Revision Number of part program Represents the part program’s revision number.
SerialNumber | Read/Write: Serial Number of part program Represents the part program’s serial number.
ShowAllIDs | Read/Write: Property indicating whether to show all IDs in the CAD Window
Speed | Read Only: Returns Execution speed (0 if not executing)
StatsCount | Read/Write: Returns/Sets the current Stats Count; number of parts run Returns or sets the stats count for the current part program. Read/Write Long.
Tools | Read Only: Returns object pointer to tools {ie. calibration tools} The Tools property returns this part program’s Tools collection object.
Units | Read Only: Returns the unit type Returns the measurement unit type used in the part program. Either inches or millimeters.
Visible | Read/Write: Gives status / Makes part program visible Represents the part program’s visibility status.

# Events

OnAddObject | Event fired when command is added to part program This event gets launched when the specified Command gets added to the part program.
OnEndExecution | Event fired when part program execution ends This event gets launched when PC-DMIS finishes executing the part program. PC-DMIS determines it has finished execution based on the termination type.
OnExecuteDialogErrorMsg | Event fired when error message sent to execute dialog This event gets launched when the Execution Mode Options dialog box displays ErrorMsg.
OnExecuteDialogStatusMsg | Event fired when status message sent to execute dialog This event gets launched when the Execution Mode Options dialog box displays StatusMsg.
OnGuess | Event fired when PC-DMIS guesses the feature being measured
OnObjectAboutToExecute | Event fired before command is executed This event gets launched immediately before the specified Command gets executed.
OnObjectAboutToExecute2 | Event fired before command is executed for dual arm systems This event gets launched immediately before the specified Command gets executed on a specified Arm of a multiple arm system.
OnObjectExecuted | Event fired when command finishes execution This event gets launched immediately after the specified Command gets executed.
OnObjectExecuted2 | Event fired when command finishes execution for dual arm systems This event gets launched immediately after the specified Command gets executed on a specified Arm of a multiple arm system.
OnReadCncVar | Event fired when program reads CNC Variable
OnStartExecution | Event fired when part program execution begins
OnToolOffset | Event fired when program updates CNC ToolOffset
OnWorkOffset | Event fired when program updates CNC WorkOffset This event gets called when PC-DMIS/NC executes WorkOffset command. PC-DMIS/NC is a specialized version of PC-DMIS that allows you to execute part programs using your CNC (Computer Numeric Control) machine. For more information on PC-DMIS/NC, see the PC-DMIS NC documentation.
OnWriteCncVar | Event fired when program writes CNC Variable

# See Also

PartProgram Overview

© Wilcox Associates, Inc. All Rights Reserved.

© 2010 All Rights Reserved.