ICogTool Interface

Cognex VisionPro 9.10

This interface is implemented by all VisionPro tools.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 79.0.0.0 (79.0.0.0)

Syntax

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface ICogTool : ICogChangedEvent, 
	IComponent, IDisposable

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface ICogTool : ICogChangedEvent, 
	IComponent, IDisposable

<TypeConverterAttribute(GetType(CogComponentConverter))> 
Public Interface ICogTool 
	Inherits ICogChangedEvent, IComponent, IDisposable

<TypeConverterAttribute(GetType(CogComponentConverter))> 
Public Interface ICogTool 
	Inherits ICogChangedEvent, IComponent, IDisposable

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface class ICogTool : ICogChangedEvent, 
	IComponent, IDisposable

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface class ICogTool : ICogChangedEvent, 
	IComponent, IDisposable

The ICogTool type exposes the following members.

Methods

	Name	Description
	CreateCurrentRecord	Creates a new set of records that represents the tool's current state.
	CreateLastRunRecord	Creates a new set of records that represents the tool's last-run state.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called, and raises the Changed event 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 ICogChangedEvent.)
	Run	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 packaged in the tool's RunStatus.Exception. Should this occur, the tool's RunStatus.Result will be set to Error and its RunStatus.Message will reference the message that accompanied the exception. It is the user's responsibility to examine the tool's RunStatus after calling Run.
	SuspendChangedEvent	Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. (Inherited from ICogChangedEvent.)

Properties

	Name	Description
	ChangedEventSuspended	Indicates if the raising of the Changed event has been suspended. (Inherited from ICogChangedEvent.)
	DataBindings	Gets the data bindings for the tool.
	Name	Gets or sets the name of the tool.
	RunStatus	Gets general information about the last call to the tool's Run function. 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.
	Site	Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
	StateFlags	Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... } (Inherited from ICogChangedEvent.)
	UserData	Gets a CogDictionary object that can be used to store application-specific information.

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from ICogChangedEvent.)
	Disposed	Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
	Ran	Event that is raised at the end of the tool's Run method.
	Running	Event that is raised at the start of the tool's Run method.