Cognex.VisionPro.Database.xml 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Cognex.VisionPro.Database</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Cognex.VisionPro.Database.CogDatabaseAddEventArgs">
  8. <summary>
  9. Arguments of ICogDatabase's Adding and Added events.
  10. </summary>
  11. </member>
  12. <member name="F:Cognex.VisionPro.Database.CogDatabaseAddEventArgs.Value">
  13. <summary>
  14. The record that is being, or has been added to the database.
  15. </summary>
  16. </member>
  17. <member name="M:Cognex.VisionPro.Database.CogDatabaseAddEventArgs.#ctor(Cognex.VisionPro.ICogRecord)">
  18. <summary>
  19. Construct the event arg object with the supplied value.
  20. </summary>
  21. <param name="value">
  22. The record that is being, or has been added to the database.
  23. </param>
  24. </member>
  25. <member name="T:Cognex.VisionPro.Database.CogDatabaseAddEventHandler">
  26. <summary>
  27. A delegate for ICogDatabase's Adding and Added events.
  28. </summary>
  29. </member>
  30. <member name="T:Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs">
  31. <summary>
  32. Arguments of ICogDatabase's Removing and Removed events.
  33. </summary>
  34. </member>
  35. <member name="F:Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs.Key">
  36. <summary>
  37. The key of the record that is being, or has been removed
  38. from the database.
  39. </summary>
  40. </member>
  41. <member name="M:Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs.#ctor(System.String)">
  42. <summary>
  43. Construct the event arg object with the supplied key.
  44. </summary>
  45. <param name="key">
  46. The key of the record that is being, or has been removed from
  47. the database.
  48. </param>
  49. </member>
  50. <member name="T:Cognex.VisionPro.Database.CogDatabaseRemoveEventHandler">
  51. <summary>
  52. A delegate for ICogDatabase's Removing and Removed events.
  53. </summary>
  54. </member>
  55. <member name="T:Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs">
  56. <summary>
  57. Arguments of ICogDatabase's Replacing and Replaced events.
  58. </summary>
  59. </member>
  60. <member name="F:Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs.Value">
  61. <summary>
  62. The record that is replacing or has just replaced an
  63. existing record in the database.
  64. </summary>
  65. </member>
  66. <member name="M:Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs.#ctor(Cognex.VisionPro.ICogRecord)">
  67. <summary>
  68. Construct the event arg object with the supplied value.
  69. </summary>
  70. <param name="value">
  71. The record that is replacing, or has just replaced an
  72. existing record in the database.
  73. </param>
  74. </member>
  75. <member name="T:Cognex.VisionPro.Database.CogDatabaseReplaceEventHandler">
  76. <summary>
  77. A delegate for ICogDatabase's Replacing and Replaced events.
  78. </summary>
  79. </member>
  80. <member name="T:Cognex.VisionPro.Database.ICogDatabase">
  81. <summary>
  82. Interface that describes basic interactions with an
  83. ICogRecord-centric database.
  84. </summary>
  85. </member>
  86. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Connect">
  87. <summary>
  88. Connect to the database specified by the Name property.
  89. Successfully connecting grants exclusive read and write
  90. access to the database. This method is idempotent - you
  91. may safely call it repeatedly.
  92. </summary>
  93. <exception cref="T:System.ObjectDisposedException">
  94. Thrown if this object has already been disposed.
  95. </exception>
  96. <exception cref="T:System.InvalidOperationException">
  97. Thrown if unable to connect.
  98. </exception>
  99. <event cref="E:Cognex.VisionPro.ChangedEvent">
  100. Fires when this method changes Connected.
  101. </event>
  102. </member>
  103. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Disconnect">
  104. <summary>
  105. Disconnect from the database specified by the Name property.
  106. Successfully disconnecting releases exclusive read and write
  107. access to the database. This method is idempotent - you
  108. may safely call it repeatedly.
  109. </summary>
  110. <exception cref="T:System.ObjectDisposedException">
  111. Thrown if this object has already been disposed.
  112. </exception>
  113. <exception cref="T:System.InvalidOperationException">
  114. Thrown if unable to disconnect.
  115. </exception>
  116. <event cref="E:Cognex.VisionPro.ChangedEvent">
  117. Fires when this method changes Connected.
  118. </event>
  119. </member>
  120. <member name="M:Cognex.VisionPro.Database.ICogDatabase.GetCount">
  121. <summary>
  122. Get the number of items in the currently connected database.
  123. </summary>
  124. <returns>
  125. The number of items in the currenlty connected database.
  126. </returns>
  127. <exception cref="T:System.ObjectDisposedException">
  128. Thrown if this object has already been disposed.
  129. </exception>
  130. <exception cref="T:System.InvalidOperationException">
  131. Thrown if not currently connected.
  132. </exception>
  133. <exception cref="T:System.InvalidOperationException">
  134. Thrown if unable to get the count of items.
  135. </exception>
  136. </member>
  137. <member name="M:Cognex.VisionPro.Database.ICogDatabase.GetKeys">
  138. <summary>
  139. Generate an array of strings corresponding to the keys in the database.
  140. </summary>
  141. <returns>
  142. An array of strings containing the keys in the database. This
  143. can be an empty array if there are no items in the database.
  144. </returns>
  145. <exception cref="T:System.ObjectDisposedException">
  146. Thrown if this object has already been disposed.
  147. </exception>
  148. <exception cref="T:System.InvalidOperationException">
  149. Thrown if not currently connected.
  150. </exception>
  151. <exception cref="T:System.InvalidOperationException">
  152. Thrown if unable to get the keys in the database.
  153. </exception>
  154. </member>
  155. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Add(Cognex.VisionPro.ICogRecord)">
  156. <summary>
  157. Add the supplied record to the database with a key defined
  158. by the RecordKey field. This key must be unique.
  159. </summary>
  160. <param name="record">
  161. The record to be added to the database. The key, specified
  162. by the RecordKey field, must be unique.
  163. </param>
  164. <exception cref="T:System.ObjectDisposedException">
  165. Thrown if this object has already been disposed.
  166. </exception>
  167. <exception cref="T:System.InvalidOperationException">
  168. Thrown if not currently connected.
  169. </exception>
  170. <exception cref="T:System.ArgumentNullException">
  171. Thrown if the input argument, record, is null.
  172. </exception>
  173. <exception cref="T:Syste.ArgumentException">
  174. Thrown if the key is not unique.
  175. </exception>
  176. <exception cref="T:System.InvalidOperationException">
  177. Thrown if unable to add record.
  178. </exception>
  179. <event cref="E:Cognex.VisionPro.Database.AddingEvent">
  180. Fires at the start of a call to this method.
  181. </event>
  182. <event cref="E:Cognex.VisionPro.Database.AddedEvent">
  183. Fires at the end of a call to this method.
  184. </event>
  185. <event cref="E:Cognex.VisionPro.ChangedEvent">
  186. Fires when this method changes the values returned
  187. by GetCount and GetKeys.
  188. </event>
  189. </member>
  190. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Remove(System.String)">
  191. <summary>
  192. Remove the specified item from the database.
  193. </summary>
  194. <param name="key">
  195. This key specifies the item to remove from the database.
  196. </param>
  197. <exception cref="T:System.ObjectDisposedException">
  198. Thrown if this object has already been disposed.
  199. </exception>
  200. <exception cref="T:System.InvalidOperationException">
  201. Thrown if not currently connected.
  202. </exception>
  203. <exception cref="T:System.ArgumentNullException">
  204. Thrown if the input argument, key, is null.
  205. </exception>
  206. <exception cref="T:Syste.ArgumentException">
  207. Thrown if there is no item in the database with this key.
  208. </exception>
  209. <exception cref="T:System.InvalidOperationException">
  210. Thrown if unable to remove record.
  211. </exception>
  212. <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
  213. Fires at the start of a call to this method.
  214. </event>
  215. <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
  216. Fires at the end of a call to this method.
  217. </event>
  218. <event cref="E:Cognex.VisionPro.ChangedEvent">
  219. Fires when this method changes the values returned
  220. by GetCount and GetKeys.
  221. </event>
  222. </member>
  223. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Remove(System.Int32)">
  224. <summary>
  225. Remove the specified item from the database.
  226. </summary>
  227. <param name="index">
  228. This index specifies the item to remove from the database.
  229. Indexing is with respect to the list of keys returned by
  230. the GetKeys method.
  231. </param>
  232. <exception cref="T:System.ObjectDisposedException">
  233. Thrown if this object has already been disposed.
  234. </exception>
  235. <exception cref="T:System.InvalidOperationException">
  236. Thrown if not currently connected.
  237. </exception>
  238. <exception cref="T:System.ArgumentOutOfRangeException">
  239. Thrown if the input argument, index, is less than zero or
  240. greater than or equal to the value returned by the
  241. GetCount method.
  242. </exception>
  243. <exception cref="T:System.InvalidOperationException">
  244. Thrown if unable to remove record.
  245. </exception>
  246. <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
  247. Fires at the start of a call to this method.
  248. </event>
  249. <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
  250. Fires at the end of a call to this method.
  251. </event>
  252. <event cref="E:Cognex.VisionPro.ChangedEvent">
  253. Fires when this method changes the values returned
  254. by GetCount and GetKeys.
  255. </event>
  256. </member>
  257. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Fetch(System.String)">
  258. <summary>
  259. Create an ICogRecord that duplicates the item specified
  260. by the supplied key. Note that a new ICogRecord is
  261. created every time this method is called.
  262. </summary>
  263. <returns>
  264. A newly created instance of the requested database item.
  265. </returns>
  266. <param name="key">
  267. This key specifies the item to fetch from the database.
  268. </param>
  269. <exception cref="T:System.ObjectDisposedException">
  270. Thrown if this object has already been disposed.
  271. </exception>
  272. <exception cref="T:System.InvalidOperationException">
  273. Thrown if not currently connected.
  274. </exception>
  275. <exception cref="T:System.ArgumentNullException">
  276. Thrown if the input argument, key, is null.
  277. </exception>
  278. <exception cref="T:Syste.ArgumentException">
  279. Thrown if there is no item in the database with this key.
  280. </exception>
  281. <exception cref="T:System.InvalidOperationException">
  282. Thrown if unable to fetch the record.
  283. </exception>
  284. </member>
  285. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Fetch(System.Int32)">
  286. <summary>
  287. Create an ICogRecord that duplicates the item specified
  288. by the supplied index. Note that a new ICogRecord is
  289. created every time this method is called.
  290. </summary>
  291. <returns>
  292. A newly created instance of the requested database item.
  293. </returns>
  294. <param name="index">
  295. This index specifies the item to fetch from the database.
  296. Indexing is with respect to the list of keys returned by
  297. the GetKeys method.
  298. </param>
  299. <exception cref="T:System.ObjectDisposedException">
  300. Thrown if this object has already been disposed.
  301. </exception>
  302. <exception cref="T:System.InvalidOperationException">
  303. Thrown if not currently connected.
  304. </exception>
  305. <exception cref="T:System.ArgumentOutOfRangeException">
  306. Thrown if the input argument, index, is less than zero or
  307. greater than or equal to the value returned by the
  308. GetCount method.
  309. </exception>
  310. <exception cref="T:System.InvalidOperationException">
  311. Thrown if unable to fetch the record.
  312. </exception>
  313. </member>
  314. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Replace(Cognex.VisionPro.ICogRecord)">
  315. <summary>
  316. Find the database item whose key matches the RecordKey of the
  317. supplied ICogRecord. Replace that database item with
  318. (the contents of) the supplied ICogRecord.
  319. </summary>
  320. <param name="record">
  321. The replacement ICogRecord.
  322. </param>
  323. <exception cref="T:System.ObjectDisposedException">
  324. Thrown if this object has already been disposed.
  325. </exception>
  326. <exception cref="T:System.InvalidOperationException">
  327. Thrown if not currently connected.
  328. </exception>
  329. <exception cref="T:System.ArgumentNullException">
  330. Thrown if the input argument, record, is null.
  331. </exception>
  332. <exception cref="T:Syste.ArgumentException">
  333. Thrown if the specified key is not found.
  334. </exception>
  335. <exception cref="T:System.InvalidOperationException">
  336. Thrown if unable to add record.
  337. </exception>
  338. <event cref="E:Cognex.VisionPro.Database.ReplacingEvent">
  339. Fires at the start of a call to this method.
  340. </event>
  341. <event cref="E:Cognex.VisionPro.Database.ReplacedEvent">
  342. Fires at the end of a call to this method.
  343. </event>
  344. </member>
  345. <member name="M:Cognex.VisionPro.Database.ICogDatabase.Clear">
  346. <summary>
  347. Remove any and all database items. Does not affect the Metadata
  348. property.
  349. </summary>
  350. <exception cref="T:System.ObjectDisposedException">
  351. Thrown if this object has already been disposed.
  352. </exception>
  353. <exception cref="T:System.InvalidOperationException">
  354. Thrown if not currently connected.
  355. </exception>
  356. <exception cref="T:System.InvalidOperationException">
  357. Thrown if unable to remove a record.
  358. </exception>
  359. <event cref="E:Cognex.VisionPro.Database.ClearingEvent">
  360. Fires at the start of a call to this method.
  361. </event>
  362. <event cref="E:Cognex.VisionPro.Database.ClearedEvent">
  363. Fires at the end of a call to this method.
  364. </event>
  365. <event cref="E:Cognex.VisionPro.ChangedEvent">
  366. Fires when this method changes the value returned
  367. by GetCount.
  368. </event>
  369. </member>
  370. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Clearing">
  371. <summary>
  372. Event that is raised at the start of a call to Clear.
  373. </summary>
  374. </member>
  375. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Cleared">
  376. <summary>
  377. Event that is raised at the end of a call to Clear.
  378. </summary>
  379. </member>
  380. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Adding">
  381. <summary>
  382. Event that is raised at the start of a call to Add.
  383. </summary>
  384. </member>
  385. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Added">
  386. <summary>
  387. Event that is raised at the end of a call to Add.
  388. </summary>
  389. </member>
  390. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Removing">
  391. <summary>
  392. Event that is raised at the start of a call to Remove.
  393. </summary>
  394. </member>
  395. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Removed">
  396. <summary>
  397. Event that is raised at the end of a call to Remove.
  398. </summary>
  399. </member>
  400. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Replacing">
  401. <summary>
  402. Event that is raised at the start of a call to Replace.
  403. </summary>
  404. </member>
  405. <member name="E:Cognex.VisionPro.Database.ICogDatabase.Replaced">
  406. <summary>
  407. Event that is raised at the end of a call to Replace.
  408. </summary>
  409. </member>
  410. <member name="P:Cognex.VisionPro.Database.ICogDatabase.Name">
  411. <summary>
  412. Gets or sets the name of this database. This must be set to
  413. the desired value before calling Connect. Attempting to
  414. set this when Connected is true will cause an exception to
  415. be thrown.
  416. </summary>
  417. <exception cref="T:System.ObjectDisposedException">
  418. Thrown if this object has already been disposed.
  419. </exception>
  420. <exception cref="T:System.InvalidOperationException">
  421. Thrown if you attempt to set Name while Connected is true.
  422. </exception>
  423. <event cref="E:Cognex.VisionPro.ChangedEvent">
  424. Fires when this property changes.
  425. </event>
  426. </member>
  427. <member name="P:Cognex.VisionPro.Database.ICogDatabase.Metadata">
  428. <summary>
  429. Gets or sets the metadata associated with this database.
  430. </summary>
  431. <exception cref="T:System.ObjectDisposedException">
  432. Thrown if this object has already been disposed.
  433. </exception>
  434. <exception cref="T:System.InvalidOperationException">
  435. Thrown if not currently connected.
  436. </exception>
  437. </member>
  438. <member name="P:Cognex.VisionPro.Database.ICogDatabase.Connected">
  439. <summary>
  440. Is this object connected to a specific database?
  441. </summary>
  442. <exception cref="T:System.ObjectDisposedException">
  443. Thrown if this object has already been disposed.
  444. </exception>
  445. </member>
  446. <member name="T:Cognex.VisionPro.Database.CogDatabaseDirectory">
  447. <summary>
  448. This class provides a file and directory-based implementation
  449. of the ICogDatabase interface.
  450. </summary>
  451. </member>
  452. <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfName">
  453. <summary>
  454. This bit will be set in the EventArgs of a Changed event every
  455. time the value returned by Name may have changed.
  456. </summary>
  457. </member>
  458. <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfConnected">
  459. <summary>
  460. This bit will be set in the EventArgs of a Changed event every
  461. time the value returned by Connected may have changed.
  462. </summary>
  463. </member>
  464. <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfGetCount">
  465. <summary>
  466. This bit will be set in the EventArgs of a Changed event every
  467. time the value returned by GetCount may have changed.
  468. </summary>
  469. </member>
  470. <member name="F:Cognex.VisionPro.Database.CogDatabaseDirectory.SfGetKeys">
  471. <summary>
  472. This bit will be set in the EventArgs of a Changed event every
  473. time the value returned by GetKeys may have changed.
  474. </summary>
  475. </member>
  476. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor">
  477. <summary>
  478. Construct a new instance of the CogDatabaseDirectory class.
  479. </summary>
  480. </member>
  481. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor(System.String)">
  482. <summary>
  483. Construct a new instance of the CogDatabaseDirectory class.
  484. Set the Name property to the supplied value, and then
  485. attempt to connect to that database.
  486. </summary>
  487. <param name="name">
  488. The desired database name. This must be the path of
  489. the intended database directory, e.g. "C:\\MyDatabase".
  490. </param>
  491. <exception cref="T:System.InvalidOperationException">
  492. Thrown if unable to connect.
  493. </exception>
  494. </member>
  495. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor(Cognex.VisionPro.Database.CogDatabaseDirectory)">
  496. <summary>
  497. Construct a new instance of the CogDatabaseDirectory class
  498. with the Name field set to match that of the supplied argument.
  499. Note that the resulting CogDatabaseDirectory object is
  500. not initially connected, regardless of the state of the
  501. argument.
  502. </summary>
  503. <param name="other">
  504. The CogDatabaseDirectory whose Name property is to be copied.
  505. </param>
  506. </member>
  507. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  508. <summary>
  509. Serialization constructor for CogDatabaseDirectory. Note that,
  510. as with the copy constructor, the resultant CogDatabaseDirectory
  511. object is not initially connected.
  512. </summary>
  513. <param name="info">
  514. Standard SerializationInfo argument.
  515. </param>
  516. <param name="context">
  517. Standard StreamingContext argument.
  518. </param>
  519. </member>
  520. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Connect">
  521. <summary>
  522. Connect to the database specified by the Name property.
  523. Successfully connecting grants exclusive read and write
  524. access to the database. This method is idempotent - you
  525. may safely call it repeatedly.
  526. </summary>
  527. <exception cref="T:System.ObjectDisposedException">
  528. Thrown if this object has already been disposed.
  529. </exception>
  530. <exception cref="T:System.InvalidOperationException">
  531. Thrown if unable to connect.
  532. </exception>
  533. <event cref="E:Cognex.VisionPro.ChangedEvent">
  534. Fires when this method changes Connected.
  535. </event>
  536. </member>
  537. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Disconnect">
  538. <summary>
  539. Disconnect from the database specified by the Name property.
  540. Successfully disconnecting releases exclusive read and write
  541. access to the database. This method is idempotent - you
  542. may safely call it repeatedly.
  543. </summary>
  544. <exception cref="T:System.ObjectDisposedException">
  545. Thrown if this object has already been disposed.
  546. </exception>
  547. <exception cref="T:System.InvalidOperationException">
  548. Thrown if unable to disconnect.
  549. </exception>
  550. <event cref="E:Cognex.VisionPro.ChangedEvent">
  551. Fires when this method changes Connected.
  552. </event>
  553. </member>
  554. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetCount">
  555. <summary>
  556. Get the number of items in the currently connected database.
  557. </summary>
  558. <returns>
  559. The number of items in the currenlty connected database.
  560. </returns>
  561. <exception cref="T:System.ObjectDisposedException">
  562. Thrown if this object has already been disposed.
  563. </exception>
  564. <exception cref="T:System.InvalidOperationException">
  565. Thrown if not currently connected.
  566. </exception>
  567. <exception cref="T:System.InvalidOperationException">
  568. Thrown if unable to get the count of items.
  569. </exception>
  570. </member>
  571. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetKeys">
  572. <summary>
  573. Generate an array of strings corresponding to the keys in the database.
  574. </summary>
  575. <returns>
  576. An array of strings containing the keys in the database. This
  577. can be an empty array if there are no items in the database.
  578. </returns>
  579. <exception cref="T:System.ObjectDisposedException">
  580. Thrown if this object has already been disposed.
  581. </exception>
  582. <exception cref="T:System.InvalidOperationException">
  583. Thrown if not currently connected.
  584. </exception>
  585. <exception cref="T:System.InvalidOperationException">
  586. Thrown if unable to get the keys in the database.
  587. </exception>
  588. </member>
  589. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetKeysNoSort">
  590. <summary>
  591. Generate an array of strings corresponding to the keys in the database.
  592. </summary>
  593. <returns>
  594. An array of strings containing the keys in the database. This
  595. can be an empty array if there are no items in the database.
  596. </returns>
  597. <exception cref="T:System.ObjectDisposedException">
  598. Thrown if this object has already been disposed.
  599. </exception>
  600. <exception cref="T:System.InvalidOperationException">
  601. Thrown if not currently connected.
  602. </exception>
  603. <exception cref="T:System.InvalidOperationException">
  604. Thrown if unable to get the keys in the database.
  605. </exception>
  606. </member>
  607. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnAdding(Cognex.VisionPro.Database.CogDatabaseAddEventArgs)">
  608. <summary>
  609. Raise the Adding event.
  610. </summary>
  611. </member>
  612. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnAdded(Cognex.VisionPro.Database.CogDatabaseAddEventArgs)">
  613. <summary>
  614. Raise the Added event.
  615. </summary>
  616. </member>
  617. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnReplacing(Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs)">
  618. <summary>
  619. Raise the Replacing event.
  620. </summary>
  621. </member>
  622. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnReplaced(Cognex.VisionPro.Database.CogDatabaseReplaceEventArgs)">
  623. <summary>
  624. Raise the Replaced event.
  625. </summary>
  626. </member>
  627. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnRemoving(Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs)">
  628. <summary>
  629. Raise the Removing event.
  630. </summary>
  631. </member>
  632. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnRemoved(Cognex.VisionPro.Database.CogDatabaseRemoveEventArgs)">
  633. <summary>
  634. Raise the Removed event.
  635. </summary>
  636. </member>
  637. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnClearing(System.EventArgs)">
  638. <summary>
  639. Raise the Clearing event.
  640. </summary>
  641. </member>
  642. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.OnCleared(System.EventArgs)">
  643. <summary>
  644. Raise the Cleared event.
  645. </summary>
  646. </member>
  647. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Add(Cognex.VisionPro.ICogRecord)">
  648. <summary>
  649. Add the supplied record to the database with a key defined
  650. by the RecordKey field. This key must be unique.
  651. </summary>
  652. <param name="record">
  653. The record to be added to the database. The key, specified
  654. by the RecordKey field, must be unique.
  655. </param>
  656. <exception cref="T:System.ObjectDisposedException">
  657. Thrown if this object has already been disposed.
  658. </exception>
  659. <exception cref="T:System.InvalidOperationException">
  660. Thrown if not currently connected.
  661. </exception>
  662. <exception cref="T:System.ArgumentNullException">
  663. Thrown if the input argument, record, is null.
  664. </exception>
  665. <exception cref="T:System.ArgumentException">
  666. Thrown if the key is not unique.
  667. </exception>
  668. <exception cref="T:System.InvalidOperationException">
  669. Thrown if unable to add record.
  670. </exception>
  671. <event cref="E:Cognex.VisionPro.Database.AddingEvent">
  672. Fires at the start of a call to this method.
  673. </event>
  674. <event cref="E:Cognex.VisionPro.Database.AddedEvent">
  675. Fires at the end of a call to this method.
  676. </event>
  677. <event cref="E:Cognex.VisionPro.ChangedEvent">
  678. Fires when this method changes the values returned
  679. by GetCount and GetKeys.
  680. </event>
  681. </member>
  682. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Remove(System.String)">
  683. <summary>
  684. Remove the specified item from the database.
  685. </summary>
  686. <param name="key">
  687. This key specifies the item to remove from the database.
  688. </param>
  689. <exception cref="T:System.ObjectDisposedException">
  690. Thrown if this object has already been disposed.
  691. </exception>
  692. <exception cref="T:System.InvalidOperationException">
  693. Thrown if not currently connected.
  694. </exception>
  695. <exception cref="T:System.ArgumentNullException">
  696. Thrown if the input argument, key, is null.
  697. </exception>
  698. <exception cref="T:Syste.ArgumentException">
  699. Thrown if there is no item in the database with this key.
  700. </exception>
  701. <exception cref="T:System.InvalidOperationException">
  702. Thrown if unable to remove record.
  703. </exception>
  704. <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
  705. Fires at the start of a call to this method.
  706. </event>
  707. <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
  708. Fires at the end of a call to this method.
  709. </event>
  710. <event cref="E:Cognex.VisionPro.ChangedEvent">
  711. Fires when this method changes the values returned
  712. by GetCount and GetKeys.
  713. </event>
  714. </member>
  715. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Remove(System.Int32)">
  716. <summary>
  717. Remove the specified item from the database.
  718. </summary>
  719. <param name="index">
  720. This index specifies the item to remove from the database.
  721. Indexing is with respect to the list of keys returned by
  722. the GetKeys method.
  723. </param>
  724. <exception cref="T:System.ObjectDisposedException">
  725. Thrown if this object has already been disposed.
  726. </exception>
  727. <exception cref="T:System.InvalidOperationException">
  728. Thrown if not currently connected.
  729. </exception>
  730. <exception cref="T:System.ArgumentOutOfRangeException">
  731. Thrown if the input argument, index, is less than zero or
  732. greater than or equal to the value returned by the
  733. GetCount method.
  734. </exception>
  735. <exception cref="T:System.InvalidOperationException">
  736. Thrown if unable to remove record.
  737. </exception>
  738. <event cref="E:Cognex.VisionPro.Database.RemovingEvent">
  739. Fires at the start of a call to this method.
  740. </event>
  741. <event cref="E:Cognex.VisionPro.Database.RemovedEvent">
  742. Fires at the end of a call to this method.
  743. </event>
  744. <event cref="E:Cognex.VisionPro.ChangedEvent">
  745. Fires when this method changes the values returned
  746. by GetCount and GetKeys.
  747. </event>
  748. </member>
  749. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Fetch(System.String)">
  750. <summary>
  751. Create an ICogRecord that duplicates the item specified
  752. by the supplied key. Note that a new ICogRecord is
  753. created every time this method is called.
  754. </summary>
  755. <returns>
  756. A newly created instance of the requested database item.
  757. </returns>
  758. <param name="key">
  759. This key specifies the item to fetch from the database.
  760. </param>
  761. <exception cref="T:System.ObjectDisposedException">
  762. Thrown if this object has already been disposed.
  763. </exception>
  764. <exception cref="T:System.InvalidOperationException">
  765. Thrown if not currently connected.
  766. </exception>
  767. <exception cref="T:System.ArgumentNullException">
  768. Thrown if the input argument, key, is null.
  769. </exception>
  770. <exception cref="T:Syste.ArgumentException">
  771. Thrown if there is no item in the database with this key.
  772. </exception>
  773. <exception cref="T:System.InvalidOperationException">
  774. Thrown if unable to fetch the record.
  775. </exception>
  776. </member>
  777. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Fetch(System.Int32)">
  778. <summary>
  779. Create an ICogRecord that duplicates the item specified
  780. by the supplied index. Note that a new ICogRecord is
  781. created every time this method is called.
  782. </summary>
  783. <returns>
  784. A newly created instance of the requested database item.
  785. </returns>
  786. <param name="index">
  787. This index specifies the item to fetch from the database.
  788. Indexing is with respect to the list of keys returned by
  789. the GetKeys method.
  790. </param>
  791. <exception cref="T:System.ObjectDisposedException">
  792. Thrown if this object has already been disposed.
  793. </exception>
  794. <exception cref="T:System.InvalidOperationException">
  795. Thrown if not currently connected.
  796. </exception>
  797. <exception cref="T:System.ArgumentOutOfRangeException">
  798. Thrown if the input argument, index, is less than zero or
  799. greater than or equal to the value returned by the
  800. GetCount method.
  801. </exception>
  802. <exception cref="T:System.InvalidOperationException">
  803. Thrown if unable to fetch the record.
  804. </exception>
  805. </member>
  806. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Replace(Cognex.VisionPro.ICogRecord)">
  807. <summary>
  808. Find the database item whose key matches the RecordKey of the
  809. supplied ICogRecord. Replace that database item with
  810. (the contents of) the supplied ICogRecord.
  811. </summary>
  812. <param name="record">
  813. The replacement ICogRecord.
  814. </param>
  815. <exception cref="T:System.ObjectDisposedException">
  816. Thrown if this object has already been disposed.
  817. </exception>
  818. <exception cref="T:System.InvalidOperationException">
  819. Thrown if not currently connected.
  820. </exception>
  821. <exception cref="T:System.ArgumentNullException">
  822. Thrown if the input argument, record, is null.
  823. </exception>
  824. <exception cref="T:Syste.ArgumentException">
  825. Thrown if the specified key is not found.
  826. </exception>
  827. <exception cref="T:System.InvalidOperationException">
  828. Thrown if unable to add record.
  829. </exception>
  830. <event cref="E:Cognex.VisionPro.Database.ReplacingEvent">
  831. Fires at the start of a call to this method.
  832. </event>
  833. <event cref="E:Cognex.VisionPro.Database.ReplacedEvent">
  834. Fires at the end of a call to this method.
  835. </event>
  836. </member>
  837. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Clear">
  838. <summary>
  839. Remove any and all database items. Does not affect the Metadata
  840. property.
  841. </summary>
  842. <exception cref="T:System.ObjectDisposedException">
  843. Thrown if this object has already been disposed.
  844. </exception>
  845. <exception cref="T:System.InvalidOperationException">
  846. Thrown if not currently connected.
  847. </exception>
  848. <exception cref="T:System.InvalidOperationException">
  849. Thrown if unable to remove a record.
  850. </exception>
  851. <event cref="E:Cognex.VisionPro.Database.ClearingEvent">
  852. Fires at the start of a call to this method.
  853. </event>
  854. <event cref="E:Cognex.VisionPro.Database.ClearedEvent">
  855. Fires at the end of a call to this method.
  856. </event>
  857. <event cref="E:Cognex.VisionPro.ChangedEvent">
  858. Fires when this method changes the value returned
  859. by GetCount.
  860. </event>
  861. </member>
  862. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.GetEnumerator">
  863. <summary>
  864. Create a strongly typed enumerator to facilitate
  865. iterating through the items in this database. Note that
  866. enumerators are fragile - externally adding or removing items
  867. from this database will invalidate the enumerator. Also note
  868. that modifying an ICogRecord returned by (the Current property of)
  869. this enumerator will have absolutely no affect on the database
  870. since it is a freshly created copy of the database item, just
  871. as with the Fetch method.
  872. </summary>
  873. <returns>
  874. An enumerator whose Current property is of type ICogRecord.
  875. </returns>
  876. <exception cref="T:System.ObjectDisposedException">
  877. Thrown if this object has already been disposed.
  878. </exception>
  879. <exception cref="T:System.InvalidOperationException">
  880. Thrown if not currently connected.
  881. </exception>
  882. </member>
  883. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.System#Collections#IEnumerable#GetEnumerator">
  884. <summary>
  885. Create an enumerator to facilitate iterating through
  886. the items in this database. Note that enumerators
  887. are fragile - externally adding or removing items
  888. from this database will invalidate the enumerator. Also note
  889. that modifying an ICogRecord returned by (the Current property of)
  890. this enumerator will have absolutely no affect on the database
  891. since it is a freshly created copy of the database item, just
  892. as with the Fetch method.
  893. </summary>
  894. <returns>
  895. An enumerator whose Current property is of type Object.
  896. </returns>
  897. <exception cref="T:System.ObjectDisposedException">
  898. Thrown if this object has already been disposed.
  899. </exception>
  900. <exception cref="T:System.InvalidOperationException">
  901. Thrown if not currently connected.
  902. </exception>
  903. </member>
  904. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Dispose">
  905. <summary>
  906. Dispose of this CogDatabaseDirectory object.
  907. </summary>
  908. </member>
  909. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Dispose(System.Boolean)">
  910. <summary>
  911. Dispose of this object.
  912. </summary>
  913. <param name="disposing">
  914. If calling this method from the public Dispose method,
  915. set this argument to true. If calling this method from
  916. the finalizer, set this to false.
  917. </param>
  918. </member>
  919. <member name="M:Cognex.VisionPro.Database.CogDatabaseDirectory.Finalize">
  920. <summary>
  921. Finalize this CogDatabaseDirectory object.
  922. </summary>
  923. </member>
  924. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Clearing">
  925. <summary>
  926. Raised before a database is cleared.
  927. </summary>
  928. </member>
  929. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Cleared">
  930. <summary>
  931. Raised after a database is cleared.
  932. </summary>
  933. </member>
  934. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Adding">
  935. <summary>
  936. Raised before an item is added to a database.
  937. </summary>
  938. </member>
  939. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Added">
  940. <summary>
  941. Raised after an item is added to a database.
  942. </summary>
  943. </member>
  944. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Removing">
  945. <summary>
  946. Raised before an item is removed from a database.
  947. </summary>
  948. </member>
  949. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Removed">
  950. <summary>
  951. Raised after an item is removed from a database.
  952. </summary>
  953. </member>
  954. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Replacing">
  955. <summary>
  956. Raised before an item in a database is replaced.
  957. </summary>
  958. </member>
  959. <member name="E:Cognex.VisionPro.Database.CogDatabaseDirectory.Replaced">
  960. <summary>
  961. Raised after an item in a database has been replaced.
  962. </summary>
  963. </member>
  964. <member name="P:Cognex.VisionPro.Database.CogDatabaseDirectory.Name">
  965. <summary>
  966. Gets or sets the name of this database. This will be
  967. the path of the desired database directory,
  968. e.g. "C:\\MyDatabase". This must be set to
  969. the desired value before calling Connect. Attempting to
  970. set this when Connected is true will cause an exception to
  971. be thrown.
  972. </summary>
  973. <exception cref="T:System.ObjectDisposedException">
  974. Thrown if this object has already been disposed.
  975. </exception>
  976. <exception cref="T:System.InvalidOperationException">
  977. Thrown if you attempt to set Name while Connected is true.
  978. </exception>
  979. <event cref="E:Cognex.VisionPro.ChangedEvent">
  980. Fires when this property changes.
  981. </event>
  982. </member>
  983. <member name="P:Cognex.VisionPro.Database.CogDatabaseDirectory.Connected">
  984. <summary>
  985. Is this object connected to a specific database?
  986. </summary>
  987. <exception cref="T:System.ObjectDisposedException">
  988. Thrown if this object has already been disposed.
  989. </exception>
  990. </member>
  991. <member name="P:Cognex.VisionPro.Database.CogDatabaseDirectory.Metadata">
  992. <summary>
  993. Gets or sets the metadata associated with this database.
  994. </summary>
  995. <exception cref="T:System.ObjectDisposedException">
  996. Thrown if this object has already been disposed.
  997. </exception>
  998. <exception cref="T:System.InvalidOperationException">
  999. Thrown if unable to get or set metadata.
  1000. </exception>
  1001. </member>
  1002. </members>
  1003. </doc>