ITool InterfaceCognex VisionPro 9.22 SR1

This interface is implemented by all Vision tools.

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.22.2.0
Syntax

public interface ITool : ITrackingCollectionTrackedItem, IChangedEvent, 
	IObject

The ITool type exposes the following members.

Methods

  NameDescription
Public methodCheckRunConditionsSelf

Performs RunCondition check by the tool itself.

Public methodCopyBase

Create a copy of this tool.

Public methodCreateCurrentRecord

Creates a new set of records that represents the tool's current state.

Public methodCreateLastRunRecord

Creates a new set of records that represents the tool's last-run state.

Public methodIsCheckRunConditionsDelegateToOwner

Check if tool checks its RunCondition by its owner.

Public methodResumeAndRaiseChangedEvent

Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent.

(Inherited from IChangedEvent.)
Public methodRun

Runs the tool. This method is guaranteed to not throw an exception. Any exception generated in the course of running the tool will be caught and a string representation of that exception will be packaged in the Message property of the tool's RunStatus. Should this occur, the Result property of the tool's RunStatus will be set to Error. It is the user's responsibility to examine the tool's RunStatus after calling Run.

Public methodSuspendChangedEvent

Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.

(Inherited from IChangedEvent.)
Top
Properties

  NameDescription
Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Inherited from IChangedEvent.)
Public propertyEnabled
Get

Whether the tool is enabled to run. If false, calling the tool's Run function will not actually run the tool and will cause no change in the tool's state.

Public propertyID

Gets the ID of the tracked item.

(Inherited from ITrackingCollectionTrackedItem.)
Public propertyInputs

A collection of named Input Pin values.

Public propertyName
Get

Get the name of the tracked item.

(Inherited from ITrackingCollectionTrackedItem.)
Public propertyOutputs

A collection of named Output Pin values.

Public propertyParent
Get

Return a reference to the containing tracking collection. May be null.

(Inherited from ITrackingCollectionTrackedItem.)
Public propertyRunStatus

Gets general information about the last call to the tool's Run method. Note that serious errors that occur within the tool's Run method may only be detected by examining the RunStatus after calling Run. It is the user's responsibility to examine the tool's RunStatus after calling Run.

Top
Events

  NameDescription
Public eventChanged

The actual event.

(Inherited from IChangedEvent.)
Public eventNameChanging

This event is raised when the Name is about to change. Note that this is a cancellable event.

(Inherited from ITrackingCollectionTrackedItem.)
Public eventRan

Event that is raised at the end of the tool's Run method.

Public eventRunning

Event that is raised at the start of the tool's Run method.

Top
See Also