A base class that implements the ITool interface.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision.Implementation TrackedItemBase
Cognex.Vision.Implementation ToolBase
Cognex.Vision.Implementation.Internal.TestHelpers TestHelperTool
Cognex.Vision.LineMax.Implementation LineMaxToolBase
Cognex.Vision.SmartLine SmartLineTool
Cognex.Vision.ViDiEL ClassifyTool
Cognex.Vision.ViDiEL OCRTool
Cognex.Vision.ViDiEL SegmentTool
Namespace: Cognex.Vision.Implementation
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.22.2.0
The ToolBase type exposes the following members.
| Name | Description | |
|---|---|---|
 | ToolBase |
| Name | Description | |
|---|---|---|
 | CheckRunConditionsSelf | Performs RunCondition check by the tool itself. |
| CopyBase | Create a copy of this tool. |
| 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. |
| Equals | Compares the equality of this object with another. (Overrides TrackedItemBase Equals(Object).) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetContainerAsILinkManager | Get the container which contains the Tool. |
| GetHashCode | Returns the hash code of this object. (Overrides TrackedItemBase GetHashCode .) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. |
| IsCheckRunConditionsDelegateToOwner | Check if tool checks its RunCondition by its owner. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ResumeAndRaiseChangedEvent | 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. |
| 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 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. |
| SuspendChangedEvent | 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. |
| ToString | (Inherited from Object.) |
| Name | Description | |
|---|---|---|
  | Equality | Compares the equality of two ToolBase objects. |
| Inequality | Compares the inequality of two ToolBase objects. |
| Name | Description | |
|---|---|---|
 | SfCreateCurrentRecord | |
| SfCreateLastRunRecord | |
| SfEnabled | |
| SfFailOnInvalidDataBinding | |
| SfRunStatus |
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. |
| Enabled | 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. |
| FailOnInvalidDataBinding | Get Whether the tool's Run method is to fail if executed while one or more DataBindings (aka Links) are Invalid. |
| Handle | (Overrides TrackedItemBase Handle.) |
| ID | Gets the ID of the tracked item. |
| Inputs | A collection of named Input Pin values. |
| Name | Get (Inherited from TrackedItemBase.)Get the name of the tracked item. |
| Outputs | A collection of named Output Pin values. |
| Parent | Get (Inherited from TrackedItemBase.)Return a reference to the containing tracking collection. May be null. |
| RunStatus |
| Name | Description | |
|---|---|---|
 | Changed | The actual event. |
| NameChanging | This event is raised when the Name is about to change. Note that this is a cancellable event. |
| 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. |