CogVerificationDatabase Class

Cognex VisionPro 9.8

This class contains an ICogDatabase and adds additional methods that are specific to the verification framework. This class should be used whenever interacting with a verification database.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Inspection CogVerificationDatabase

Namespace: Cognex.VisionPro.Inspection
Assembly: Cognex.VisionPro.Inspection (in Cognex.VisionPro.Inspection.dll) Version: 75.1.0.0 (75.1.0.0)

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogVerificationDatabase : CogSerializableObjectBase, 
	IEnumerable<CogVerificationData>, IEnumerable

[SerializableAttribute]
public class CogVerificationDatabase : CogSerializableObjectBase, 
	IEnumerable<CogVerificationData>, IEnumerable

<SerializableAttribute>
Public Class CogVerificationDatabase 
	Inherits CogSerializableObjectBase 
	Implements IEnumerable(Of CogVerificationData), IEnumerable

<SerializableAttribute>
Public Class CogVerificationDatabase 
	Inherits CogSerializableObjectBase 
	Implements IEnumerable(Of CogVerificationData), IEnumerable

[SerializableAttribute]
public ref class CogVerificationDatabase : public CogSerializableObjectBase, 
	IEnumerable<CogVerificationData^>, IEnumerable

[SerializableAttribute]
public ref class CogVerificationDatabase : public CogSerializableObjectBase, 
	IEnumerable<CogVerificationData^>, IEnumerable

The CogVerificationDatabase type exposes the following members.

Constructors

	Name	Description
	CogVerificationDatabase(ICogDatabase)	Constructor using the specifed ICogDatabase reference.
	CogVerificationDatabase(SerializationInfo, StreamingContext)	Serialization constructor.

Top

Methods

	Name	Description
	Add	Add a new data object to this verification database. The data records's key must be unique.
	AddAnnotationCategory	Adds the specified annotatation category to the database.
	AddGrade	Adds the specified grade to the database.
	AddImage(ICogImage, CogVerificationSimpleResultConstants)	Adds the specified image to this verification database.
	AddImage( ICogImage , CogVerificationSimpleResultConstants)	Adds the specified images to this verification database.
	AddImage(String, Boolean, CogVerificationSimpleResultConstants)	Adds the specified image to this verification database. If the image cannot be loaded, this method stops and throws an exception.
	AddImage(ICogImage, CogVerificationSimpleResultConstants, String)	Adds the specified image to this verification database.
	AddImage( ICogImage , CogVerificationSimpleResultConstants, String)	Adds the specified images to this verification database.
	AddImage(String, Boolean, CogVerificationSimpleResultConstants, String)	Adds the specified image to this verification database. If the image cannot be loaded, this method stops and throws an exception.
	AddImages(String, Boolean, CogVerificationSimpleResultConstants)	Adds all the images in the specified image directory to this verification database. If any image in the image directory cannot be loaded, this method stops and throws an exception.
	AddImages( String , Boolean, CogVerificationSimpleResultConstants)	Adds all the images in the specified array to this verification database. If any image in the specified array cannot be loaded, this method stops and throws an exception.
	AddImages(String, Boolean, CogVerificationSimpleResultConstants, String)	Adds all the images in the specified image directory to this verification database. If any image in the image directory cannot be loaded, this method stops and throws an exception.
	AddImages( String , Boolean, CogVerificationSimpleResultConstants, String)	Adds all the images in the specified array to this verification database. If any image in the specified array cannot be loaded, this method stops and throws an exception.
	Clear	Clear the underlying contained ICogDatabase.
	Connect	Connect to the underlying ICogDatabase.
	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.)
	Disconnect	Disconnect from the underlying contained ICogDatabase.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Fetch(Int32)	Create a CogVerificationData that duplicates the item specified by the supplied index. Note that a new ICogRecord is created every time this method is called.
	Fetch(String)	Create a CogVerificationData that duplicates the item specified by the supplied key. Note that a new ICogRecord is created every time this method is called.
	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.)
	GetAnnotationCategories	Gets all the annotation categories in this verification database.
	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.)
	GetEnumerator	Create a strongly typed enumerator to facilitate iterating through the items in this database. Note that enumerators are fragile - externally adding or removing items from this database will invalidate the enumerator. Also note that modifying a CogVerificationData returned by (the Current property of) this enumerator will have absolutely no affect on the database since it is a freshly created copy of the database item, just as with the Fetch method.
	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.)
	GetGrades	Gets all the grades in this verification database.
	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.)
	GetStatistics	Gets the statistics object from this database.
	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.)
	OnAdded	Raise the Added event.
	OnAddedAnnotationCategory	Raise the AddedAnnotationCategory event.
	OnAddedGrade	Raise the AddedAnnotationCategory event.
	OnAdding	Raise the Adding event.
	OnCleared	Raise the Cleared event.
	OnClearing	Raise the Clearing event.
	OnRemoved	Raise the Removed event.
	OnRemovedAnnotationCategory	Raise the RemovedAnnotationCategory event.
	OnRemovedGrade	Raise the RemovedAnnotationCategory event.
	OnRemoving	Raise the Removing event.
	OnReplaced	Raise the Replaced event.
	OnReplacing	Raise the Replacing event.
	OnStatisticsSet	Raise the StatisticsSet event.
	Remove	Removes the specified data object from the verification database.
	RemoveAnnotationCategory	Removes the specified annotation category definition from the verification database. Note, this method does not remove any defined defects using the removed category, it just removes the definition of the annotation category. Users wanting to remove any defects using the removed annotation category need to do this themselves manually.
	RemoveGrade	Removes the specified string grade from the verification database. Note, this method does not remove any set grades from individual records, it just removes the grade from the list of possible grades. Users wanting to remove the grade from any database record need to do this themselves.
	Replace	Replaces data inside the verification database using the specified data. The key of the replacementData record is used to find which data object to replace.
	SetStatistics	Sets the statistics object for this database. Internal use only.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	Database	Get the unerlying contained ICogDatabase object.

Top

Events

	Name	Description
	Added	Raised after data has been added to the verification database.
	AddedAnnotationCategory	Raised after an annotation category has been added to the verification database.
	AddedGrade	Raised after a grade has been added to the verification database.
	Adding	Raised before adding data to the verification database.
	Cleared	Raised after the verification database has been cleared.
	Clearing	Raised before clearing the verification database.
	Removed	Raised after data has been removed from the verification database.
	RemovedAnnotationCategory	Raised after an annotation category has been removed from the verification database.
	RemovedGrade	Raised after a grade has been removed from the verification database.
	Removing	Raised before removing data from the verification database.
	Replaced	Raised after data has been replaced in the verification database.
	Replacing	Raised before replacing data in the verification database.
	StatisticsSet	Raised after a statistics object has been set for the verification database.

Top