Command Object Members

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	Opens the PC-DMIS dialog box for the corresponding command.
Dialog2	Opens the PC-DMIS dialog box for the corresponding command.
EXECUTE	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.
GetExpressionEx	Gets the expression of the indicated field of the command [Extended DType]
GetNext	This method returns a new instance of the command that follows the current command in the Commands object. Unlike Next, this method does not change the current command but instead returns a new Command object.
GetPrev	This method returns a new instance of the command that precedes the current command in the Commands object. Unlike Next, this method does not change the current command but instead returns a new Command object.
GetText	Gets the text of the indicated field of the command.
GetTextEx	Returns the text used to represent a data item of the object [Extended DType]
GetToggleString	Returns the string of text of a toggle field.
GetToggleStringEx	Returns the toggle text delimited by the \| symbol if the field is a toggle field, otherwise returns an empty string [Extended DType]
GetToolkitData	Returns the value of the Toolkit data object
GetUniqueID	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	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 the current object and all objects that depend on it. Optionally the features of the current alignment are also marked.
Next	Accesses the next command in the parent Commands list.
OptimizedSetExpression	Like Set Expression, but optimized for speed (less accurate)
OptimizedSetExpressionEx	Like Set Expression, but optimized for speed (less accurate) [Extended DType]
OptimizedSolveExpression	Like Solve Expression, but optimized for speed (less accurate)
Prev	Accesses the previous command in the parent Commands list.
PutText	Puts text into the indicated field of the command.
PutTextEx	Puts the specified text into the object data item [Extended DType]
PutToolkitData	Sets to value of the Toolkit data object
ReDraw	This method requests that the object be redrawn in the Edit window.
Remove	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 the expression from the indicated field of the command.
RemoveExpressionEx	Removes any existing expression from the indicated field of the command [Extended DType]
SetBothArms	Sets command to be executed by Both Arms, returns false if command is a two state command
SetExpression	Use this command to set expressions for different fields in a command.
SetExpressionEx	Sets the expression for the indicated field of the command [Extended DType]
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	This method lets you set a toggle field in a numerical, language-independent way.
SetToggleStringEx	Sets a toggle field to a numbered value in the toggle field list [Extended DType]
SolveExpression	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	Returns an ActiveTip object if Command is of Type SET_ACTIVE_TIP. Nothing otherwise. Read-only.
AlignmentCommand	Returns this Command object as an AlignCmnd object if it can, Nothing otherwise.
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.
ArrayIndexCommand	Returns an ArrayIndex object if Command is of Type ARRAY_INDEX. Returns Nothing otherwise. Read-only.
AttachCommand	Returns an Attach object if Command is of Type ATTACH_PROGRAM. Returns Nothing otherwise. Read-only.
BasicScanCommand	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.
BladeScanCommand	Read Only: Returns the blade scan command object interface for the current command if it is a blade scan object
BothArms	Read Only: Property indicating whether the command belongs to the both arms
CalibrationCommand	Returns a Calibration object if Command is of Type CALIB_SPHERE. Otherwise it returns Nothing. Read-only.
CommandGUIDString	Each command in PC-DMIS has a unique idenification. This is the GUID (Globally Unique Identifier). This returns the identification as a string value.
CommentCommand	Returns a Comment object if Command is of Type SET_COMMENT. Otherwise it returns Nothing. Read-only.
CopyMeasToNom	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	Represents the number of copies of this Command which are available. If the measurement routine is currently being executed, it is the number of times it has been executed so far in the current execution cycle. If the measurement routine 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	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	Returns a DimFormat object if Command is of Type DIMENSION_FORMAT. Otherwise it returns Nothing. Read-only.
DimInfoCommand	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	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	Returns an ExternalCommand object if Command is of Type EXTERNAL_COMMAND. Otherwise it returns Nothing. Read-only.
FCFCommand	DEPRECATED: Read Only: Returns the FCF internal Profile Dimension if any
Feature	Represents the kind of feature that this Command object is.
FeatureCommand	Returns this Command object as a FeatCmd object if it can, Nothing otherwise. Read-only.
FileIOCommand	Returns a FileIO object if Command is of Type FILE_IO_OBJECT. Otherwise it returns Nothing. Read-only.
FlowControlCommand	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
GetDataTypeCountEx	Returns the number of instances of the supplied data type in command [Extended DType]
GetDataTypeCountUniqueIndex	Returns the number of instances of the supplied data type in command at the specified type index
GetDataTypeCountUniqueIndexEx	Returns the number of instances of the supplied data type in command at the specified type index [Extended DType]
GetFieldValue	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.
GetFieldValueEx	Returns the value of the indicated field of the command [Extended DType]
GetToggleValue	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.
GetToggleValueEx	Returns 0 if the field is not a toggle otherwise returns the toggle index [Extended DType]
HasBreakpoint	Determines whether or not the current PC-DMIS command has a breakpoint.
HasField	Checks is the the command has the indicated field.
HasFieldEx	Checks is the the command has the indicated field [Extended DType]
ID	Represents the ID of the command.
IsActiveTip	Determines whether or not the command is an ActiveTip command.
IsAlignment	Determines whether or not the command is an alignment command type.
IsArrayIndex	Determines whether or not the command is an ArrayIndex command.
IsAttach	Determines whether or not the command is an Attach command.
IsBasicScan	Determines whether or not the command is a basic scan command.
IsBlade	Read Only: Indicates whether the command is an blade command
IsCalibration	Determines whether or not the command is a Calibration command.
IsComment	Determines whether or not the command is a Comment command.
IsConstructedFeature	Determines whether or not the command is a constructed feature.
IsDCCFeature	Determines whether or not the command is a DCC (Auto) Feature.
IsDimension	Determines whether or not the command is a Dimension command type.
IsDimFormat	Determines whether or not the command is a DimFormat command.
IsDimInfo	Determines whether or not the command is a DimInfo command.
IsDisplayMetaFile	Determines whether or not the command is a DispMetaFileCommand.
IsExternalCommand	Determines whether or not the command is an ExternalCommand.
IsFCFCommand	DEPRECATED: Read Only: Indicates whether the command is a FCF Command
IsFeature	Determines whether or not the command is a feature command type.
IsFileIOCommand	Determines whether or not the command is a FileIO command.
IsFlowControl	Determines whether or not the command is a flow control command type.
IsHit	Determines whether or not the command is one of the hit command types.
IsLeapfrog	Determines whether or not the command is a Leapfrog command.
IsLoadMachine	Determines whether or not the command is a LoadMachine command.
IsLoadProbe	Determines whether or not the command is a LoadProbe command.
IsMeasuredFeature	Determines whether or not the command is a Measured Feature command.
IsModal	Determines whether or not the command is a modal command type.
IsMove	Determines whether or not the command is a Move command.
IsOptionProbe	Determines whether or not the command is an option probe command.
IsOptMotion	Determines whether or not the command is an OptMotion command.
IsScan	Determines whether or not the command is a Scan command.
IsStatistic	Determines whether or not the command is a Statistics command.
IsTempComp	Determines whether or not the command is a TempComp command.
IsToleranceCommand	Read Only: Indicates whether the command is a Tolerance Command
IsToolkitCommand	Read Only: Indicates whether the command is a toolkit command
IsTraceField	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	Returns a LeapFrog object if the Command is of Type LEAPFROG. Otherwise it returns Nothing. Read-only.
LoadMachineCommand	Returns a LoadMachine object if Command is of Type GET_MACHINE_DATA. Otherwise it returns Nothing. Read-only.
LoadProbeCommand	Returns a LoadProbe object if Command is of Type GET_PROBE_DATA. Otherwise it returns Nothing. Read-only.
Marked	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	This property checks whether or not a missed hit occurred on the last executed instance of the specified command.
ModalCommand	Returns a ModalCommand object for the Command if it can, Nothing otherwise. Read-only.
MoveCommand	Returns this Command object as a ModalCommand object if it can, Nothing otherwise. Read-only.
OptionProbeCommand	Returns an OptProbe object if Command is of Type OPTIONPROBE. Otherwise it returns Nothing. Read-only.
OptMotionCommand	Returns an OptMotion object if Command is of Type OPTIONMOTION. Otherwise it returns Nothing. Read-only.
Parent	Returns the parent Commands collection object. Read-only.
RecalculateINOUT	Read/Write: Flag that determines if the INNER/OUTER flag is recalculated after execution
ScanCommand	Returns a Scan object if Command is of Type DCCSCAN_OBJECT or Type MANSCAN_OBJECT. Otherwise it returns Nothing. Read-only.
ShowIDOnCad	Property used to indicate/set whether the command ID should be displayed in the CAD window.
Skipped	Property used to indicate whether the a command was skipped over.
SlaveArm	Property used to indicate/set whether command is a slave arm object.
SlotType	Read only: Property indicating whether a command is a slot of a certain type
StatisticCommand	Returns a Statistics object if Command is of Type STATISTICS. Otherwise it returns Nothing. Read-only.
Strategies	Read Only: Returns the Strategies collection if any otherwise it returns nothing
TempCompCommand	Returns a TempComp object if Command is of Type TEMP_COMP. Otherwise it returns Nothing. Read-only.
ToleranceCommand	Read Only: Returns the Tolereance Command
ToolkitInternalCommands	Read Only: Returns a collection of the toolkit internal commands
ToolkitParentCommand	This read-only property returns the ToolkitParent command object it it exists. If it doesn't, it returns null.
TraceFieldCommand	Returns a TraceField object if Command is of Type TRACEFIELD. Otherwise it returns Nothing. Read-only.
TracksErrors	Property used to determine whether or not the script will handle errors for the specified command.
Type	Returns the type of the Command.
TypeDescription	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	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