This class is an implementation of the ICogVerifier interface. This class
takes as input an input database, an output database, and a CogToolBlock under test. After given
these inputs, this verifier goes through the input database, setting up inputs to
the CogToolBlock, runs the CogToolBlock, and then compares the expected values in the input
database to the actaul values generated by the CogToolBlock. The results of this comparison is
finally stored in the output database.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.Inspection CogVerifierBasic
Namespace: Cognex.VisionPro.Inspection
Assembly: Cognex.VisionPro.Inspection (in Cognex.VisionPro.Inspection.dll) Version: 87.1.0.0 (87.1.0.0)
Syntax
The CogVerifierBasic type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogVerifierBasic |
Default constructor. You will need to provide the vision tool (CogToolBlock), input database, and output database
via the properties on this class if you use this constructor.
|
 | CogVerifierBasic(SerializationInfo, StreamingContext) |
Serialization Constructor.
|
| CogVerifierBasic(ICogTool, CogVerificationDatabase, CogVerificationDatabase) |
Constructor which takes all necessary inputs to the verifier.
|
Methods
| Name | Description | |
|---|---|---|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from 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.) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetObjectData |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| OnRunCompleted |
Raise the RunCompleted event.
|
| OnRunPaused |
Raise the RunPaused event.
|
| OnRunProgress |
Raise the RunProgress event.
|
| OnRunResumed |
Raise the RunResumed event.
|
| OnRunStarted |
Raise the RunStarted event.
|
| 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 CogSerializableChangedEventBase.) |
| Run |
Runs the verifier synchronously. This method will block until the entire input database is iterated over.
This method should not be called from a GUI callback handler (such as a button click handler)
since it can take a very long time to run. Please use the RunAsync() method instead (and subscribe
to the various verifier events).
|
| RunAsync |
Runs the verifier asynchronously. As the verifier runs, various events are fired which
the user should be subscribed to.
|
| RunAsyncCancel |
Cancels an asynchronous run of the verifier.
|
| RunAsyncPause |
Pauses an asynchronous run of the verifier.
|
| RunAsyncResume |
Resumes a currently paused verifier.
|
| SetupVisionToolInputs |
Sets up the various inputs on the CogToolBlock from the specified data object.
|
| 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 CogSerializableChangedEventBase.) |
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfInputDatabase |
State flag for the InputDatabase property.
|
| SfInputDatabaseSubset |
State flag for the InputDatabaseSubset property.
|
 | SfNextSf | |
| SfOutputDatabase |
State flag for the OutputDatabase property.
|
| SfOutputDatabaseEnable |
State flag for the OutputDatabaseEnable property.
|
| SfUnknownResultBehavior |
State flag for the UnknownResultBehavior property.
|
| SfVisionTool |
State flag for the VisionTool property.
|
Properties
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended |
If nonzero, indicates that the raising of the Changed event has been
suspended. This value is incremented when SuspendChangedEvent is called
and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| InputDatabase |
Get and set the input database.
|
| InputDatabaseSubset |
Get and set the subset of keys that the verifier should run against. The specified
keys must exist in the input database, otherwise the verifier will thrown an exception
during runtime.
|
| IsBusy |
Get the current state of the verifier. Returns true if the verifier is busy, otherwise returns false.
No properties can be changed when the verifier is busy.
|
| OutputDatabase |
Get and set the output database where the results of verification will be stored.
|
| OutputDatabaseEnable |
Get and set the various flags that control what gets stored into the output database when the
verifier runs.
|
| 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 CogSerializableChangedEventBase.) |
| Statistics |
Get the statistics object associated with this verifier object.
|
| UnknownResultBehavior |
Get and set the behavior of the verifier (either match or mismatch) when an Unknown SimpleResult is encountered.
|
| VisionTool |
Get and set the CogToolBlock under test. Note, the type of this property is ICogTool, but
the input must be of type CogToolBlock.
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| RunCompleted |
Raised when the verifier has completely finished running.
|
| RunPaused |
Raised when the verifier is paused.
|
| RunProgressChanged |
Raised when the verifier completes one iteration.
|
| RunResumed |
Raised when the verifier is resumed.
|
| RunStarted |
Raised when the verifier starts running.
|
See Also