CogUserTool.RunTool Method

CogUserTool RunTool Method

Cognex VisionPro

Should only be called from tool group script. Runs a single tool. Will not run the tool if it is currently disabled.

Namespace: Cognex.VisionPro.Implementation.Internal
Assembly: Cognex.VisionPro.ToolGroup (in Cognex.VisionPro.ToolGroup.dll) Version: 65.1.0.0 (65.1.0.0)

Syntax

C++

Copy to Clipboard Print

public void RunTool(
	ICogTool subTool,
	ref string message,
	ref CogToolResultConstants result
)

public void RunTool(
	ICogTool subTool,
	ref string message,
	ref CogToolResultConstants result
)

Public Sub RunTool ( 
	subTool As ICogTool,
	ByRef message As String,
	ByRef result As CogToolResultConstants
)

Public Sub RunTool ( 
	subTool As ICogTool,
	ByRef message As String,
	ByRef result As CogToolResultConstants
)

public:
void RunTool(
	ICogTool^ subTool, 
	String^% message, 
	CogToolResultConstants% result
)

public:
void RunTool(
	ICogTool^ subTool, 
	String^% message, 
	CogToolResultConstants% result
)

Parameters

subTool: Type: Cognex.VisionPro ICogTool
The tool to run.

message: Type: System String
This is the message corresponding to the worst tool result encountered during the current run of the tool group. Here an Error result is considered worse than Reject, which is considered worse than Warning, which is considered worse than Accept. So if the result from running the supplied (sub) tool is worse than the value of the result argument, then this message argument is overwritten to reflect this tool's run.

result: Type: Cognex.VisionPro CogToolResultConstants
This is the value of the worst tool result encountered during the current run of the tool group. Here an Error result is considered worse than Reject, which is considered worse than Warning, which is considered worse than Accept. So if the result from running the supplied (sub) tool is worse than the input value of this argument, then this argument is overwritten with the new, worse result value.

Exceptions

Exception	Condition
Exception	Thrown when this (sub) tool returns an Error result and the tool group's AbortRunOnToolFailure property is True.