| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Cognex.VisionPro.Database</name>
- </assembly>
- <members>
- <member name="T:Cognex.VisionPro.Database.CogDatabaseAddEventArgs">
- <summary>
- Arguments of ICogDatabase's Adding and Added events.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Database.CogDatabaseAddEventArgs.Value">
- <summary>
- The record that is being, or has been added to the database.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseAddEventArgs.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Construct the event arg object with the supplied value.
- </summary>
- <param name="value">
- The record that is being, or has been added to the database.
- </param>
- </member>
- <member name="T:Cognex.VisionPro.Database.CogDatabaseAddEventHandler">
- <summary>
- A delegate for ICogDatabase's Adding and Added events.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs">
- <summary>
- Arguments of ICogDatabase's Removing and Removed events.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs.Key">
- <summary>
- The key of the record that is being, or has been removed
- from the database.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs.#ctor(System.String)">
- <summary>
- Construct the event arg object with the supplied key.
- </summary>
- <param name="key">
- The key of the record that is being, or has been removed from
- the database.
- </param>
- </member>
- <member name="T:Cognex.VisionPro.Database.CogDatabaseRemoveEventHandler">
- <summary>
- A delegate for ICogDatabase's Removing and Removed events.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs">
- <summary>
- Arguments of ICogDatabase's Replacing and Replaced events.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs.Value">
- <summary>
- The record that is replacing or has just replaced an
- existing record in the database.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Construct the event arg object with the supplied value.
- </summary>
- <param name="value">
- The record that is replacing, or has just replaced an
- existing record in the database.
- </param>
- </member>
- <member name="T:Cognex.VisionPro.Database.CogDatabaseReplaceEventHandler">
- <summary>
- A delegate for ICogDatabase's Replacing and Replaced events.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Database.ICogDatabase">
- <summary>
- Interface that describes basic interactions with an
- ICogRecord-centric database.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Connect">
- <summary>
- 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.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to connect.
- </exception>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes Connected.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Disconnect">
- <summary>
- 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.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to disconnect.
- </exception>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes Connected.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.GetCount">
- <summary>
- Get the number of items in the currently connected database.
- </summary>
- <returns>
- The number of items in the currenlty connected database.
- </returns>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to get the count of items.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.GetKeys">
- <summary>
- Generate an array of strings corresponding to the keys in the database.
- </summary>
- <returns>
- An array of strings containing the keys in the database. This
- can be an empty array if there are no items in the database.
- </returns>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to get the keys in the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Add(Cognex.VisionPro.ICogRecord)">
- <summary>
- Add the supplied record to the database with a key defined
- by the RecordKey field. This key must be unique.
- </summary>
- <param name="record">
- The record to be added to the database. The key, specified
- by the RecordKey field, must be unique.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, record, is null.
- </exception>
- <exception cref="T:Syste.ArgumentException">
- Thrown if the key is not unique.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to add record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.AddingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.AddedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the values returned
- by GetCount and GetKeys.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Remove(System.String)">
- <summary>
- Remove the specified item from the database.
- </summary>
- <param name="key">
- This key specifies the item to remove from the database.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, key, is null.
- </exception>
- <exception cref="T:Syste.ArgumentException">
- Thrown if there is no item in the database with this key.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to remove record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the values returned
- by GetCount and GetKeys.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Remove(System.Int32)">
- <summary>
- Remove the specified item from the database.
- </summary>
- <param name="index">
- This index specifies the item to remove from the database.
- Indexing is with respect to the list of keys returned by
- the GetKeys method.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown if the input argument, index, is less than zero or
- greater than or equal to the value returned by the
- GetCount method.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to remove record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the values returned
- by GetCount and GetKeys.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Fetch(System.String)">
- <summary>
- 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.
- </summary>
- <returns>
- A newly created instance of the requested database item.
- </returns>
- <param name="key">
- This key specifies the item to fetch from the database.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, key, is null.
- </exception>
- <exception cref="T:Syste.ArgumentException">
- Thrown if there is no item in the database with this key.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to fetch the record.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Fetch(System.Int32)">
- <summary>
- 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.
- </summary>
- <returns>
- A newly created instance of the requested database item.
- </returns>
- <param name="index">
- This index specifies the item to fetch from the database.
- Indexing is with respect to the list of keys returned by
- the GetKeys method.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown if the input argument, index, is less than zero or
- greater than or equal to the value returned by the
- GetCount method.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to fetch the record.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Replace(Cognex.VisionPro.ICogRecord)">
- <summary>
- Find the database item whose key matches the RecordKey of the
- supplied ICogRecord. Replace that database item with
- (the contents of) the supplied ICogRecord.
- </summary>
- <param name="record">
- The replacement ICogRecord.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, record, is null.
- </exception>
- <exception cref="T:Syste.ArgumentException">
- Thrown if the specified key is not found.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to add record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.ReplacingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.ReplacedEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.ICogDatabase.Clear">
- <summary>
- Remove any and all database items. Does not affect the Metadata
- property.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to remove a record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.ClearingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.ClearedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the value returned
- by GetCount.
- </event>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Clearing">
- <summary>
- Event that is raised at the start of a call to Clear.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Cleared">
- <summary>
- Event that is raised at the end of a call to Clear.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Adding">
- <summary>
- Event that is raised at the start of a call to Add.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Added">
- <summary>
- Event that is raised at the end of a call to Add.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Removing">
- <summary>
- Event that is raised at the start of a call to Remove.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Removed">
- <summary>
- Event that is raised at the end of a call to Remove.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Replacing">
- <summary>
- Event that is raised at the start of a call to Replace.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.ICogDatabase.Replaced">
- <summary>
- Event that is raised at the end of a call to Replace.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Database.ICogDatabase.Name">
- <summary>
- 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.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if you attempt to set Name while Connected is true.
- </exception>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.Database.ICogDatabase.Metadata">
- <summary>
- Gets or sets the metadata associated with this database.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.Database.ICogDatabase.Connected">
- <summary>
- Is this object connected to a specific database?
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- </member>
- <member name="T:Cognex.VisionPro.Database.CogDatabaseDirectory">
- <summary>
- This class provides a file and directory-based implementation
- of the ICogDatabase interface.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfName">
- <summary>
- This bit will be set in the EventArgs of a Changed event every
- time the value returned by Name may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfConnected">
- <summary>
- This bit will be set in the EventArgs of a Changed event every
- time the value returned by Connected may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfGetCount">
- <summary>
- This bit will be set in the EventArgs of a Changed event every
- time the value returned by GetCount may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfGetKeys">
- <summary>
- This bit will be set in the EventArgs of a Changed event every
- time the value returned by GetKeys may have changed.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor">
- <summary>
- Construct a new instance of the CogDatabaseDirectory class.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor(System.String)">
- <summary>
- Construct a new instance of the CogDatabaseDirectory class.
- Set the Name property to the supplied value, and then
- attempt to connect to that database.
- </summary>
- <param name="name">
- The desired database name. This must be the path of
- the intended database directory, e.g. "C:\\MyDatabase".
- </param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to connect.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor(Cognex.VisionPro.Database.CogDatabaseDirectory)">
- <summary>
- 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.
- </summary>
- <param name="other">
- The CogDatabaseDirectory whose Name property is to be copied.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization constructor for CogDatabaseDirectory. Note that,
- as with the copy constructor, the resultant CogDatabaseDirectory
- object is not initially connected.
- </summary>
- <param name="info">
- Standard SerializationInfo argument.
- </param>
- <param name="context">
- Standard StreamingContext argument.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Connect">
- <summary>
- 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.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to connect.
- </exception>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes Connected.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Disconnect">
- <summary>
- 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.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to disconnect.
- </exception>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes Connected.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetCount">
- <summary>
- Get the number of items in the currently connected database.
- </summary>
- <returns>
- The number of items in the currenlty connected database.
- </returns>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to get the count of items.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetKeys">
- <summary>
- Generate an array of strings corresponding to the keys in the database.
- </summary>
- <returns>
- An array of strings containing the keys in the database. This
- can be an empty array if there are no items in the database.
- </returns>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to get the keys in the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetKeysNoSort">
- <summary>
- Generate an array of strings corresponding to the keys in the database.
- </summary>
- <returns>
- An array of strings containing the keys in the database. This
- can be an empty array if there are no items in the database.
- </returns>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to get the keys in the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnAdding(Cognex.VisionPro.Database.CogDatabaseAddEventArgs)">
- <summary>
- Raise the Adding event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnAdded(Cognex.VisionPro.Database.CogDatabaseAddEventArgs)">
- <summary>
- Raise the Added event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnReplacing(Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs)">
- <summary>
- Raise the Replacing event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnReplaced(Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs)">
- <summary>
- Raise the Replaced event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnRemoving(Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs)">
- <summary>
- Raise the Removing event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnRemoved(Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs)">
- <summary>
- Raise the Removed event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnClearing(System.EventArgs)">
- <summary>
- Raise the Clearing event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnCleared(System.EventArgs)">
- <summary>
- Raise the Cleared event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Add(Cognex.VisionPro.ICogRecord)">
- <summary>
- Add the supplied record to the database with a key defined
- by the RecordKey field. This key must be unique.
- </summary>
- <param name="record">
- The record to be added to the database. The key, specified
- by the RecordKey field, must be unique.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, record, is null.
- </exception>
- <exception cref="T:System.ArgumentException">
- Thrown if the key is not unique.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to add record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.AddingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.AddedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the values returned
- by GetCount and GetKeys.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Remove(System.String)">
- <summary>
- Remove the specified item from the database.
- </summary>
- <param name="key">
- This key specifies the item to remove from the database.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, key, is null.
- </exception>
- <exception cref="T:Syste.ArgumentException">
- Thrown if there is no item in the database with this key.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to remove record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the values returned
- by GetCount and GetKeys.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Remove(System.Int32)">
- <summary>
- Remove the specified item from the database.
- </summary>
- <param name="index">
- This index specifies the item to remove from the database.
- Indexing is with respect to the list of keys returned by
- the GetKeys method.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown if the input argument, index, is less than zero or
- greater than or equal to the value returned by the
- GetCount method.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to remove record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the values returned
- by GetCount and GetKeys.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Fetch(System.String)">
- <summary>
- 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.
- </summary>
- <returns>
- A newly created instance of the requested database item.
- </returns>
- <param name="key">
- This key specifies the item to fetch from the database.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, key, is null.
- </exception>
- <exception cref="T:Syste.ArgumentException">
- Thrown if there is no item in the database with this key.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to fetch the record.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Fetch(System.Int32)">
- <summary>
- 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.
- </summary>
- <returns>
- A newly created instance of the requested database item.
- </returns>
- <param name="index">
- This index specifies the item to fetch from the database.
- Indexing is with respect to the list of keys returned by
- the GetKeys method.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown if the input argument, index, is less than zero or
- greater than or equal to the value returned by the
- GetCount method.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to fetch the record.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Replace(Cognex.VisionPro.ICogRecord)">
- <summary>
- Find the database item whose key matches the RecordKey of the
- supplied ICogRecord. Replace that database item with
- (the contents of) the supplied ICogRecord.
- </summary>
- <param name="record">
- The replacement ICogRecord.
- </param>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the input argument, record, is null.
- </exception>
- <exception cref="T:Syste.ArgumentException">
- Thrown if the specified key is not found.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to add record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.ReplacingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.ReplacedEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Clear">
- <summary>
- Remove any and all database items. Does not affect the Metadata
- property.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to remove a record.
- </exception>
- <event cref="E:Cognex.VisionPro.Database.ClearingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Database.ClearedEvent">
- Fires at the end of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this method changes the value returned
- by GetCount.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetEnumerator">
- <summary>
- 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.
- </summary>
- <returns>
- An enumerator whose Current property is of type ICogRecord.
- </returns>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- 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.
- </summary>
- <returns>
- An enumerator whose Current property is of type Object.
- </returns>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Dispose">
- <summary>
- Dispose of this CogDatabaseDirectory object.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Dispose(System.Boolean)">
- <summary>
- Dispose of this object.
- </summary>
- <param name="disposing">
- 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.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Finalize">
- <summary>
- Finalize this CogDatabaseDirectory object.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Clearing">
- <summary>
- Raised before a database is cleared.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Cleared">
- <summary>
- Raised after a database is cleared.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Adding">
- <summary>
- Raised before an item is added to a database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Added">
- <summary>
- Raised after an item is added to a database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Removing">
- <summary>
- Raised before an item is removed from a database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Removed">
- <summary>
- Raised after an item is removed from a database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Replacing">
- <summary>
- Raised before an item in a database is replaced.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Replaced">
- <summary>
- Raised after an item in a database has been replaced.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Database.CogDatabaseDirectory.Name">
- <summary>
- 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.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if you attempt to set Name while Connected is true.
- </exception>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.Database.CogDatabaseDirectory.Connected">
- <summary>
- Is this object connected to a specific database?
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.Database.CogDatabaseDirectory.Metadata">
- <summary>
- Gets or sets the metadata associated with this database.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- Thrown if this object has already been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Thrown if unable to get or set metadata.
- </exception>
- </member>
- </members>
- </doc>
|