This class provides tool level access for OCR functionality.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision.Implementation TrackedItemBase
Cognex.Vision.Implementation ToolBase
Cognex.Vision.ViDiEL OCRTool
Namespace: Cognex.Vision.ViDiEL
Assembly: Cognex.Vision.ViDiELOCR.Net (in Cognex.Vision.ViDiELOCR.Net.dll) Version: 9.21.1.1
The OCRTool type exposes the following members.
| Name | Description | |
|---|---|---|
 | OCRTool | Constructs a new instance of this class. |
| OCRTool(OCROperator) | Constructs a new instance of this class with the specified operator |
| 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 ToolBase Equals(Object).) |
| GetContainerAsILinkManager | Get the container which contains the Tool. |
| GetHashCode | Returns the hash code of this object. (Overrides ToolBase 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. |
| 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 | Returns a human readable string that represents the object. |
| UpdateDBWithTrainingData | Update the item from the TrainingData property in the database with the TrainingAssignment values. |
| Name | Description | |
|---|---|---|
  | Equality | Compares the equality of two OCRTool objects. |
| Inequality | Compares the inequality of two OCRTool objects. |
| Name | Description | |
|---|---|---|
 | SfCurrentRecordEnable | |
| SfInputImage | |
| SfLastRunRecordDiagEnable | |
| SfLastRunRecordEnable | |
| SfOperator | |
| SfResults | |
| SfTrainImage | |
| SfTrainingAssignment | |
| SfTrainingData |
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. |
| CurrentRecordEnable | Get Enable creation of records by bitwise ORing the appropriate CurrentRecordConstants. |
| Enabled | 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 | Whether the tool's Run method is to fail if executed while one or more DataBindings (aka Links) are Invalid. |
| Handle | (Overrides ToolBase Handle.) |
| ID | Gets the ID of the tracked item. |
| InputImage | Get Gets the image to be inspected. |
| Inputs | A collection of named Input Pin values. |
| LastRunRecordDiagEnable | Get Enable creation of diagnostic subrecords by bitwise ORing the appropriate LastRunRecordDiagConstants. These are diagnostic records that may cause the Tool to have a longer execution time. |
| LastRunRecordEnable | Get Enable creation of records by bitwise ORing the appropriate LastRunRecordConstants. |
| Name | Get the name of the tracked item. |
| Operator | Get Gets the operator used to hold the TrainingDatabase, to run training, and execute OCR on images. |
| Outputs | A collection of named Output Pin values. |
| Parent | Return a reference to the containing tracking collection. May be null. |
| Results | Gets the results from the last run. |
| RunStatus | 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. |
| TrainImage | Get Gets the image for the currently selected TrainingData. |
| TrainingAssignment | Get Gets the OCR assignments for the currently selected TrainData item. |
| TrainingData | Get Gets the currently selected training data from the Database. |
| 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. |