Cognex.VisionPro.Database
Arguments of ICogDatabase's Adding and Added events.
The record that is being, or has been added to the database.
Construct the event arg object with the supplied value.
The record that is being, or has been added to the database.
A delegate for ICogDatabase's Adding and Added events.
Arguments of ICogDatabase's Removing and Removed events.
The key of the record that is being, or has been removed
from the database.
Construct the event arg object with the supplied key.
The key of the record that is being, or has been removed from
the database.
A delegate for ICogDatabase's Removing and Removed events.
Arguments of ICogDatabase's Replacing and Replaced events.
The record that is replacing or has just replaced an
existing record in the database.
Construct the event arg object with the supplied value.
The record that is replacing, or has just replaced an
existing record in the database.
A delegate for ICogDatabase's Replacing and Replaced events.
Interface that describes basic interactions with an
ICogRecord-centric database.
Connect to the database specified by the Name property.
Successfully connecting grants exclusive read and write
access to the database. This method is idempotent - you
may safely call it repeatedly.
Thrown if this object has already been disposed.
Thrown if unable to connect.
Fires when this method changes Connected.
Disconnect from the database specified by the Name property.
Successfully disconnecting releases exclusive read and write
access to the database. This method is idempotent - you
may safely call it repeatedly.
Thrown if this object has already been disposed.
Thrown if unable to disconnect.
Fires when this method changes Connected.
Get the number of items in the currently connected database.
The number of items in the currenlty connected database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if unable to get the count of items.
Generate an array of strings corresponding to the keys in the database.
An array of strings containing the keys in the database. This
can be an empty array if there are no items in the database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if unable to get the keys in the database.
Add the supplied record to the database with a key defined
by the RecordKey field. This key must be unique.
The record to be added to the database. The key, specified
by the RecordKey field, must be unique.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, record, is null.
Thrown if the key is not unique.
Thrown if unable to add record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the values returned
by GetCount and GetKeys.
Remove the specified item from the database.
This key specifies the item to remove from the database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, key, is null.
Thrown if there is no item in the database with this key.
Thrown if unable to remove record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the values returned
by GetCount and GetKeys.
Remove the specified item from the database.
This index specifies the item to remove from the database.
Indexing is with respect to the list of keys returned by
the GetKeys method.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, index, is less than zero or
greater than or equal to the value returned by the
GetCount method.
Thrown if unable to remove record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the values returned
by GetCount and GetKeys.
Create an ICogRecord that duplicates the item specified
by the supplied key. Note that a new ICogRecord is
created every time this method is called.
A newly created instance of the requested database item.
This key specifies the item to fetch from the database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, key, is null.
Thrown if there is no item in the database with this key.
Thrown if unable to fetch the record.
Create an ICogRecord that duplicates the item specified
by the supplied index. Note that a new ICogRecord is
created every time this method is called.
A newly created instance of the requested database item.
This index specifies the item to fetch from the database.
Indexing is with respect to the list of keys returned by
the GetKeys method.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, index, is less than zero or
greater than or equal to the value returned by the
GetCount method.
Thrown if unable to fetch the record.
Find the database item whose key matches the RecordKey of the
supplied ICogRecord. Replace that database item with
(the contents of) the supplied ICogRecord.
The replacement ICogRecord.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, record, is null.
Thrown if the specified key is not found.
Thrown if unable to add record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Remove any and all database items. Does not affect the Metadata
property.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if unable to remove a record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the value returned
by GetCount.
Event that is raised at the start of a call to Clear.
Event that is raised at the end of a call to Clear.
Event that is raised at the start of a call to Add.
Event that is raised at the end of a call to Add.
Event that is raised at the start of a call to Remove.
Event that is raised at the end of a call to Remove.
Event that is raised at the start of a call to Replace.
Event that is raised at the end of a call to Replace.
Gets or sets the name of this database. This must be set to
the desired value before calling Connect. Attempting to
set this when Connected is true will cause an exception to
be thrown.
Thrown if this object has already been disposed.
Thrown if you attempt to set Name while Connected is true.
Fires when this property changes.
Gets or sets the metadata associated with this database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Is this object connected to a specific database?
Thrown if this object has already been disposed.
This class provides a file and directory-based implementation
of the ICogDatabase interface.
This bit will be set in the EventArgs of a Changed event every
time the value returned by Name may have changed.
This bit will be set in the EventArgs of a Changed event every
time the value returned by Connected may have changed.
This bit will be set in the EventArgs of a Changed event every
time the value returned by GetCount may have changed.
This bit will be set in the EventArgs of a Changed event every
time the value returned by GetKeys may have changed.
Construct a new instance of the CogDatabaseDirectory class.
Construct a new instance of the CogDatabaseDirectory class.
Set the Name property to the supplied value, and then
attempt to connect to that database.
The desired database name. This must be the path of
the intended database directory, e.g. "C:\\MyDatabase".
Thrown if unable to connect.
Construct a new instance of the CogDatabaseDirectory class
with the Name field set to match that of the supplied argument.
Note that the resulting CogDatabaseDirectory object is
not initially connected, regardless of the state of the
argument.
The CogDatabaseDirectory whose Name property is to be copied.
Serialization constructor for CogDatabaseDirectory. Note that,
as with the copy constructor, the resultant CogDatabaseDirectory
object is not initially connected.
Standard SerializationInfo argument.
Standard StreamingContext argument.
Connect to the database specified by the Name property.
Successfully connecting grants exclusive read and write
access to the database. This method is idempotent - you
may safely call it repeatedly.
Thrown if this object has already been disposed.
Thrown if unable to connect.
Fires when this method changes Connected.
Disconnect from the database specified by the Name property.
Successfully disconnecting releases exclusive read and write
access to the database. This method is idempotent - you
may safely call it repeatedly.
Thrown if this object has already been disposed.
Thrown if unable to disconnect.
Fires when this method changes Connected.
Get the number of items in the currently connected database.
The number of items in the currenlty connected database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if unable to get the count of items.
Generate an array of strings corresponding to the keys in the database.
An array of strings containing the keys in the database. This
can be an empty array if there are no items in the database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if unable to get the keys in the database.
Generate an array of strings corresponding to the keys in the database.
An array of strings containing the keys in the database. This
can be an empty array if there are no items in the database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if unable to get the keys in the database.
Raise the Adding event.
Raise the Added event.
Raise the Replacing event.
Raise the Replaced event.
Raise the Removing event.
Raise the Removed event.
Raise the Clearing event.
Raise the Cleared event.
Add the supplied record to the database with a key defined
by the RecordKey field. This key must be unique.
The record to be added to the database. The key, specified
by the RecordKey field, must be unique.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, record, is null.
Thrown if the key is not unique.
Thrown if unable to add record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the values returned
by GetCount and GetKeys.
Remove the specified item from the database.
This key specifies the item to remove from the database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, key, is null.
Thrown if there is no item in the database with this key.
Thrown if unable to remove record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the values returned
by GetCount and GetKeys.
Remove the specified item from the database.
This index specifies the item to remove from the database.
Indexing is with respect to the list of keys returned by
the GetKeys method.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, index, is less than zero or
greater than or equal to the value returned by the
GetCount method.
Thrown if unable to remove record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the values returned
by GetCount and GetKeys.
Create an ICogRecord that duplicates the item specified
by the supplied key. Note that a new ICogRecord is
created every time this method is called.
A newly created instance of the requested database item.
This key specifies the item to fetch from the database.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, key, is null.
Thrown if there is no item in the database with this key.
Thrown if unable to fetch the record.
Create an ICogRecord that duplicates the item specified
by the supplied index. Note that a new ICogRecord is
created every time this method is called.
A newly created instance of the requested database item.
This index specifies the item to fetch from the database.
Indexing is with respect to the list of keys returned by
the GetKeys method.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, index, is less than zero or
greater than or equal to the value returned by the
GetCount method.
Thrown if unable to fetch the record.
Find the database item whose key matches the RecordKey of the
supplied ICogRecord. Replace that database item with
(the contents of) the supplied ICogRecord.
The replacement ICogRecord.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if the input argument, record, is null.
Thrown if the specified key is not found.
Thrown if unable to add record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Remove any and all database items. Does not affect the Metadata
property.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Thrown if unable to remove a record.
Fires at the start of a call to this method.
Fires at the end of a call to this method.
Fires when this method changes the value returned
by GetCount.
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 an ICogRecord 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.
An enumerator whose Current property is of type ICogRecord.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Create an 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 an ICogRecord 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.
An enumerator whose Current property is of type Object.
Thrown if this object has already been disposed.
Thrown if not currently connected.
Dispose of this CogDatabaseDirectory object.
Dispose of this object.
If calling this method from the public Dispose method,
set this argument to true. If calling this method from
the finalizer, set this to false.
Finalize this CogDatabaseDirectory object.
Raised before a database is cleared.
Raised after a database is cleared.
Raised before an item is added to a database.
Raised after an item is added to a database.
Raised before an item is removed from a database.
Raised after an item is removed from a database.
Raised before an item in a database is replaced.
Raised after an item in a database has been replaced.
Gets or sets the name of this database. This will be
the path of the desired database directory,
e.g. "C:\\MyDatabase". This must be set to
the desired value before calling Connect. Attempting to
set this when Connected is true will cause an exception to
be thrown.
Thrown if this object has already been disposed.
Thrown if you attempt to set Name while Connected is true.
Fires when this property changes.
Is this object connected to a specific database?
Thrown if this object has already been disposed.
Gets or sets the metadata associated with this database.
Thrown if this object has already been disposed.
Thrown if unable to get or set metadata.