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

Collapse All Expand All

# Public Methods

AddBundleInstance | Adds a bundle instance into the bundle alignment linked list for the specified station index. Returns false if the station number doesn't exist or the instance already exists
Compute | Performs mathematical evaluation of the command
CreateBundleFeatures | Creates bundled features. Returns false if the command is not a bundle alignment
Dialog | Displays the edit dialog for the command object (if it exists) Opens the PC-DMIS dialog box for the corresponding command.
Dialog2 | Displays the edit dialog and sets the dialog object to the dialog (if it exists) Opens the PC-DMIS dialog for the corresponding command.
EXECUTE | Attempts to execute the current command. Executes the command if the command is immediately executable.
GetBundleInstance | Gets the bundle instance of the command for the specified station index.A NULL pointer is returned if there is no instance at that index
GetExpression | Gets the expression of the indicated field of the command. Gets the expression of the indicated field of the command.
GetText | Returns the text used to represent a data item of the object. Gets the text of the indicated field of the command.
GetToggleString | Returns the toggle text delimited by the | symbol if the field is a toggle field, otherwise returns an empty string. Returns the string of text of a toggle field.
GetToolkitData | Returns the value of the Toolkit data object
GetUniqueID | Retrieves the low and high parts of the 64-bit unique id of the command This command retrieves the low and high parts of the 64-bit unique id of the command.
IsBundledCommand | Checks if command is a bundled command
IsExpressionValid | Returns true if expression is a valid PC-Dmis expression. Determines whether or not an expression is valid.
Item | Returns the execute instance of the object if the object has been executed more than once
Mark | Marks current command and dependencies or unmarks command. Marks the current object and all objects that depend on it. Optionally the features of the current alignment are also marked.
Next | Changes current command object to point to the next command object in the collection Accesses the next command in the parent Commands list.
OptimizedSetExpression | Like Set Expression, but optimized for speed (less accurate)
OptimizedSolveExpression | Like Solve Expression, but optimized for speed (less accurate)
Prev | Changes current command object to point to the previous command object in the collection Accesses the previous command in the parent Commands list.
PutText | Puts the specified text into the object data item Puts text into the indicated field of the command.
PutToolkitData | Sets to value of the Toolkit data object
ReDraw | Redraws the command to show updated properties in the edit window This method requests that the object be redrawn in the Edit window.
Remove | Removes the current command object from the commands collection object Removes a command from the Commands list.
RemoveBundleInstance | Removes the bundle instance of the command for the specified station index. Returns false if the station does not exist or there is no instance
RemoveExpression | Removes any existing expression from the indicated field of the command. Removes the expression from the indicated field of the command.
SetBothArms | Sets command to be executed by Both Arms, returns false if command is a two state command
SetExpression | Sets the expression for the indicated field of the command. Sets the expression of the indicated field of the command.
SetMasterArm | Sets command to be executed by Master only.
SetSlaveArm | Sets command to be executed by Slave only, r eturns false if command cannot be slave owned
SetToggleString | Sets a toggle field to a numbered value in the toggle field list This method lets you set a toggle field in a numerical, language-independent way.
SolveExpression | Solves expression, if valid, and returns a variable object. SolveExpression evaluates the expression based on the objects above the command on which SolveExpression gets called.
ToggleCommandType | Toggles the command type. A new toggled command is returned
UpdateDimensionNominals | Updates the nominals of related dimensions.

# Public Properties

_ID |
ActiveTipCommand | Read Only: Returns an automation active tip object if the current command object is of the correct type Returns an ActiveTip object if Command is of Type SET_ACTIVE_TIP. Nothing otherwise. Read-only.
AlignmentCommand | Read Only: Returns the alignment command object interface for the current command if it is an alignment object Returns this Command object as an AlignCmnd object if it can, Nothing otherwise.
Application | Read Only: Returns the Application Object 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.
ArrayIndexCommand | Read Only: Returns an automation array index object if the current command object is of the correct type Returns an ArrayIndex object if Command is of Type ARRAY_INDEX. Returns Nothing otherwise. Read-only.
AttachCommand | Read Only: Returns an automation attach object if the current command object is of the correct type Returns an Attach object if Command is of Type ATTACH_PROGRAM. Returns Nothing otherwise. Read-only.
BasicScanCommand | Read Only: Returns the basic scan command object interface for the current command if it is a basic scan object Returns this Command object as a BasicScan object if it can, Nothing otherwise. Read-only. Only Command objects of type BASIC_SCAN_OBJECT can become BasicScan objects.
BothArms | Read Only: Property indicating whether the command belongs to the both arms
CalibrationCommand | Read Only: Returns an automation calibration object if the current command object is of the correct type Returns a Calibration object if Command is of Type CALIB_SPHERE. Otherwise it returns Nothing. Read-only.
CommentCommand | Read Only: Returns an automation comment object if the current command object is of the correct type Returns a Comment object if Command is of Type SET_COMMENT. Otherwise it returns Nothing. Read-only.
CopyMeasToNom | Read/Write: Flag that causes measured values to be copied to nominal values after execution Property used to indicate/set whether the object should execute in MASTER mode. After executing in MASTER mode, the object copies the measured vector, centroid, and other nominal information to the nominals and turns off MASTER mode. This copies the same information that gets calculated using the CalculateNominals method.
Count | Read Only: The number of times the command was executed during the last execution Represents the number of copies of this Command which are available. If the part program is currently being executed, it is the number of times it has been executed so far in the current execution cycle. If the part program is not currently being executed, it is the number of times it was executed during the previous execution cycle. If Command has never been executed, Count has the value one.
DataTypes | Read Only: Returns the data type information collection for this command
DimensionCommand | Read Only: Returns the dimension command object interface for the current command if it is a dimension object Returns this Command object as a DimensionCommand object if it can, Nothing otherwise. Read-only.
DimensionEndCommand | Read Only: Returns the dimension end command object interface for the current command if it is a dimension end object
DimFormatCommand | Read Only: Returns an automation dimension format object if the current command object is of the correct type Returns a DimFormat object if Command is of Type DIMENSION_FORMAT. Otherwise it returns Nothing. Read-only.
DimInfoCommand | Read Only: Returns an automation dimension info object if the current command object is of the correct type Returns a DimInfo object if Command is of Type DIMENSION_INFORMATION. Otherwise it returns Nothing. Read-only.
DisplayID | Read Only: Current DisplayID of the command
DisplayMetaFileCommand | Read Only: Returns an automation display metafile object if the current command object is of the correct type Returns a DispMetaFile object if Command is of Type DISPLAY_METAFILE. Otherwise it returns Nothing. Read-only.
ExpectsMiss | Read/Write: Indicates whether script should plan for a miss error for this command
ExternalCommand | Read Only: Returns an automation external command object if the current command object is of the correct type Returns an ExternalCommand object if Command is of Type EXTERNAL_COMMAND. Otherwise it returns Nothing. Read-only.
Feature | Read Only: Type of feature (ie. Circle, Line, Sphere, etc.) or 0 if not a feature Represents the kind of feature that this Command object is.
FeatureCommand | Read Only: Returns the feature command object interface for the current command if it is a feature object Returns this Command object as a FeatCmd object if it can, Nothing otherwise. Read-only.
FileIOCommand | Read Only: Returns an automation file I/O object if the current command object is of the correct type Returns a FileIO object if Command is of Type FILE_IO_OBJECT. Otherwise it returns Nothing. Read-only.
FlowControlCommand | Read Only: Returns the flow control command object interface for the current command if it is a flow control object Returns this Command object as an FlowControlCmnd object if it can, Nothing otherwise. Read-only. The Commands that have the following Type can become FlowControlCmnd objects are as follows:

LOOP_START
START_SUBROUTINE
CALL_SUBROUTINE
LABEL
GOTO
IF_GOTO_COMMAND
BASIC_SCRIPT
ONERROR
WHILE_COMMAND
ENDWHILE_COMMAND
IF_BLOCK_COMMAND
END_IF_COMMAND
IF_ELSE_COMMAND
END_IF_ELSE_COMMAND,
END_ELSE_COMMAND
DO_COMMAND
UNTIL_COMMAND
CASE_COMMAND
END_CASE_COMMAND
DEFAULT_CASE_COMMAND
END_DEFAULT_CASE_COMMAND
SELECT_COMMAND
END_SELECT_COMMAND

GetDataTypeCount | Returns the number of instances of the supplied data type in command
GetDataTypeCountUniqueIndex | Returns the number of instances of the supplied data type in command at the specified type index
GetFieldValue | Returns the value of the indicated field of the command. This read-only property returns the value of a field from a command. If you try to access a field that isn't supported by the command, PC-DMIS returns FALSE. This property takes two parameters, the first parameter defines the field item. You can select this item from an enumerated list or use the associated constant number. The second parameter specifies the TypeIndex.
GetToggleValue | Returns 0 if the field is not a toggle otherwise returns the toggle index This read-only property checks a command's field and returns 0 if it isn't a toggle field. It also returns 0 if the field doesn't exist. Otherwise, it returns a the current toggle index value, with 1 as the base index value.

It takes two parameters. The first is an enumerated field type value to determine what field to check in a command, and the second is the TypeIndex.

HasBreakpoint | Read/Write: Flag that represents if the command has a breakpoint set Determines whether or not the current PC-DMIS command has a breakpoint.
HasField | Checks is the the command has the indicated field.
ID | Read/Write: ID of the command Represents the ID of the command.
IsActiveTip | Read Only: Indicates whether the command is a active tip command Determines whether or not the command is an ActiveTip command.
IsAlignment | Read Only: Indicates whether the command is an alignment command Determines whether or not the command is an alignment command type.
IsArrayIndex | Read Only: Indicates whether the command is a array index command Determines whether or not the command is an ArrayIndex command.
IsAttach | Read Only: Indicates whether the command is a attach command Determines whether or not the command is an Attach command.
IsBasicScan | Read Only: Indicates whether the command is a basic scan command Determines whether or not the command is a basic scan command.
IsCalibration | Read Only: Indicates whether the command is a calibration command Determines whether or not the command is a Calibration command.
IsComment | Read Only: Indicates whether the command is a comment command Determines whether or not the command is a Comment command.
IsConstructedFeature | Read Only: Indicates whether the command is a constructed feature command Determines whether or not the command is a constructed feature.
IsDCCFeature | Read Only: Indicates whether the command is a DCC command Determines whether or not the command is a DCC (Auto) Feature.
IsDimension | Read Only: Indicates whether the command is a dimension command Determines whether or not the command is a Dimension command type.
IsDimFormat | Read Only: Indicates whether the command is a dimension format command Determines whether or not the command is a DimFormat command.
IsDimInfo | Read Only: Indicates whether the command is a dimension info command Determines whether or not the command is a DimInfo command.
IsDisplayMetaFile | Read Only: Indicates whether the command is a display metafile command Determines whether or not the command is a DispMetaFileCommand.
IsExternalCommand | Read Only: Indicates whether the command is a external command command Determines whether or not the command is an ExternalCommand.
IsFeature | Read Only: Indicates whether the command is a feature command Determines whether or not the command is a feature command type.
IsFileIOCommand | Read Only: Indicates whether the command is a file I/O command Determines whether or not the command is a FileIO command.
IsFlowControl | Read Only: Indicates whether the command is a flow control command Determines whether or not the command is a flow control command type.
IsHit | Read Only: Indicates whether the command is a hit command Determines whether or not the command is one of the hit command types.
IsLeapfrog | Read Only: Indicates whether the command is a leap frog command Determines whether or not the command is a Leapfrog command.
IsLoadMachine | Read Only: Indicates whether the command is a load machine command Determines whether or not the command is a LoadMachine command.
IsLoadProbe | Read Only: Indicates whether the command is a load probe command Determines whether or not the command is a LoadProbe command.
IsMeasuredFeature | Read Only: Indicates whether the command is a measured feature command Determines whether or not the command is a Measured Feature command.
IsModal | Read Only: Indicates whether the command is a modal command Determines whether or not the command is a modal command type.
IsMove | Read Only: Indicates whether the command is a move command Determines whether or not the command is a Move command.
IsOptionProbe | Read Only: Indicates whether the command is a option probe command Determines whether or not the command is an option probe command.
IsOptMotion | Read Only: Indicates whether the command is a optional motion command Determines whether or not the command is an OptMotion command.
IsScan | Read Only: Indicates whether the command is a scan command Determines whether or not the command is a Scan command.
IsStatistic | Read Only: Indicates whether the command is a statistic command Determines whether or not the command is a Statistics command.
IsTempComp | Read Only: Indicates whether the command is a temperature compensation command Determines whether or not the command is a TempComp command.
IsToolkitCommand | Read Only: Indicates whether the command is a toolkit command
IsTraceField | Read Only: Indicates whether the command is a trace field command Determines whether or not the command is a TraceField command.
ItemIndex | Returns the execute instance index if the object has been executed more than once otherwise returns 0
LeapfrogCommand | Read Only: Returns an automation leap frog object if the current command object is of the correct type Returns a LeapFrog object if the Command is of Type LEAPFROG. Otherwise it returns Nothing. Read-only.
LoadMachineCommand | Read Only: Returns an automation load machine object if the current command object is of the correct type Returns a LoadMachine object if Command is of Type GET_MACHINE_DATA. Otherwise it returns Nothing. Read-only.
LoadProbeCommand | Read Only: Returns an automation load probe object if the current command object is of the correct type Returns a LoadProbe object if Command is of Type GET_PROBE_DATA. Otherwise it returns Nothing. Read-only.
Marked | Read/Write: Returns/Sets the marked for execution status of the current command Property used to indicate/set whether command is marked in the edit window.
MasterArm | Read Only: Property indicating whether the command belongs to the master arm only
MissedHit | Read Only: Indicates whether a missed hit occured on the last executed command This property checks whether or not a missed hit occurred on the last executed instance of the specified command.
ModalCommand | Read Only: Returns the modal command object interface for the current command if it is a modal object Returns a ModalCommand object for the Command if it can, Nothing otherwise. Read-only.
MoveCommand | Read Only: Returns the move command object interface for the current command if it is a move object Returns this Command object as a ModalCommand object if it can, Nothing otherwise. Read-only.
OptionProbeCommand | Read Only: Returns an automation optional probe object if the current command object is of the correct type Returns an OptProbe object if Command is of Type OPTIONPROBE. Otherwise it returns Nothing. Read-only.
OptMotionCommand | Read Only: Returns an automation optional motion object if the current command object is of the correct type Returns an OptMotion object if Command is of Type OPTIONMOTION. Otherwise it returns Nothing. Read-only.
Parent | Read Only: Returns the Parent Commands Collection Object Returns the parent Commands collection object. Read-only.
RecalculateINOUT | Read/Write: Flag that determines if the INNER/OUTER flag is recalculated after execution
ScanCommand | Read Only: Returns an automation scan object if the current command object is of the correct type Returns a Scan object if Command is of Type DCCSCAN_OBJECT or Type MANSCAN_OBJECT. Otherwise it returns Nothing. Read-only.
ShowIDOnCad | Read/Write: Property indicating whether the command id should appear in the cad window Property used to indicate/set whether the command ID should be displayed in the CAD window.
Skipped | Read Only: Indicates whether the command has been skipped or not Property used to indicate whether the a command was skipped over.
SlaveArm | Read Only: Property indicating whether the command belongs to the slave arm only Property used to indicate/set whether command is a slave arm object.
SlotType | SlotType: Property indicating whether a command is a slot of a certain type
StatisticCommand | Read Only: Returns an automation statistic object if the current command object is of the correct type Returns a Statistics object if Command is of Type STATISTICS. Otherwise it returns Nothing. Read-only.
TempCompCommand | Read Only: Returns an automation temperature compensatiion object if the current command object is of the correct type Returns a TempComp object if Command is of Type TEMP_COMP. Otherwise it returns Nothing. Read-only.
ToolkitInternalCommands | Read Only: Returns a collection of the toolkit internal commands
TraceFieldCommand | Read Only: Returns an automation trace field object if the current command object is of the correct type Returns a TraceField object if Command is of Type TRACEFIELD. Otherwise it returns Nothing. Read-only.
TracksErrors | Read/Write: Indicates Whether script will handle errors for this command Property used to determine whether or not the script will handle errors for the specified command.
Type | Read Only: The command type Returns the type of the Command.
TypeDescription | Read Only: Returns String Describing Object Type Returns a human-readable description of Type of the object. For example, an object of type CONST_OFF_PLANE has the string "Constructed Offset Plane" returned by this function.
UnexpectedHit | Read Only: Indicates whether an unexpected hit occured This property checks whether or not an unexpected hit occurred on the last executed instance of the specified command.
UserDefinedUniqueID | Read/Write: Gets/Sets user defined unique id

# See Also

Command Overview

© Wilcox Associates, Inc. All Rights Reserved.

© 2010 All Rights Reserved.