CogImageFileTool.Run Method

CogImageFileTool Run Method

Cognex VisionPro 9.25 SR1

Runs the tool using the current parameter settings.

Namespace: Cognex.VisionPro.ImageFile
Assembly: Cognex.VisionPro.ImageFile (in Cognex.VisionPro.ImageFile.dll) Version: 93.1.0.0

Syntax

C++

Copy to Clipboard Print

public override void Run()

public override void Run()

Public Overrides Sub Run

Public Overrides Sub Run

public:
virtual void Run() override

public:
virtual void Run() override

Implements

ICogTool Run

Events

Event Type	Reason
ICogTool Running	Fires before the tool runs.
ICogChangedEvent Changed	Fires when the tool runs. If the run was successful, results are generated; if the run was not successful, no results are generated and the previous results are cleared. Use RunStatus after CogImageFileTool returns or in a Ran event handler to determine whether a run was successful or unsuccessful. The following state flags may be affected: SfOutputImage SfCurrentImageIndex SfNextImageIndex
ICogTool Ran	Fires after the tool runs.

Event Type

Reason

ICogTool Running

Fires before the tool runs.

ICogChangedEvent Changed

Fires when the tool runs. If the run was successful, results are generated; if the run was not successful, no results are generated and the previous results are cleared. Use RunStatus after CogImageFileTool returns or in a Ran event handler to determine whether a run was successful or unsuccessful.

The following state flags may be affected:

ICogTool Ran

Fires after the tool runs.

Remarks

Performs the tool's primary function. In read (playback) mode, the tool sets the OutputImage to the current image in the open image file. In write (record) mode, the tool appends the InputImage to the current open image file.