Cognex.VisionPro.Inspection.xml 126 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Cognex.VisionPro.Inspection</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory">
  8. <summary>
  9. This class represents an annotation category.
  10. An annotation category consists of two pieces of information: a name and color.
  11. Annotation categories are defined and used in the Image Grading Utility.
  12. </summary>
  13. </member>
  14. <member name="F:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.SfName">
  15. <summary>
  16. State flag for the Name property.
  17. </summary>
  18. </member>
  19. <member name="F:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.SfColor">
  20. <summary>
  21. State flag for Color the property.
  22. </summary>
  23. </member>
  24. <member name="F:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.SfNextSf">
  25. <summary>
  26. Next state flag to be used in derived classes.
  27. </summary>
  28. </member>
  29. <member name="M:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.#ctor(System.String,Cognex.VisionPro.CogColorConstants)">
  30. <summary>
  31. Constructor for annotation category.
  32. </summary>
  33. <param name="name">Name of the annotation category, must be unique.</param>
  34. <param name="color">The annotation category's color that is used for drawing the graphics</param>
  35. </member>
  36. <member name="P:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.Name">
  37. <summary>
  38. Get and set the name of this annotation category.
  39. </summary>
  40. </member>
  41. <member name="P:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.Color">
  42. <summary>
  43. Set and set the color of this annotation category.
  44. </summary>
  45. </member>
  46. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Range">
  47. <summary>
  48. string key of ExpectedOutput's epsilon value
  49. </summary>
  50. </member>
  51. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.RecordVersion_1_0">
  52. <summary>
  53. CogRecord structure version identifier 1.0
  54. </summary>
  55. </member>
  56. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Grade">
  57. <summary>
  58. RecordKey for CogRecord's AdvancedGrade field name
  59. </summary>
  60. </member>
  61. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ExpectedResult">
  62. <summary>
  63. RecordKey for "ExpectedResult" field
  64. </summary>
  65. </member>
  66. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ActualResult">
  67. <summary>
  68. RecordKey for "ActualResult" field
  69. </summary>
  70. </member>
  71. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ExpectedOutputs">
  72. <summary>
  73. RecordKey for "ExpectedOutputs" field
  74. </summary>
  75. </member>
  76. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ExpectedRunStatus">
  77. <summary>
  78. RecordKey for "ExpectedRunStatus" field
  79. </summary>
  80. </member>
  81. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Inputs">
  82. <summary>
  83. RecordKey for "Inputs" field
  84. </summary>
  85. </member>
  86. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Params">
  87. <summary>
  88. RecordKey for "Params" field
  89. </summary>
  90. </member>
  91. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Results">
  92. <summary>
  93. RecordKey for "Results" field
  94. </summary>
  95. </member>
  96. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.OverallVerificationResult">
  97. <summary>
  98. RecordKey for "OverallVerificationResult" field
  99. </summary>
  100. </member>
  101. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerificationTimestamp">
  102. <summary>
  103. RecordKey for "VerificationTimestamp" field
  104. </summary>
  105. </member>
  106. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerifiedOutputs">
  107. <summary>
  108. RecordKey for "VerifiedOutputs" field
  109. </summary>
  110. </member>
  111. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerifiedRunStatus">
  112. <summary>
  113. RecordKey for "VerifiedRunStatus" field
  114. </summary>
  115. </member>
  116. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.LastRunRecord">
  117. <summary>
  118. RecordKey for "LastRunRecord" field
  119. </summary>
  120. </member>
  121. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.SimpleResult">
  122. <summary>
  123. RecordKey for "SimpleResult" field
  124. </summary>
  125. </member>
  126. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerificationResult">
  127. <summary>
  128. RecordKey for "VerificationResult" field
  129. </summary>
  130. </member>
  131. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ResultType">
  132. <summary>
  133. RecordKey for "ResultType" field
  134. </summary>
  135. </member>
  136. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.InputImage">
  137. <summary>
  138. RecordKey for "InputImage" field
  139. </summary>
  140. </member>
  141. <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.NullValueDisplayValue">
  142. <summary>
  143. String representation of the value NULL;
  144. </summary>
  145. </member>
  146. <member name="T:Cognex.VisionPro.Inspection.ICogVerifier">
  147. <summary>
  148. Interface for verifier in the verification framework.
  149. </summary>
  150. </member>
  151. <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.Run">
  152. <summary>
  153. Run the verifier synchronously.
  154. </summary>
  155. </member>
  156. <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsync">
  157. <summary>
  158. Run the verifier asynchronously.
  159. </summary>
  160. </member>
  161. <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsyncCancel">
  162. <summary>
  163. Cancel an asynchronous run of the verifier.
  164. </summary>
  165. </member>
  166. <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsyncPause">
  167. <summary>
  168. Pause an asynchronous run of the verifier.
  169. </summary>
  170. </member>
  171. <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsyncResume">
  172. <summary>
  173. Resume an asynchronous run of the verifier.
  174. </summary>
  175. </member>
  176. <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.SetupVisionToolInputs(Cognex.VisionPro.Inspection.CogVerificationData,Cognex.VisionPro.Inspection.CogVerificationData)">
  177. <summary>
  178. Setup the VisionTool's inputs using the specified verificationData object.
  179. </summary>
  180. <param name="verificationData"></param>
  181. <param name="outputData"></param>
  182. </member>
  183. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.InputDatabase">
  184. <summary>
  185. Get and set the input database.
  186. </summary>
  187. </member>
  188. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.InputDatabaseSubset">
  189. <summary>
  190. Get and set the input subset array.
  191. </summary>
  192. </member>
  193. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.OutputDatabase">
  194. <summary>
  195. Get and set the output database.
  196. </summary>
  197. </member>
  198. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.VisionTool">
  199. <summary>
  200. Get and set the vision tool under test.
  201. </summary>
  202. </member>
  203. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.UnknownResultBehavior">
  204. <summary>
  205. Get and set the behavior of the verifier when it encounters an Unknown SimpleResult.
  206. </summary>
  207. </member>
  208. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.IsBusy">
  209. <summary>
  210. Get the current state of the verifier.
  211. </summary>
  212. </member>
  213. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.Statistics">
  214. <summary>
  215. Get the statistics object associated with the verifier.
  216. </summary>
  217. </member>
  218. <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.OutputDatabaseEnable">
  219. <summary>
  220. Get and set the flags which control what gets stored into the output database.
  221. </summary>
  222. </member>
  223. <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunStarted">
  224. <summary>
  225. Raised when the verifier starts running.
  226. </summary>
  227. </member>
  228. <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunProgressChanged">
  229. <summary>
  230. Raised when the verifier completes one iteration.
  231. </summary>
  232. </member>
  233. <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunCompleted">
  234. <summary>
  235. Raised when the verifier has completely finished running.
  236. </summary>
  237. </member>
  238. <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunPaused">
  239. <summary>
  240. Raised when the verifier is paused.
  241. </summary>
  242. </member>
  243. <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunResumed">
  244. <summary>
  245. Raised when the verifier is resumed.
  246. </summary>
  247. </member>
  248. <member name="T:Cognex.VisionPro.Inspection.CogVerificationDatabase">
  249. <summary>
  250. This class contains an ICogDatabase and adds additional methods that
  251. are specific to the verification framework. This class should be
  252. used whenever interacting with a verification database.
  253. </summary>
  254. </member>
  255. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.#ctor(Cognex.VisionPro.Database.ICogDatabase)">
  256. <summary>
  257. Constructor using the specifed ICogDatabase reference.
  258. </summary>
  259. <param name="database">The underlying database object to contain within the newly constructed CogVerificationDatabase.</param>
  260. <exception cref="T:System.ArgumentNullException">
  261. Thrown if the specified database is null.
  262. </exception>
  263. </member>
  264. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  265. <summary>
  266. Serialization constructor.
  267. </summary>
  268. <param name="info">Standard SerializationInfo argument.</param>
  269. <param name="context">Standard StreamingContext argument.</param>
  270. </member>
  271. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Add(Cognex.VisionPro.Inspection.CogVerificationData)">
  272. <summary>
  273. Add a new data object to this verification database.
  274. The data records's key must be unique.
  275. </summary>
  276. <param name="newData">The new data object to add.</param>
  277. <exception cref="T:System.InvalidOperationException">
  278. Thrown if not currently connected.
  279. </exception>
  280. <event cref="E:Cognex.VisionPro.Inspection.AddingEvent">
  281. Fires at the start of a call to this method.
  282. </event>
  283. <event cref="E:Cognex.VisionPro.Inspection.AddedEvent">
  284. Fires at the end of a call to this method.
  285. </event>
  286. </member>
  287. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Remove(System.String)">
  288. <summary>
  289. Removes the specified data object from the verification database.
  290. </summary>
  291. <param name="key">The key of the data object to remove.</param>
  292. <exception cref="T:System.InvalidOperationException">
  293. Thrown if not currently connected.
  294. </exception>
  295. <event cref="E:Cognex.VisionPro.Inspection.RemovingEvent">
  296. Fires at the start of a call to this method.
  297. </event>
  298. <event cref="E:Cognex.VisionPro.Inspection.RemovedEvent">
  299. Fires at the end of a call to this method.
  300. </event>
  301. </member>
  302. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Replace(Cognex.VisionPro.Inspection.CogVerificationData)">
  303. <summary>
  304. Replaces data inside the verification database using the specified data.
  305. The key of the replacementData record is used to find which data object to replace.
  306. </summary>
  307. <param name="replacementData">The replacement CogVerificationData.</param>
  308. <exception cref="T:System.InvalidOperationException">
  309. Thrown if not currently connected.
  310. </exception>
  311. <event cref="E:Cognex.VisionPro.Inspection.ReplacingEvent">
  312. Fires at the start of a call to this method.
  313. </event>
  314. <event cref="E:Cognex.VisionPro.Inspection.ReplacedEvent">
  315. Fires at the end of a call to this method.
  316. </event>
  317. </member>
  318. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Fetch(System.String)">
  319. <summary>
  320. Create a CogVerificationData that duplicates the item specified
  321. by the supplied key. Note that a new ICogRecord is
  322. created every time this method is called.
  323. </summary>
  324. <param name="key">Specifies the item to fetch from the database.</param>
  325. <exception cref="T:System.InvalidOperationException">
  326. Thrown if not currently connected.
  327. </exception>
  328. <returns>A newly created instance of the requested database item.</returns>
  329. </member>
  330. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Fetch(System.Int32)">
  331. <summary>
  332. Create a CogVerificationData that duplicates the item specified
  333. by the supplied index. Note that a new ICogRecord is
  334. created every time this method is called.
  335. </summary>
  336. <param name="index">This index specifies the item to fetch from the database.
  337. Indexing is with respect to the list of keys returned by
  338. the GetKeys method.
  339. </param>
  340. <returns>A newly created instance of the requested database item.</returns>
  341. </member>
  342. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
  343. <summary>
  344. Adds the specified image to this verification database.
  345. If the image cannot be loaded, this method stops and throws an exception.
  346. </summary>
  347. <param name="imageFilename">The full path to the image to be added.</param>
  348. <param name="referenceImage">Set this to true if the images should be referenced by their full path.
  349. Set this to false if the images should be embedded (copied) into the database.
  350. </param>
  351. <param name="defaultSimpleResult">The default simple result for all the added images</param>
  352. <returns>An array of all the images that were added to the database.</returns>
  353. <exception cref="T:System.InvalidOperationException">
  354. Thrown if not currently connected.
  355. </exception>
  356. <exception cref="T:System.ArgumentNullException">
  357. Thrown if imageFilanem is null.
  358. </exception>
  359. <exception cref="T:System.ArgumentNullException">
  360. Thrown if the imageFilename is not found.
  361. </exception>
  362. <exception cref="T:System.ArgumentNullException">
  363. Thrown if the image cannot be added to the database.
  364. </exception>
  365. </member>
  366. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
  367. <summary>
  368. Adds the specified image to this verification database.
  369. If the image cannot be loaded, this method stops and throws an exception.
  370. </summary>
  371. <param name="imageFilename">The full path to the image to be added.</param>
  372. <param name="referenceImage">Set this to true if the images should be referenced by their full path.
  373. Set this to false if the images should be embedded (copied) into the database.
  374. </param>
  375. <param name="defaultSimpleResult">The default simple result for all the added images</param>
  376. <param name="defaultGrade">The default advanced grade for all the added images. If NULL then verificationData.Params.ExpectedOutputs.Grade.Value will not be set</param>
  377. <returns>An array of all the images that were added to the database.</returns>
  378. <exception cref="T:System.InvalidOperationException">
  379. Thrown if not currently connected.
  380. </exception>
  381. <exception cref="T:System.ArgumentNullException">
  382. Thrown if imageFilanem is null.
  383. </exception>
  384. <exception cref="T:System.ArgumentNullException">
  385. Thrown if the imageFilename is not found.
  386. </exception>
  387. <exception cref="T:System.ArgumentNullException">
  388. Thrown if the image cannot be added to the database.
  389. </exception>
  390. <example>
  391. <code lang="Visual Basic">
  392. Imports Cognex.VisionPro
  393. Imports Cognex.VisionPro.Database
  394. Imports Cognex.VisionPro.Inspection
  395. Private Sub Init()
  396. Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
  397. mInputDatabase.Connect()
  398. ' Add image to the database with no grade
  399. mInputDatabase.AddImage("C:\Images\sample.bmp", True, CogVerificationSimpleResultConstants.Accept, "Excellent")
  400. mInputDatabase.Disconnect()
  401. End Sub
  402. </code>
  403. <code lang="C#">
  404. using Cognex.VisionPro;
  405. using Cognex.VisionPro.Database;
  406. using Cognex.VisionPro.Inspection;
  407. private Init()
  408. {
  409. CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
  410. mInputDatabase.Connect();
  411. // Add image to the database with no grade
  412. mInputDatabase.AddImage(@"C:\Images\sample.bmp",true,CogVerificationSimpleResultConstants.Accept,"Excellent");
  413. mInputDatabase.Disconnect();
  414. }
  415. </code>
  416. </example>
  417. </member>
  418. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
  419. <summary>
  420. Adds all the images in the specified image directory to this verification database.
  421. If any image in the image directory cannot be loaded, this method stops and throws an exception.
  422. </summary>
  423. <param name="imageDirectory">The full path to the directoy that holds the images to be added.</param>
  424. <param name="referenceImages">Set this to true if the images should be referenced by their full path.
  425. Set this to false if the images should be embedded (copied) into the database.
  426. </param>
  427. <param name="defaultSimpleResult">The default simple result for all the add images</param>
  428. <returns>An array of all the images that were added to the database.</returns>
  429. <exception cref="T:System.InvalidOperationException">
  430. Thrown if not currently connected.
  431. </exception>
  432. <exception cref="T:System.ArgumentNullException">
  433. Thrown if imageDirectory is null.
  434. </exception>
  435. <exception cref="T:System.ArgumentNullException">
  436. Thrown if imageDirectory is not found.
  437. </exception>
  438. </member>
  439. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
  440. <summary>
  441. Adds all the images in the specified image directory to this verification database.
  442. If any image in the image directory cannot be loaded, this method stops and throws an exception.
  443. </summary>
  444. <param name="imageDirectory">The full path to the directoy that holds the images to be added.</param>
  445. <param name="referenceImages">Set this to true if the images should be referenced by their full path.
  446. Set this to false if the images should be embedded (copied) into the database.
  447. </param>
  448. <param name="defaultSimpleResult">The default simple result for all the add images</param>
  449. <param name="defaultGrade">The default advanced grade for all the added images. If NULL then verificationData.Params.ExpectedOutputs.Grade.Value will not be set</param>
  450. <returns>An array of all the images that were added to the database.</returns>
  451. <exception cref="T:System.InvalidOperationException">
  452. Thrown if not currently connected.
  453. </exception>
  454. <exception cref="T:System.ArgumentNullException">
  455. Thrown if imageDirectory is null.
  456. </exception>
  457. <exception cref="T:System.ArgumentNullException">
  458. Thrown if imageDirectory is not found.
  459. </exception>
  460. <example>
  461. <code lang="Visual Basic">
  462. Imports Cognex.VisionPro
  463. Imports Cognex.VisionPro.Database
  464. Imports Cognex.VisionPro.Inspection
  465. Private Sub Init()
  466. Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
  467. mInputDatabase.Connect()
  468. ' Add image to the database with no grade
  469. mInputDatabase.AddImage("C:\Images", True, CogVerificationSimpleResultConstants.Accept, "Excellent")
  470. mInputDatabase.Disconnect()
  471. End Sub
  472. </code>
  473. <code lang="C#">
  474. using Cognex.VisionPro;
  475. using Cognex.VisionPro.Database;
  476. using Cognex.VisionPro.Inspection;
  477. private Init()
  478. {
  479. CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
  480. mInputDatabase.Connect();
  481. // Add image to the database with no grade
  482. mInputDatabase.AddImage(@"C:\Images",true,CogVerificationSimpleResultConstants.Accept,"Excellent");
  483. mInputDatabase.Disconnect();
  484. }
  485. </code>
  486. </example>
  487. </member>
  488. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String[],System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
  489. <summary>
  490. Adds all the images in the specified array to this verification database.
  491. If any image in the specified array cannot be loaded, this method stops and throws an exception.
  492. </summary>
  493. <param name="images">An array that holds the full path to the images to be added.</param>
  494. <param name="referenceImages">Set this to true if the images should be referenced by their full path.
  495. Set this to false if the images should be embedded (copied) into the database.
  496. </param>
  497. <param name="defaultSimpleResult">The default simple result for all the added images</param>
  498. <returns>An array of all the images that were added to the database.</returns>
  499. <exception cref="T:System.InvalidOperationException">
  500. Thrown if not currently connected.
  501. </exception>
  502. <exception cref="T:System.ArgumentNullException">
  503. Thrown if images is null.
  504. </exception>
  505. <exception cref="T:System.ArgumentNullException">
  506. Thrown if images is zero length.
  507. </exception>
  508. </member>
  509. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String[],System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
  510. <summary>
  511. Adds all the images in the specified array to this verification database.
  512. If any image in the specified array cannot be loaded, this method stops and throws an exception.
  513. </summary>
  514. <param name="images">An array that holds the full path to the images to be added.</param>
  515. <param name="referenceImages">Set this to true if the images should be referenced by their full path.
  516. Set this to false if the images should be embedded (copied) into the database.
  517. </param>
  518. <param name="defaultSimpleResult">The default simple result for all the added images</param>
  519. <param name="defaultGrade">The default advanced grade for all the added images. If NULL then verificationData.Params.ExpectedOutputs.Grade.Value will not be set</param>
  520. <returns>An array of all the images that were added to the database.</returns>
  521. <exception cref="T:System.InvalidOperationException">
  522. Thrown if not currently connected.
  523. </exception>
  524. <exception cref="T:System.ArgumentNullException">
  525. Thrown if images is null.
  526. </exception>
  527. <exception cref="T:System.ArgumentNullException">
  528. Thrown if images is zero length.
  529. </exception>
  530. <example>
  531. <code lang="Visual Basic">
  532. Imports Cognex.VisionPro
  533. Imports Cognex.VisionPro.Database
  534. Imports Cognex.VisionPro.Inspection
  535. Private Sub Init()
  536. Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
  537. mInputDatabase.Connect()
  538. ' Create an array which contains the full path for the images
  539. Dim images As String() = New String() {"C:\Images\sample1.bmp", "C:\Images\sample2.bmp"}
  540. ' Add image to the database with no grade
  541. mInputDatabase.AddImage(images, True, CogVerificationSimpleResultConstants.Accept, "Excellent")
  542. mInputDatabase.Disconnect()
  543. End Sub
  544. </code>
  545. <code lang="C#">
  546. using Cognex.VisionPro;
  547. using Cognex.VisionPro.Database;
  548. using Cognex.VisionPro.Inspection;
  549. private Init()
  550. {
  551. CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
  552. mInputDatabase.Connect();
  553. // Create an array which contains the full path for the images
  554. string[] images = new string[]{@"C:\Images\sample1.bmp",@"C:\Images\sample2.bmp"};
  555. // Add image to the database with no grade
  556. mInputDatabase.AddImage(images,true,CogVerificationSimpleResultConstants.Accept,"Excellent");
  557. mInputDatabase.Disconnect();
  558. }
  559. </code>
  560. </example>
  561. </member>
  562. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage,System.String,System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String,System.Int32)">
  563. <summary>
  564. Adds the specified image to this verification database.
  565. If the image cannot be loaded, this method stops and throws an exception.
  566. </summary>
  567. <param name="image">The ICogImage object that will be added to tha database</param>
  568. <param name="referenceImage">Set this to true if the images should be referenced by their full path.
  569. Set this to false if the images should be embedded (copied) into the database.
  570. </param>
  571. <param name="imageFilename">The full path to the image to be added. (only needed if referenceImage is set to true)</param>
  572. <param name="defaultKey">The value of the record key the CogRecord should be created with</param>
  573. <param name="defaultGrade">The default grade for the added image</param>
  574. <param name="imageIndex">The index of the image if it will be a referenced image coming from a container has multimple images inside</param>
  575. <param name="defaultSimpleResult">The default simple result for the added image</param>
  576. <returns>A key of the image that were added to the database.</returns>
  577. <exception cref="T:System.InvalidOperationException">
  578. Thrown if not currently connected.
  579. </exception>
  580. <exception cref="T:System.ArgumentNullException">
  581. Thrown if imageFilanem is null.
  582. </exception>
  583. <exception cref="T:System.ArgumentNullException">
  584. Thrown if the imageFilename is not found.
  585. </exception>
  586. <exception cref="T:System.ArgumentNullException">
  587. Thrown if the defaultKey is null.
  588. </exception>
  589. <exception cref="T:System.ArgumentNullException">
  590. Thrown if the image cannot be added to the database.
  591. </exception>
  592. </member>
  593. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
  594. <summary>
  595. Adds the specified image to this verification database.
  596. </summary>
  597. <param name="image">The ICogImage object that will be added to tha database</param>
  598. <param name="defaultSimpleResult">The default simple result for the added image</param>
  599. <returns>A key of the image that were added to the database.</returns>
  600. <exception cref="T:System.InvalidOperationException">
  601. Thrown if not currently connected.
  602. </exception>
  603. <exception cref="T:System.ArgumentNullException">
  604. Thrown if image is null.
  605. </exception>
  606. <exception cref="T:System.ArgumentNullException">
  607. Thrown if the image cannot be added to the database.
  608. </exception>
  609. </member>
  610. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
  611. <summary>
  612. Adds the specified image to this verification database.
  613. </summary>
  614. <param name="image">The ICogImage object that will be added to tha database</param>
  615. <param name="defaultSimpleResult">The default simple result for the added image</param>
  616. <param name="defaultGrade">The default grade for the added image</param>
  617. <returns>A key of the image that were added to the database.</returns>
  618. <exception cref="T:System.InvalidOperationException">
  619. Thrown if not currently connected.
  620. </exception>
  621. <exception cref="T:System.ArgumentNullException">
  622. Thrown if image is null.
  623. </exception>
  624. <exception cref="T:System.ArgumentNullException">
  625. Thrown if the image cannot be added to the database.
  626. </exception>
  627. </member>
  628. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage[],Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
  629. <summary>
  630. Adds the specified images to this verification database.
  631. </summary>
  632. <param name="images">The array of ICogImage objects that will be added to tha database</param>
  633. <param name="defaultSimpleResult">The default simple result for all the added images</param>
  634. <returns>The keys of the images that were added to the database.</returns>
  635. <exception cref="T:System.InvalidOperationException">
  636. Thrown if not currently connected.
  637. </exception>
  638. <exception cref="T:System.ArgumentNullException">
  639. Thrown if any of the images is null.
  640. </exception>
  641. <exception cref="T:System.ArgumentNullException">
  642. Thrown if the image cannot be added to the database.
  643. </exception>
  644. </member>
  645. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage[],Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
  646. <summary>
  647. Adds the specified images to this verification database.
  648. </summary>
  649. <param name="images">The array of ICogImage objects that will be added to tha database</param>
  650. <param name="defaultSimpleResult">The default simple result for all the added images</param>
  651. <param name="defaultGrade">The default grade for all the added images</param>
  652. <returns>The keys of the images that were added to the database.</returns>
  653. <exception cref="T:System.InvalidOperationException">
  654. Thrown if not currently connected.
  655. </exception>
  656. <exception cref="T:System.ArgumentNullException">
  657. Thrown if any of the images is null.
  658. </exception>
  659. <exception cref="T:System.ArgumentNullException">
  660. Thrown if the image cannot be added to the database.
  661. </exception>
  662. </member>
  663. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetAnnotationCategories">
  664. <summary>
  665. Gets all the annotation categories in this verification database.
  666. </summary>
  667. <returns>An array of defined annotation categories.</returns>
  668. <exception cref="T:System.InvalidOperationException">
  669. Thrown if not currently connected.
  670. </exception>
  671. </member>
  672. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddAnnotationCategory(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
  673. <summary>
  674. Adds the specified annotatation category to the database.
  675. </summary>
  676. <param name="newAnnotationCategory">The new annotation category to add.</param>
  677. <exception cref="T:System.InvalidOperationException">
  678. Thrown if not currently connected.
  679. </exception>
  680. <exception cref="T:System.ArgumentNullException">
  681. Thrown if newAnnotationCategory Name is null.
  682. </exception>
  683. <exception cref="T:System.ArgumentNullException">
  684. Thrown if newAnnotationCategory Name is not unique.
  685. </exception>
  686. <event cref="E:Cognex.VisionPro.Inspection.AddedAnnotationCategoryEvent">
  687. Fires at the end of a call to this method.
  688. </event>
  689. </member>
  690. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemoveAnnotationCategory(System.String)">
  691. <summary>
  692. Removes the specified annotation category definition from the verification database.
  693. Note, this method does not remove any defined defects using the removed category, it
  694. just removes the definition of the annotation category. Users wanting to remove any
  695. defects using the removed annotation category need to do this themselves manually.
  696. </summary>
  697. <param name="annotationCategoryToRemove">Annotation category to remove.</param>
  698. <exception cref="T:System.InvalidOperationException">
  699. Thrown if not currently connected.
  700. </exception>
  701. <exception cref="T:System.ArgumentNullException">
  702. Thrown if annoationCategoryToRemove is null.
  703. </exception>
  704. <exception cref="T:System.ArgumentNullException">
  705. Thrown if annoationCategoryToRemove not found.
  706. </exception>
  707. <event cref="E:Cognex.VisionPro.Inspection.RemovedAnnotationCategoryEvent">
  708. Fires at the end of a call to this method.
  709. </event>
  710. </member>
  711. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetGrades">
  712. <summary>
  713. Gets all the grades in this verification database.
  714. </summary>
  715. <returns>An array of defined string grades.</returns>
  716. <exception cref="T:System.InvalidOperationException">
  717. Thrown if not currently connected.
  718. </exception>
  719. </member>
  720. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddGrade(System.String)">
  721. <summary>
  722. Adds the specified grade to the database.
  723. </summary>
  724. <param name="newGrade">The new grade to add.</param>
  725. <exception cref="T:System.InvalidOperationException">
  726. Thrown if not currently connected.
  727. </exception>
  728. <exception cref="T:System.ArgumentNullException">
  729. Thrown if newGrade is null.
  730. </exception>
  731. <exception cref="T:System.ArgumentNullException">
  732. Thrown if newGrade is not unique.
  733. </exception>
  734. <event cref="E:Cognex.VisionPro.Inspection.AddedGradeEvent">
  735. Fires at the end of a call to this method.
  736. </event>
  737. </member>
  738. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemoveGrade(System.String)">
  739. <summary>
  740. Removes the specified string grade from the verification database.
  741. Note, this method does not remove any set grades from individual records, it
  742. just removes the grade from the list of possible grades. Users wanting to remove the
  743. grade from any database record need to do this themselves.
  744. </summary>
  745. <param name="gradeToRemove">Grade to remove.</param>
  746. <exception cref="T:System.InvalidOperationException">
  747. Thrown if not currently connected.
  748. </exception>
  749. <exception cref="T:System.ArgumentNullException">
  750. Thrown if gradeToRemove is null.
  751. </exception>
  752. <exception cref="T:System.ArgumentNullException">
  753. Thrown if gradeToRemove not found.
  754. </exception>
  755. <event cref="E:Cognex.VisionPro.Inspection.RemovedGradeEvent">
  756. Fires at the end of a call to this method.
  757. </event>
  758. </member>
  759. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetStatistics">
  760. <summary>
  761. Gets the statistics object from this database.
  762. </summary>
  763. <returns>A reference to the statistics object.</returns>
  764. <exception cref="T:System.InvalidOperationException">
  765. Thrown if not currently connected.
  766. </exception>
  767. </member>
  768. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.SetStatistics(Cognex.VisionPro.Inspection.CogVerificationStatistics)">
  769. <summary>
  770. Sets the statistics object for this database. Internal use only.
  771. </summary>
  772. <param name="newStatistics"></param>
  773. <exception cref="T:System.InvalidOperationException">
  774. Thrown if not currently connected.
  775. </exception>
  776. </member>
  777. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Connect">
  778. <summary>
  779. Connect to the underlying ICogDatabase.
  780. </summary>
  781. </member>
  782. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Disconnect">
  783. <summary>
  784. Disconnect from the underlying contained ICogDatabase.
  785. </summary>
  786. </member>
  787. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Clear">
  788. <summary>
  789. Clear the underlying contained ICogDatabase.
  790. </summary>
  791. </member>
  792. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAdding(Cognex.VisionPro.Inspection.CogVerificationData)">
  793. <summary>
  794. Raise the Adding event.
  795. </summary>
  796. </member>
  797. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAdded(Cognex.VisionPro.Inspection.CogVerificationData)">
  798. <summary>
  799. Raise the Added event.
  800. </summary>
  801. </member>
  802. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemoving(System.String)">
  803. <summary>
  804. Raise the Removing event.
  805. </summary>
  806. </member>
  807. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemoved(System.String)">
  808. <summary>
  809. Raise the Removed event.
  810. </summary>
  811. </member>
  812. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnReplacing(Cognex.VisionPro.Inspection.CogVerificationData)">
  813. <summary>
  814. Raise the Replacing event.
  815. </summary>
  816. </member>
  817. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnReplaced(Cognex.VisionPro.Inspection.CogVerificationData)">
  818. <summary>
  819. Raise the Replaced event.
  820. </summary>
  821. </member>
  822. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnClearing">
  823. <summary>
  824. Raise the Clearing event.
  825. </summary>
  826. </member>
  827. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnCleared">
  828. <summary>
  829. Raise the Cleared event.
  830. </summary>
  831. </member>
  832. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAddedAnnotationCategory(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
  833. <summary>
  834. Raise the AddedAnnotationCategory event.
  835. </summary>
  836. </member>
  837. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemovedAnnotationCategory(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
  838. <summary>
  839. Raise the RemovedAnnotationCategory event.
  840. </summary>
  841. </member>
  842. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAddedGrade(System.String)">
  843. <summary>
  844. Raise the AddedAnnotationCategory event.
  845. </summary>
  846. </member>
  847. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemovedGrade(System.String)">
  848. <summary>
  849. Raise the RemovedAnnotationCategory event.
  850. </summary>
  851. </member>
  852. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnStatisticsSet">
  853. <summary>
  854. Raise the StatisticsSet event.
  855. </summary>
  856. </member>
  857. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetEnumerator">
  858. <summary>
  859. Create a strongly typed enumerator to facilitate
  860. iterating through the items in this database. Note that
  861. enumerators are fragile - externally adding or removing items
  862. from this database will invalidate the enumerator. Also note
  863. that modifying a CogVerificationData returned by (the Current property of)
  864. this enumerator will have absolutely no affect on the database
  865. since it is a freshly created copy of the database item, just
  866. as with the Fetch method.
  867. </summary>
  868. <returns>
  869. An enumerator whose Current property is of type CogVerificationData.
  870. </returns>
  871. <exception cref="T:System.InvalidOperationException">
  872. Thrown if not currently connected.
  873. </exception>
  874. </member>
  875. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.System#Collections#IEnumerable#GetEnumerator">
  876. <summary>
  877. Create a strongly typed enumerator to facilitate
  878. iterating through the items in this database. Note that
  879. enumerators are fragile - externally adding or removing items
  880. from this database will invalidate the enumerator. Also note
  881. that modifying a CogVerificationData returned by (the Current property of)
  882. this enumerator will have absolutely no affect on the database
  883. since it is a freshly created copy of the database item, just
  884. as with the Fetch method.
  885. </summary>
  886. <returns>
  887. An enumerator whose Current property is of type Object.
  888. </returns>
  889. <exception cref="T:System.InvalidOperationException">
  890. Thrown if not currently connected.
  891. </exception>
  892. </member>
  893. <member name="P:Cognex.VisionPro.Inspection.CogVerificationDatabase.Database">
  894. <summary>
  895. Get the unerlying contained ICogDatabase object.
  896. </summary>
  897. </member>
  898. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Adding">
  899. <summary>
  900. Raised before adding data to the verification database.
  901. </summary>
  902. </member>
  903. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Added">
  904. <summary>
  905. Raised after data has been added to the verification database.
  906. </summary>
  907. </member>
  908. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Removing">
  909. <summary>
  910. Raised before removing data from the verification database.
  911. </summary>
  912. </member>
  913. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Removed">
  914. <summary>
  915. Raised after data has been removed from the verification database.
  916. </summary>
  917. </member>
  918. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Replacing">
  919. <summary>
  920. Raised before replacing data in the verification database.
  921. </summary>
  922. </member>
  923. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Replaced">
  924. <summary>
  925. Raised after data has been replaced in the verification database.
  926. </summary>
  927. </member>
  928. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Clearing">
  929. <summary>
  930. Raised before clearing the verification database.
  931. </summary>
  932. </member>
  933. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Cleared">
  934. <summary>
  935. Raised after the verification database has been cleared.
  936. </summary>
  937. </member>
  938. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddedAnnotationCategory">
  939. <summary>
  940. Raised after an annotation category has been added to the verification database.
  941. </summary>
  942. </member>
  943. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemovedAnnotationCategory">
  944. <summary>
  945. Raised after an annotation category has been removed from the verification database.
  946. </summary>
  947. </member>
  948. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddedGrade">
  949. <summary>
  950. Raised after a grade has been added to the verification database.
  951. </summary>
  952. </member>
  953. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemovedGrade">
  954. <summary>
  955. Raised after a grade has been removed from the verification database.
  956. </summary>
  957. </member>
  958. <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.StatisticsSet">
  959. <summary>
  960. Raised after a statistics object has been set for the verification database.
  961. </summary>
  962. </member>
  963. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.#ctor(Cognex.VisionPro.Inspection.CogVerificationDatabase)">
  964. <summary>
  965. </summary>
  966. <param name="database"></param>
  967. </member>
  968. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.MoveNext">
  969. <summary>
  970. </summary>
  971. <returns></returns>
  972. </member>
  973. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Reset">
  974. <summary>
  975. </summary>
  976. </member>
  977. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Dispose">
  978. <summary>
  979. </summary>
  980. </member>
  981. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Dispose(System.Boolean)">
  982. <summary>
  983. </summary>
  984. <param name="bDisposing"></param>
  985. </member>
  986. <member name="P:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Current">
  987. <summary>
  988. </summary>
  989. </member>
  990. <member name="P:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.System#Collections#IEnumerator#Current">
  991. <summary>
  992. </summary>
  993. </member>
  994. <member name="T:Cognex.VisionPro.Inspection.CogImageReferenceRecord">
  995. <summary>
  996. This class is used to implement a CogRecord that references an image instead of
  997. embedding. The image is referenced via a full path and index (if the referenced image
  998. contains multiple images).
  999. </summary>
  1000. </member>
  1001. <member name="F:Cognex.VisionPro.Inspection.CogImageReferenceRecord.SfImageFilename">
  1002. <summary>
  1003. This bit will be set in the EventArgs of a Changed event every
  1004. time the value returned by ImageFilename may have changed.
  1005. </summary>
  1006. </member>
  1007. <member name="M:Cognex.VisionPro.Inspection.CogImageReferenceRecord.CheckImageFilename">
  1008. <summary>
  1009. Verifies that the referenced image exists. If there is a problem loading the image,
  1010. an exception is thrown, otherwise this method just returns.
  1011. </summary>
  1012. <exception cref="T:System.ArgumentNullException">
  1013. Thrown if the ImageFilename is null.
  1014. </exception>
  1015. <exception cref="T:System.ArgumentOutOfRangeException">
  1016. Thrown if the ImageIndex is out of range.
  1017. </exception>
  1018. </member>
  1019. <member name="P:Cognex.VisionPro.Inspection.CogImageReferenceRecord.Content">
  1020. <summary>
  1021. Gets the record's content. This is a read-only property, even though it has a setter.
  1022. </summary>
  1023. <value>The record's content.</value>
  1024. /// <exception cref="T:System.InvalidOperationException">
  1025. Thrown if the setter of this property is called.
  1026. </exception>
  1027. </member>
  1028. <member name="P:Cognex.VisionPro.Inspection.CogImageReferenceRecord.ImageFilename">
  1029. <summary>
  1030. Get/set the filename of the referenced image.
  1031. </summary>
  1032. </member>
  1033. <member name="P:Cognex.VisionPro.Inspection.CogImageReferenceRecord.ImageIndex">
  1034. <summary>
  1035. Get/set the image index, if the referenced image is a multi-image container.
  1036. Default unitialized value is -1, but should be set to zero in the constructor if the index is not used.
  1037. </summary>
  1038. </member>
  1039. <member name="T:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants">
  1040. <summary>
  1041. This enumeration holds the expected value for the VisionTool.RunStatus.Result property.
  1042. </summary>
  1043. </member>
  1044. <member name="F:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants.Accept">
  1045. <summary>
  1046. The expected RunStatus.Result from the Vision Tool is Accept.
  1047. </summary>
  1048. </member>
  1049. <member name="F:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants.Reject">
  1050. <summary>
  1051. The expected RunStatus.Result from the Vision Tool is Reject.
  1052. </summary>
  1053. </member>
  1054. <member name="F:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants.Unknown">
  1055. <summary>
  1056. The expected RunStatus.Result from the Vision Tool is Unknown.
  1057. The verifier has a property called UnknownResultBehavior which controls what happens during
  1058. verification when this enumeration is encountered.
  1059. </summary>
  1060. </member>
  1061. <member name="T:Cognex.VisionPro.Inspection.CogVerificationUnknownResultBehaviorConstants">
  1062. <summary>
  1063. This enumeration is used by the verifier's UnknownResultBehavior property to control what the
  1064. result of the verification when the CogVerificationSimpleResultConstants.Unknown is encountered.
  1065. </summary>
  1066. </member>
  1067. <member name="F:Cognex.VisionPro.Inspection.CogVerificationUnknownResultBehaviorConstants.AlwaysMismatch">
  1068. <summary>
  1069. Always fail/mismatch the verification.
  1070. </summary>
  1071. </member>
  1072. <member name="F:Cognex.VisionPro.Inspection.CogVerificationUnknownResultBehaviorConstants.AlwaysMatch">
  1073. <summary>
  1074. Always pass/match the verification.
  1075. </summary>
  1076. </member>
  1077. <member name="T:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants">
  1078. <summary>
  1079. This enumeration is the ResultType category for verification results.
  1080. </summary>
  1081. </member>
  1082. <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.TrueAccept">
  1083. <summary>
  1084. The expected result was Accept and the actual result from the VisionTool was Accept.
  1085. </summary>
  1086. </member>
  1087. <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.TrueReject">
  1088. <summary>
  1089. The expected result was Reject and the actual result from the VisionTool was Reject.
  1090. </summary>
  1091. </member>
  1092. <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.FalseAccept">
  1093. <summary>
  1094. The expected result was Reject and the actual result from the VisionTool was Accept.
  1095. </summary>
  1096. </member>
  1097. <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.FalseReject">
  1098. <summary>
  1099. The expected result was Accept and the actual result from the VisionTool was Reject.
  1100. </summary>
  1101. </member>
  1102. <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.UnknownAlwaysMatch">
  1103. <summary>
  1104. The expected result was Unknown and the verifier's UnknownResultBehavior property was set to AlwaysMismatch.
  1105. </summary>
  1106. </member>
  1107. <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.UnknownAlwaysMismatch">
  1108. <summary>
  1109. The expected result was Unknown and the verifier's UnknownResultBehavior property was set to AlwaysMatch.
  1110. </summary>
  1111. </member>
  1112. <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.Undefined">
  1113. <summary>
  1114. The VisionTool's result was either Warning or Error.
  1115. </summary>
  1116. </member>
  1117. <member name="T:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants">
  1118. <summary>
  1119. This enumeration is a set of OR-able flags that control what gets stored into the output database.
  1120. when the verifier is running.
  1121. </summary>
  1122. </member>
  1123. <member name="F:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants.None">
  1124. <summary>
  1125. None of the user controllable data is stored into the output database.
  1126. </summary>
  1127. </member>
  1128. <member name="F:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants.StoreLastRunRecord">
  1129. <summary>
  1130. The LastRunRecord is stored into the output database.
  1131. </summary>
  1132. </member>
  1133. <member name="F:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants.All">
  1134. <summary>
  1135. All user controllable data is stored into the output database.
  1136. </summary>
  1137. </member>
  1138. <member name="T:Cognex.VisionPro.Inspection.CogVerifierBasic">
  1139. <summary>
  1140. This class is an implementation of the ICogVerifier interface. This class
  1141. takes as input an input database, an output database, and a CogToolBlock under test. After given
  1142. these inputs, this verifier goes through the input database, setting up inputs to
  1143. the CogToolBlock, runs the CogToolBlock, and then compares the expected values in the input
  1144. database to the actaul values generated by the CogToolBlock. The results of this comparison is
  1145. finally stored in the output database.
  1146. </summary>
  1147. </member>
  1148. <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfInputDatabase">
  1149. <summary>
  1150. State flag for the InputDatabase property.
  1151. </summary>
  1152. </member>
  1153. <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfOutputDatabase">
  1154. <summary>
  1155. State flag for the OutputDatabase property.
  1156. </summary>
  1157. </member>
  1158. <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfVisionTool">
  1159. <summary>
  1160. State flag for the VisionTool property.
  1161. </summary>
  1162. </member>
  1163. <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfInputDatabaseSubset">
  1164. <summary>
  1165. State flag for the InputDatabaseSubset property.
  1166. </summary>
  1167. </member>
  1168. <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfUnknownResultBehavior">
  1169. <summary>
  1170. State flag for the UnknownResultBehavior property.
  1171. </summary>
  1172. </member>
  1173. <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfOutputDatabaseEnable">
  1174. <summary>
  1175. State flag for the OutputDatabaseEnable property.
  1176. </summary>
  1177. </member>
  1178. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.#ctor">
  1179. <summary>
  1180. Default constructor. You will need to provide the vision tool (CogToolBlock), input database, and output database
  1181. via the properties on this class if you use this constructor.
  1182. </summary>
  1183. </member>
  1184. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.#ctor(Cognex.VisionPro.ICogTool,Cognex.VisionPro.Inspection.CogVerificationDatabase,Cognex.VisionPro.Inspection.CogVerificationDatabase)">
  1185. <summary>
  1186. Constructor which takes all necessary inputs to the verifier.
  1187. </summary>
  1188. <param name="visionTool">The CogToolBlock under test.</param>
  1189. <param name="inputDatabase">The input database where the golden/known results are stored.</param>
  1190. <param name="outputDatabase">The output database where the results of the verification will be stored.</param>
  1191. </member>
  1192. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1193. <summary>
  1194. Serialization Constructor.
  1195. </summary>
  1196. <param name="info">
  1197. Standard SerializationInfo argument.
  1198. </param>
  1199. <param name="context">
  1200. Standard StreamingContext argument.
  1201. </param>
  1202. </member>
  1203. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.Run">
  1204. <summary>
  1205. Runs the verifier synchronously. This method will block until the entire input database is iterated over.
  1206. This method should not be called from a GUI callback handler (such as a button click handler)
  1207. since it can take a very long time to run. Please use the RunAsync() method instead (and subscribe
  1208. to the various verifier events).
  1209. </summary>
  1210. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is already running.</exception>
  1211. </member>
  1212. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsync">
  1213. <summary>
  1214. Runs the verifier asynchronously. As the verifier runs, various events are fired which
  1215. the user should be subscribed to.
  1216. </summary>
  1217. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is already running.</exception>
  1218. </member>
  1219. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsyncCancel">
  1220. <summary>
  1221. Cancels an asynchronous run of the verifier.
  1222. </summary>
  1223. </member>
  1224. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsyncPause">
  1225. <summary>
  1226. Pauses an asynchronous run of the verifier.
  1227. </summary>
  1228. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is currently idle.</exception>
  1229. </member>
  1230. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsyncResume">
  1231. <summary>
  1232. Resumes a currently paused verifier.
  1233. </summary>
  1234. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is not paused.</exception>
  1235. </member>
  1236. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.SetupVisionToolInputs(Cognex.VisionPro.Inspection.CogVerificationData,Cognex.VisionPro.Inspection.CogVerificationData)">
  1237. <summary>
  1238. Sets up the various inputs on the CogToolBlock from the specified data object.
  1239. </summary>
  1240. <param name="verificationData">The data object that contains the inputs to the CogToolBlock</param>
  1241. <param name="outputData">An output data object to receive a copy of the inputs. Should be set to null for normal usage. Internal Use only.</param>
  1242. </member>
  1243. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunStarted">
  1244. <summary>
  1245. Raise the RunStarted event.
  1246. </summary>
  1247. </member>
  1248. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunCompleted(System.Exception,System.Boolean,System.Object)">
  1249. <summary>
  1250. Raise the RunCompleted event.
  1251. </summary>
  1252. <param name="error">The exception if any was thrown during verification, null otherwise.</param>
  1253. <param name="cancelled">True if verification was cancelled, false otherwise.</param>
  1254. <param name="userState">Not used.</param>
  1255. </member>
  1256. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunProgress(System.Int32,Cognex.VisionPro.Inspection.CogVerificationData,System.Object)">
  1257. <summary>
  1258. Raise the RunProgress event.
  1259. </summary>
  1260. <param name="progressPercentage">The percentage the verifier has completed running (0-100).</param>
  1261. <param name="outputData">The output data object that was generated from the last iteration that was completed.</param>
  1262. <param name="userState">Not used.</param>
  1263. </member>
  1264. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunPaused">
  1265. <summary>
  1266. Raise the RunPaused event.
  1267. </summary>
  1268. </member>
  1269. <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunResumed">
  1270. <summary>
  1271. Raise the RunResumed event.
  1272. </summary>
  1273. </member>
  1274. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.InputDatabase">
  1275. <summary>
  1276. Get and set the input database.
  1277. </summary>
  1278. <event cref="E:Cognex.VisionPro.ChangedEvent">
  1279. Fires when this property changes.
  1280. </event>
  1281. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
  1282. </member>
  1283. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.InputDatabaseSubset">
  1284. <summary>
  1285. Get and set the subset of keys that the verifier should run against. The specified
  1286. keys must exist in the input database, otherwise the verifier will thrown an exception
  1287. during runtime.
  1288. </summary>
  1289. <event cref="E:Cognex.VisionPro.ChangedEvent">
  1290. Fires when this property changes.
  1291. </event>
  1292. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
  1293. </member>
  1294. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.OutputDatabase">
  1295. <summary>
  1296. Get and set the output database where the results of verification will be stored.
  1297. </summary>
  1298. <event cref="E:Cognex.VisionPro.ChangedEvent">
  1299. Fires when this property changes.
  1300. </event>
  1301. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
  1302. </member>
  1303. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.VisionTool">
  1304. <summary>
  1305. Get and set the CogToolBlock under test. Note, the type of this property is ICogTool, but
  1306. the input must be of type CogToolBlock.
  1307. </summary>
  1308. <event cref="E:Cognex.VisionPro.ChangedEvent">
  1309. Fires when this property changes.
  1310. </event>
  1311. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
  1312. </member>
  1313. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.UnknownResultBehavior">
  1314. <summary>
  1315. Get and set the behavior of the verifier (either match or mismatch) when an Unknown SimpleResult is encountered.
  1316. </summary>
  1317. <event cref="E:Cognex.VisionPro.ChangedEvent">
  1318. Fires when this property changes.
  1319. </event>
  1320. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
  1321. </member>
  1322. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.IsBusy">
  1323. <summary>
  1324. Get the current state of the verifier. Returns true if the verifier is busy, otherwise returns false.
  1325. No properties can be changed when the verifier is busy.
  1326. </summary>
  1327. </member>
  1328. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.Statistics">
  1329. <summary>
  1330. Get the statistics object associated with this verifier object.
  1331. </summary>
  1332. </member>
  1333. <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.OutputDatabaseEnable">
  1334. <summary>
  1335. Get and set the various flags that control what gets stored into the output database when the
  1336. verifier runs.
  1337. </summary>
  1338. <event cref="E:Cognex.VisionPro.ChangedEvent">
  1339. Fires when this property changes.
  1340. </event>
  1341. <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
  1342. </member>
  1343. <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunStarted">
  1344. <summary>
  1345. Raised when the verifier starts running.
  1346. </summary>
  1347. </member>
  1348. <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunProgressChanged">
  1349. <summary>
  1350. Raised when the verifier completes one iteration.
  1351. </summary>
  1352. </member>
  1353. <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunCompleted">
  1354. <summary>
  1355. Raised when the verifier has completely finished running.
  1356. </summary>
  1357. </member>
  1358. <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunPaused">
  1359. <summary>
  1360. Raised when the verifier is paused.
  1361. </summary>
  1362. </member>
  1363. <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunResumed">
  1364. <summary>
  1365. Raised when the verifier is resumed.
  1366. </summary>
  1367. </member>
  1368. <member name="T:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation">
  1369. <summary>
  1370. Class that defines a image annotation in the verification framework.
  1371. An image annotation is a graphic (rectangle) that encompasses some region of interest on an image.
  1372. The image annotation also has additional information associated with it including a unique name, a category, and a free form description string.
  1373. This image annotation is currently not used in any vision tool algorithm, but rather it is just used for visual identification of interesting regions on an image.
  1374. </summary>
  1375. </member>
  1376. <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfAnnotationName">
  1377. <summary>
  1378. State flag for the AnnotationName property.
  1379. </summary>
  1380. </member>
  1381. <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfCategory">
  1382. <summary>
  1383. State flag for Category the property.
  1384. </summary>
  1385. </member>
  1386. <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfDescription">
  1387. <summary>
  1388. State flag for Description the property.
  1389. </summary>
  1390. </member>
  1391. <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfGraphic">
  1392. <summary>
  1393. State flag for Graphic the property.
  1394. </summary>
  1395. </member>
  1396. <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfNextSf">
  1397. <summary>
  1398. Next state flag to be used in derived classes.
  1399. </summary>
  1400. </member>
  1401. <member name="M:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.#ctor(System.String,System.String,System.String,Cognex.VisionPro.ICogGraphicInteractive)">
  1402. <summary>
  1403. Constructor for an image annotation
  1404. </summary>
  1405. <param name="annotationName">The name of the image annotation, must be unique</param>
  1406. <param name="category">The category for the image annotation.</param>
  1407. <param name="description">A free form description of the image annotation</param>
  1408. <param name="graphic">A graphic that encompasses a region on an image. The derived type must be of type CogRectangle.</param>
  1409. </member>
  1410. <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.AnnotationName">
  1411. <summary>
  1412. Get and set the annotation name.
  1413. </summary>
  1414. </member>
  1415. <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.Category">
  1416. <summary>
  1417. Get and set the annotation category.
  1418. </summary>
  1419. </member>
  1420. <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.Description">
  1421. <summary>
  1422. Get and set the description of this annotation.
  1423. </summary>
  1424. </member>
  1425. <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.Graphic">
  1426. <summary>
  1427. Get and set the annotation graphic. Note, this graphic must be of type CogRectangle.
  1428. </summary>
  1429. </member>
  1430. <member name="T:Cognex.VisionPro.Inspection.ICogVerificationData">
  1431. <summary>
  1432. Interface for data which is contained inside a verification database
  1433. </summary>
  1434. </member>
  1435. <member name="P:Cognex.VisionPro.Inspection.ICogVerificationData.Record">
  1436. <summary>
  1437. Returns the contained ICogRecord.
  1438. </summary>
  1439. </member>
  1440. <member name="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">
  1441. <summary>
  1442. Invalid structure exception class.
  1443. </summary>
  1444. </member>
  1445. <member name="M:Cognex.VisionPro.Inspection.CogInvalidStructureException.#ctor(System.String)">
  1446. <summary>
  1447. Constructor which takes an human readable string that states what went wrong.
  1448. </summary>
  1449. <param name="message"></param>
  1450. </member>
  1451. <member name="T:Cognex.VisionPro.Inspection.CogVerificationRecordContainer">
  1452. <summary>
  1453. Non-change event implementation of ICogVerificationData.
  1454. </summary>
  1455. </member>
  1456. <member name="M:Cognex.VisionPro.Inspection.CogVerificationRecordContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  1457. <summary>
  1458. Constructor.
  1459. </summary>
  1460. <param name="record">The ICogRecord to be contained by this object.</param>
  1461. </member>
  1462. <member name="M:Cognex.VisionPro.Inspection.CogVerificationRecordContainer.Contains(System.String)">
  1463. <summary>
  1464. Returns a boolean if the specified SubRecord (via key parameter) is contained in the record this class holds.
  1465. </summary>
  1466. <param name="key">A string which is the key to be search for in the contained record.</param>
  1467. <returns>True if the contained record contains key, false otherwise.</returns>
  1468. </member>
  1469. <member name="P:Cognex.VisionPro.Inspection.CogVerificationRecordContainer.Record">
  1470. <summary>
  1471. Returns the contained ICogRecord.
  1472. </summary>
  1473. </member>
  1474. <member name="T:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer">
  1475. <summary>
  1476. Change event implementation of ICogVerificationData.
  1477. </summary>
  1478. </member>
  1479. <member name="M:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  1480. <summary>
  1481. Constructor
  1482. </summary>
  1483. <param name="record">The ICogRecord to be contained by this object.</param>
  1484. </member>
  1485. <member name="M:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer.Contains(System.String)">
  1486. <summary>
  1487. Returns a boolean if the specified SubRecord (via key parameter) is contained in the record this class holds.
  1488. </summary>
  1489. <param name="key">A string which is the key to be search for in the contained record.</param>
  1490. <returns></returns>
  1491. </member>
  1492. <member name="P:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer.Record">
  1493. <summary>
  1494. Returns the contained ICogRecord
  1495. </summary>
  1496. </member>
  1497. <member name="T:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1">
  1498. <summary>
  1499. Container class that provides generic type Value API.
  1500. </summary>
  1501. <typeparam name="T"></typeparam>
  1502. </member>
  1503. <member name="F:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1.SfValue">
  1504. <summary>
  1505. This bit will be set in the EventArgs of a Changed event every
  1506. time the value returned by Value may have changed.
  1507. </summary>
  1508. </member>
  1509. <member name="M:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1.#ctor(Cognex.VisionPro.ICogRecord)">
  1510. <summary>
  1511. Constructor.
  1512. </summary>
  1513. <param name="record">The ICogRecord to be contained by this object.</param>
  1514. </member>
  1515. <member name="P:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1.Value">
  1516. <summary>
  1517. Get and set the Contents of the ICogRecord that is contained in this object.
  1518. </summary>
  1519. </member>
  1520. <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1">
  1521. <summary>
  1522. Container class for verified output results.
  1523. </summary>
  1524. <typeparam name="T"></typeparam>
  1525. </member>
  1526. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.#ctor(Cognex.VisionPro.ICogRecord)">
  1527. <summary>
  1528. Constructor.
  1529. </summary>
  1530. <param name="record">The ICogRecord to be contained by this object.</param>
  1531. </member>
  1532. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ContainsVerificationResult">
  1533. <summary>
  1534. Method which returns whether or not the "VerificationResult" SubRecord exists in the contained ICogRecord.
  1535. </summary>
  1536. <returns>Returns true if the contained ICogRecord contains a "VerificationResult" SubRecord.</returns>
  1537. </member>
  1538. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ContainsActualResult">
  1539. <summary>
  1540. Method which returns whether or not the "ActualResult" SubRecord exists in the contained ICogRecord.
  1541. </summary>
  1542. <returns>Returns true if the contained ICogRecord contains a "ActualResult" SubRecord.</returns>
  1543. </member>
  1544. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ContainsExpectedResult">
  1545. <summary>
  1546. Method which returns whether or not the "Expected" SubRecord exists in the contained ICogRecord.
  1547. </summary>
  1548. <returns>Returns true if the contained ICogRecord contains a "Expected" SubRecord.</returns>
  1549. </member>
  1550. <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.VerificationResult">
  1551. <summary>
  1552. Get the verification result for this verified output.
  1553. The verification result is a boolean that indicates if the expected value matched the actual value.
  1554. </summary>
  1555. </member>
  1556. <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ActualResult">
  1557. <summary>
  1558. Get the actual result from the vision tool under test for this verified output.
  1559. </summary>
  1560. </member>
  1561. <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ExpectedResult">
  1562. <summary>
  1563. Get the expected result from the vision tool under test for this verified output.
  1564. </summary>
  1565. </member>
  1566. <member name="T:Cognex.VisionPro.Inspection.CogVerificationData">
  1567. <summary>
  1568. Data class that contains all attributes, params, and results used and generated by the verifier.
  1569. </summary>
  1570. </member>
  1571. <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.#ctor(Cognex.VisionPro.ICogRecord)">
  1572. <summary>
  1573. Constructor using an ICogRecord.
  1574. </summary>
  1575. <param name="record">The ICogRecord to be contained by this object.</param>
  1576. </member>
  1577. <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.#ctor(System.String)">
  1578. <summary>
  1579. Constructor using a key. A brand new CogRecord is constructed using the specified key.
  1580. All necessary SubRecords necessary for use with the verification framework are added to the new CogRecord.
  1581. </summary>
  1582. <param name="key">The key that is used by the contained ICogRecord.</param>
  1583. </member>
  1584. <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.ContainsAttributes">
  1585. <summary>
  1586. Method which returns whether or not the "Attributes" SubRecord exists in the contained ICogRecord.
  1587. </summary>
  1588. <returns>Returns true if the contained ICogRecord contains a "Attributes" SubRecord.</returns>
  1589. </member>
  1590. <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.ContainsParams">
  1591. <summary>
  1592. Method which returns whether or not the "Params" SubRecord exists in the contained ICogRecord.
  1593. </summary>
  1594. <returns>Returns true if the contained ICogRecord contains a "Params" SubRecord.</returns>
  1595. </member>
  1596. <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.ContainsResults">
  1597. <summary>
  1598. Method which returns whether or not the "Results" SubRecord exists in the contained ICogRecord.
  1599. </summary>
  1600. <returns>Returns true if the contained ICogRecord contains a "Results" SubRecord.</returns>
  1601. </member>
  1602. <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.CheckStructure">
  1603. <summary>
  1604. Checks the structure of the contained ICogRecord to make sure that it contains the necessary SubRecords for use in the verification framework.
  1605. This method will throw various exceptions describing any found errors. This method does not check the "Results" SubRecord since it may not be present.
  1606. If no errors are found, no exception is thrown and this method just returns.
  1607. </summary>
  1608. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record is null.</exception>
  1609. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record's key is null.</exception>
  1610. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes SubRecord.</exception>
  1611. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.CreationTimestamp SubRecord.</exception>
  1612. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.Description SubRecord.</exception>
  1613. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.Name SubRecord.</exception>
  1614. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.Version SubRecord.</exception>
  1615. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params SubRecord.</exception>
  1616. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedOutputs SubRecord.</exception>
  1617. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedRunStatus SubRecord.</exception>
  1618. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.Inputs SubRecord.</exception>
  1619. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedRunStatus.SimpleResult SubRecord.</exception>
  1620. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedOutputs.Grade SubRecord.</exception>
  1621. <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record's InputImage SubRecord is invalid.</exception>
  1622. </member>
  1623. <member name="P:Cognex.VisionPro.Inspection.CogVerificationData.Attributes">
  1624. <summary>
  1625. Returns the container object for the Attributes collection.
  1626. </summary>
  1627. </member>
  1628. <member name="P:Cognex.VisionPro.Inspection.CogVerificationData.Params">
  1629. <summary>
  1630. Returns the container object for the Params collection.
  1631. </summary>
  1632. </member>
  1633. <member name="P:Cognex.VisionPro.Inspection.CogVerificationData.Results">
  1634. <summary>
  1635. Returns the container object for the Results collection.
  1636. Note, only data objects that are outputs from the verifier will have this collection.
  1637. </summary>
  1638. </member>
  1639. <member name="T:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer">
  1640. <summary>
  1641. Class that contains all attributes used by the verification framework.
  1642. </summary>
  1643. </member>
  1644. <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  1645. <summary>
  1646. Constructor using an ICogRecord.
  1647. </summary>
  1648. <param name="record">The ICogRecord to be contained by this object.</param>
  1649. </member>
  1650. <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsName">
  1651. <summary>
  1652. Method which returns whether or not the "Name" SubRecord exists in the contained ICogRecord.
  1653. </summary>
  1654. <returns>Returns true if the contained ICogRecord contains a "Name" SubRecord.</returns>
  1655. </member>
  1656. <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsDescription">
  1657. <summary>
  1658. Method which returns whether or not the "Description" SubRecord exists in the contained ICogRecord.
  1659. </summary>
  1660. <returns>Returns true if the contained ICogRecord contains a "Description" SubRecord.</returns>
  1661. </member>
  1662. <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsVersion">
  1663. <summary>
  1664. Method which returns whether or not the "Version" SubRecord exists in the contained ICogRecord.
  1665. </summary>
  1666. <returns></returns>
  1667. </member>
  1668. <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsCreationTimestamp">
  1669. <summary>
  1670. Method which returns whether or not the "CreationTimestamp" SubRecord exists in the contained ICogRecord.
  1671. </summary>
  1672. <returns>Returns true if the contained ICogRecord contains a "CreationTimestamp" SubRecord.</returns>
  1673. </member>
  1674. <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.Name">
  1675. <summary>
  1676. Returns the value container object for the Name collection.
  1677. </summary>
  1678. </member>
  1679. <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.Description">
  1680. <summary>
  1681. Returns the value container object for the Description collection.
  1682. </summary>
  1683. </member>
  1684. <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.Version">
  1685. <summary>
  1686. Returns the value container object for the Version collection.
  1687. </summary>
  1688. </member>
  1689. <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.CreationTimestamp">
  1690. <summary>
  1691. Returns the value container object for the CreationTimestamp collection.
  1692. </summary>
  1693. </member>
  1694. <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsContainer">
  1695. <summary>
  1696. Class that contains all params used by the verification framework.
  1697. </summary>
  1698. </member>
  1699. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  1700. <summary>
  1701. Constructor using an ICogRecord.
  1702. </summary>
  1703. <param name="record">The ICogRecord to be contained by this object.</param>
  1704. </member>
  1705. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ContainsInputs">
  1706. <summary>
  1707. Method which returns whether or not the "Inputs" SubRecord exists in the contained ICogRecord.
  1708. </summary>
  1709. <returns>Returns true if the contained ICogRecord contains a "Inputs" SubRecord.</returns>
  1710. </member>
  1711. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ContainsExpectedOutputs">
  1712. <summary>
  1713. Method which returns whether or not the "ExpectedOutputs" SubRecord exists in the contained ICogRecord.
  1714. </summary>
  1715. <returns>Returns true if the contained ICogRecord contains a "ExpectedOutputs" SubRecord.</returns>
  1716. </member>
  1717. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ContainsExpectedRunStatus">
  1718. <summary>
  1719. Method which returns whether or not the "ExpectedRunStatus" SubRecord exists in the contained ICogRecord.
  1720. </summary>
  1721. <returns>Returns true if the contained ICogRecord contains a "ExpectedRunStatus" SubRecord.</returns>
  1722. </member>
  1723. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.Inputs">
  1724. <summary>
  1725. Returns the container object for the Inputs collection.
  1726. </summary>
  1727. </member>
  1728. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ExpectedOutputs">
  1729. <summary>
  1730. Returns the container object for the ExpectedOutputs collection.
  1731. </summary>
  1732. </member>
  1733. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ExpectedRunStatus">
  1734. <summary>
  1735. Returns the container object for the ExpectedRunStatus collection.
  1736. </summary>
  1737. </member>
  1738. <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer">
  1739. <summary>
  1740. Class that contains inputs used by the verification framework.
  1741. </summary>
  1742. </member>
  1743. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  1744. <summary>
  1745. Constructor using an ICogRecord.
  1746. </summary>
  1747. <param name="record">The ICogRecord to be contained by this object.</param>
  1748. </member>
  1749. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.ContainsInputImage">
  1750. <summary>
  1751. Method which returns whether or not the "InputImage" SubRecord exists in the contained ICogRecord.
  1752. </summary>
  1753. <returns>Returns true if the contained ICogRecord contains a "InputImage" SubRecord.</returns>
  1754. </member>
  1755. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.Add(System.String,System.Object)">
  1756. <summary>
  1757. Adds an input record with the given key and inputValue to the record.
  1758. </summary>
  1759. <param name="key">The key to be added to the record's Inputs parameters. The key has to be unique</param>
  1760. <param name="inputValue">The value to be assigned with the given key</param>
  1761. <exception cref="T:Exception">Thrown if the key is not unique.</exception>
  1762. </member>
  1763. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.Remove(System.String)">
  1764. <summary>
  1765. Removes subrecord with the given key from this record.
  1766. </summary>
  1767. <param name="key">The key of the subrecord to remove</param>
  1768. <exception cref="T:Exception">Thrown if the key is null.</exception>
  1769. <exception cref="T:Exception">Thrown if the key is not found.</exception>
  1770. </member>
  1771. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.InputImage">
  1772. <summary>
  1773. Returns the container object for the InputImage collection.
  1774. </summary>
  1775. </member>
  1776. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.Keys">
  1777. <summary>
  1778. Gets all the expected keys added to this record.
  1779. Returns null if there are no records.
  1780. Note: this will always return at least string[] { "InputImage" } since that was added to the records by default.
  1781. </summary>
  1782. </member>
  1783. <member name="T:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer">
  1784. <summary>
  1785. Class that contains the InputImage used by the verification framework.
  1786. </summary>
  1787. </member>
  1788. <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  1789. <summary>
  1790. Constructor using an ICogRecord.
  1791. </summary>
  1792. <param name="record">The ICogRecord to be contained by this object.</param>
  1793. </member>
  1794. <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.GetImageAnnotations">
  1795. <summary>
  1796. Gets all the annotations associated with this InputImage.
  1797. </summary>
  1798. <returns>An array of image annotations</returns>
  1799. </member>
  1800. <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.AddImageAnnotation(Cognex.VisionPro.Inspection.CogVerificationImageAnnotation)">
  1801. <summary>
  1802. Adds the specified annotation to this InputImage.
  1803. </summary>
  1804. <param name="annotation">The annotation to be added.</param>
  1805. <exception cref="T:System.ArgumentException">Thrown if the new annotation name is not unique.</exception>
  1806. <exception cref="T:System.ArgumentException">Thrown if the new annotation graphic is not a CogRectangle.</exception>
  1807. </member>
  1808. <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.RemoveImageAnnotation(System.String)">
  1809. <summary>
  1810. Removes the specified annotation from this InputImage.
  1811. </summary>
  1812. <param name="annotationName">The name of the annotation to remove</param>
  1813. <exception cref="T:System.ArgumentException">Thrown if the specified annotation name is not found.</exception>
  1814. </member>
  1815. <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer">
  1816. <summary>
  1817. Class that contains the ExpectedOutputs used by the verification framework.
  1818. </summary>
  1819. </member>
  1820. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  1821. <summary>
  1822. Constructor using an ICogRecord.
  1823. </summary>
  1824. <param name="record">The ICogRecord to be contained by this object.</param>
  1825. </member>
  1826. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.ContainsGrade">
  1827. <summary>
  1828. Method which returns whether or not the "Grade" SubRecord exists in the contained ICogRecord. Internal Use Only.
  1829. </summary>
  1830. <returns>Returns true if the contained ICogRecord contains a "Grade" SubRecord.</returns>
  1831. </member>
  1832. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Add(System.String,System.Object)">
  1833. <summary>
  1834. Adds an expected output with the given key and expectedValue to the record.
  1835. </summary>
  1836. <param name="key">The key to be added to the Record's ExpectedOutput parameters. The key has to be unique</param>
  1837. <param name="expectedValue">The value to be assigned with the given key</param>
  1838. <exception cref="T:Exception">Thrown if the key is not unique.</exception>
  1839. <example>
  1840. <code lang="Visual Basic">
  1841. Imports Cognex.VisionPro
  1842. Imports Cognex.VisionPro.Database
  1843. Imports Cognex.VisionPro.Inspection
  1844. Private Sub AddProperty()
  1845. Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
  1846. mInputDatabase.Connect()
  1847. Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
  1848. ' Add additional property to the record with the name "Area" and a value of 3.1415
  1849. mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415)
  1850. ' Change the additional property "Area"
  1851. mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords("Area").Content = 2.7182
  1852. ' Update the record in the database
  1853. mInputDatabase.Replace(mCurrentRecord)
  1854. mInputDatabase.Disconnect()
  1855. End Sub
  1856. </code>
  1857. <code lang="C#">
  1858. using Cognex.VisionPro;
  1859. using Cognex.VisionPro.Database;
  1860. using Cognex.VisionPro.Inspection;
  1861. private AddProperty()
  1862. {
  1863. CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
  1864. mInputDatabase.Connect();
  1865. CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
  1866. // Add additional property to the record with the name "Area" and a value of 3.1415
  1867. mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415);
  1868. // Change the additional property "Area"
  1869. mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords["Area"].Content = 2.7182;
  1870. // Update the record in the database
  1871. mInputDatabase.Replace(mCurrentRecord);
  1872. mInputDatabase.Disconnect();
  1873. }
  1874. </code>
  1875. </example>
  1876. </member>
  1877. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Add(System.String,System.Double,System.Double)">
  1878. <summary>
  1879. Adds an expected output with the given key, an expectedValue and a range to the record.
  1880. </summary>
  1881. <param name="key">The key to be added to the Record's ExpectedOutput parameters. The key has to be unique</param>
  1882. <param name="expectedValue">The value to be assigned with the given key</param>
  1883. <param name="range">The range to be assigned with the given expectedValue. The range is used by the verifier during verification to allow the expectedValue to vary by +/- the range</param>
  1884. <exception cref="T:Exception">Thrown if the key is not unique.</exception>
  1885. <example>
  1886. <code lang="Visual Basic">
  1887. Imports Cognex.VisionPro
  1888. Imports Cognex.VisionPro.Database
  1889. Imports Cognex.VisionPro.Inspection
  1890. Private Sub AddProperty()
  1891. Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
  1892. mInputDatabase.Connect()
  1893. Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
  1894. ' Add additional property to the record with the name "Area", a value of 3.1415 and a range of +-0.5
  1895. mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415, 0.5)
  1896. ' Change the additional property "Area"
  1897. mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords("Area").Content = 2.7182
  1898. ' Change the range for the additional property "Area"
  1899. ' WARNING: Works only if the additional property was created with a range
  1900. mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords("Area").SubRecords(CogFieldNameConstants.RkRange).Content = 0.2
  1901. ' Update the record in the database
  1902. mInputDatabase.Replace(mCurrentRecord)
  1903. mInputDatabase.Disconnect()
  1904. End Sub
  1905. </code>
  1906. <code lang="C#">
  1907. using Cognex.VisionPro;
  1908. using Cognex.VisionPro.Database;
  1909. using Cognex.VisionPro.Inspection;
  1910. private AddProperty()
  1911. {
  1912. CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
  1913. mInputDatabase.Connect();
  1914. CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
  1915. // Add additional property to the record with the name "Area", a value of 3.1415 and a range of +-0.5
  1916. mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415 , 0.5);
  1917. // Change the additional property "Area"
  1918. mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords["Area"].Content = 2.7182;
  1919. // Change the range for the additional property "Area"
  1920. // WARNING: Works only if the additional property was created with a range
  1921. mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords["Area"].SubRecords[CogFieldNameConstants.RkRange].Content = 0.2;
  1922. // Update the record in the database
  1923. mInputDatabase.Replace(mCurrentRecord);
  1924. mInputDatabase.Disconnect();
  1925. }
  1926. </code>
  1927. </example>
  1928. </member>
  1929. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Remove(System.String)">
  1930. <summary>
  1931. Removes subrecord with the given key from this record.
  1932. </summary>
  1933. <param name="key">The key of the subrecord to remove</param>
  1934. <exception cref="T:Exception">Thrown if the key is null.</exception>
  1935. <exception cref="T:Exception">Thrown if the key is not found.</exception>
  1936. <example>
  1937. <code lang="Visual Basic">
  1938. Imports Cognex.VisionPro
  1939. Imports Cognex.VisionPro.Database
  1940. Imports Cognex.VisionPro.Inspection
  1941. Private Sub New()
  1942. Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
  1943. mInputDatabase.Connect()
  1944. Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
  1945. ' Remove additional property "Area" from the record
  1946. mCurrentRecord.Params.ExpectedOutputs.Remove("Area")
  1947. ' Update the record in the database
  1948. mInputDatabase.Replace(mCurrentRecord)
  1949. mInputDatabase.Disconnect()
  1950. End Sub
  1951. </code>
  1952. <code lang="C#">
  1953. using Cognex.VisionPro;
  1954. using Cognex.VisionPro.Database;
  1955. using Cognex.VisionPro.Inspection;
  1956. private RemoveProperty()
  1957. {
  1958. CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
  1959. mInputDatabase.Connect();
  1960. CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
  1961. // Remove additional property "Area" from the record
  1962. mCurrentRecord.Params.ExpectedOutputs.Remove("Area");
  1963. // Update the record in the database
  1964. mInputDatabase.Replace(mCurrentRecord);
  1965. mInputDatabase.Disconnect();
  1966. }
  1967. </code>
  1968. </example>
  1969. </member>
  1970. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.AddExpectedBase(System.String,System.Object)">
  1971. <summary>
  1972. Adds an expected output with the given key and expectedValue.
  1973. </summary>
  1974. <param name="key">The key to be added to the Record's ExpectedOutput parameters. The key has to be unique</param>
  1975. <param name="expectedValue">The value to be assigned with the given key</param>
  1976. <exception cref="T:Exception">Thrown if the key is not unique.</exception>
  1977. <returns>Returns the created ICogRecord</returns>
  1978. </member>
  1979. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Grade">
  1980. <summary>
  1981. Returns the value container object for the Grade collection.
  1982. </summary>
  1983. <example>
  1984. <code lang="Visual Basic">
  1985. Imports Cognex.VisionPro
  1986. Imports Cognex.VisionPro.Database
  1987. Imports Cognex.VisionPro.Inspection
  1988. Private Sub SetGrade()
  1989. Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
  1990. mInputDatabase.Connect()
  1991. Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
  1992. ' The grade which will be added
  1993. Dim grade As String = "Good"
  1994. ' Step one: add this grade to the metadata
  1995. ' WARNING: If the metadata already contains this grade an exception will be thrown.
  1996. mInputDatabase.AddGrade(grade)
  1997. ' Step two: set the record's grade
  1998. mCurrentRecord.Params.ExpectedOutputs.Grade.Value = grade
  1999. ' Update the record in the database
  2000. mInputDatabase.Replace(mCurrentRecord)
  2001. mInputDatabase.Disconnect()
  2002. End Sub
  2003. </code>
  2004. <code lang="C#">
  2005. using Cognex.VisionPro;
  2006. using Cognex.VisionPro.Database;
  2007. using Cognex.VisionPro.Inspection;
  2008. private SetGrade()
  2009. {
  2010. CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
  2011. mInputDatabase.Connect();
  2012. CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
  2013. // The grade which will be added
  2014. string grade = "Good";
  2015. // Step one: add this grade to the metadata
  2016. // WARNING: If the metadata already contains this grade an exception will be thrown.
  2017. mInputDatabase.AddGrade(grade);
  2018. // Step two: set the record's grade
  2019. mCurrentRecord.Params.ExpectedOutputs.Grade.Value = grade;
  2020. // Update the record in the database
  2021. mInputDatabase.Replace(mCurrentRecord);
  2022. mInputDatabase.Disconnect();
  2023. }
  2024. </code>
  2025. </example>
  2026. </member>
  2027. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Keys">
  2028. <summary>
  2029. Gets all the expected keys added to this record.
  2030. Returns null if there are no records.
  2031. Note: this will always return at least string[] { "Grade" } since that was added to the records by default.
  2032. </summary>
  2033. </member>
  2034. <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer">
  2035. <summary>
  2036. Class that contains the ExpectedRunStatus used by the verification framework.
  2037. </summary>
  2038. </member>
  2039. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  2040. <summary>
  2041. Constructor using an ICogRecord.
  2042. </summary>
  2043. <param name="record">The ICogRecord to be contained by this object.</param>
  2044. </member>
  2045. <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer.ContainsSimpleResult">
  2046. <summary>
  2047. Method which returns whether or not the "SimpleResult" SubRecord exists in the contained ICogRecord.
  2048. </summary>
  2049. <returns>Returns true if the contained ICogRecord contains a "SimpleResult" SubRecord.</returns>
  2050. </member>
  2051. <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer.SimpleResult">
  2052. <summary>
  2053. Returns the value container object for the SimpleResult collection.
  2054. </summary>
  2055. </member>
  2056. <member name="T:Cognex.VisionPro.Inspection.CogVerificationResultsContainer">
  2057. <summary>
  2058. Class that contains the results used and generated by the verification framework.
  2059. </summary>
  2060. </member>
  2061. <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  2062. <summary>
  2063. Constructor using an ICogRecord.
  2064. </summary>
  2065. <param name="record">The ICogRecord to be contained by this object.</param>
  2066. </member>
  2067. <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsOverallVerificationResult">
  2068. <summary>
  2069. Method which returns whether or not the "OverallVerificationResult" SubRecord exists in the contained ICogRecord.
  2070. </summary>
  2071. <returns>Returns true if the contained ICogRecord contains a "OverallVerificationResult" SubRecord.</returns>
  2072. </member>
  2073. <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsVerificationTimestamp">
  2074. <summary>
  2075. Method which returns whether or not the "VerificationTimestamp" SubRecord exists in the contained ICogRecord.
  2076. </summary>
  2077. <returns>Returns true if the contained ICogRecord contains a "VerificationTimestamp" SubRecord.</returns>
  2078. </member>
  2079. <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsVerifiedOutputs">
  2080. <summary>
  2081. Method which returns whether or not the "VerifiedOutputs" SubRecord exists in the contained ICogRecord.
  2082. </summary>
  2083. <returns>Returns true if the contained ICogRecord contains a "VerifiedOutputs" SubRecord.</returns>
  2084. </member>
  2085. <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsVerifiedRunStatus">
  2086. <summary>
  2087. Method which returns whether or not the "VerifiedRunStatus" SubRecord exists in the contained ICogRecord.
  2088. </summary>
  2089. <returns>Returns true if the contained ICogRecord contains a "VerifiedRunStatus" SubRecord.</returns>
  2090. </member>
  2091. <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsLastRunRecord">
  2092. <summary>
  2093. Method which returns whether or not the "LastRunRecord" SubRecord exists in the contained ICogRecord.
  2094. </summary>
  2095. <returns>Returns true if the contained ICogRecord contains a "LastRunRecord" SubRecord.</returns>
  2096. </member>
  2097. <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.OverallVerificationResult">
  2098. <summary>
  2099. Returns the value container object for the OverallVerificationResult collection.
  2100. </summary>
  2101. </member>
  2102. <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.VerificationTimestamp">
  2103. <summary>
  2104. Returns the value container object for the VerificationTimestamp collection.
  2105. </summary>
  2106. </member>
  2107. <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.VerifiedOutputs">
  2108. <summary>
  2109. Returns the container object for the VerifiedOutputs collection.
  2110. </summary>
  2111. </member>
  2112. <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.VerifiedRunStatus">
  2113. <summary>
  2114. Returns the container object for the VerifiedRunStatus collection.
  2115. </summary>
  2116. </member>
  2117. <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.LastRunRecord">
  2118. <summary>
  2119. Returns the container object for the LastRunRecord collection.
  2120. </summary>
  2121. </member>
  2122. <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer">
  2123. <summary>
  2124. Class that contains the VerifiedOutputs generated by the verification framework.
  2125. </summary>
  2126. </member>
  2127. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  2128. <summary>
  2129. Constructor using an ICogRecord.
  2130. </summary>
  2131. <param name="record">The ICogRecord to be contained by this object.</param>
  2132. </member>
  2133. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer.ContainsGrade">
  2134. <summary>
  2135. Method which returns whether or not the "Grade" SubRecord exists in the contained ICogRecord. Internal Use Only.
  2136. </summary>
  2137. <returns>Returns true if the contained ICogRecord contains a "Grade" SubRecord.</returns>
  2138. </member>
  2139. <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer.Grade">
  2140. <summary>
  2141. Returns the value container object for the Grade collection. Internal Use Only.
  2142. </summary>
  2143. </member>
  2144. <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer">
  2145. <summary>
  2146. Class that contains the VerifiedRunStatus generated by the verification framework.
  2147. </summary>
  2148. </member>
  2149. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  2150. <summary>
  2151. Constructor using an ICogRecord.
  2152. </summary>
  2153. <param name="record">The ICogRecord to be contained by this object.</param>
  2154. </member>
  2155. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer.ContainsSimpleResult">
  2156. <summary>
  2157. Method which returns whether or not the "SimpleResult" SubRecord exists in the contained ICogRecord.
  2158. </summary>
  2159. <returns>Returns true if the contained ICogRecord contains a "SimpleResult" SubRecord.</returns>
  2160. </member>
  2161. <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer.SimpleResult">
  2162. <summary>
  2163. Returns the value container object for the SimpleResult collection.
  2164. </summary>
  2165. </member>
  2166. <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer">
  2167. <summary>
  2168. Class that contains the VerifiedSimpleResult generated by the verification framework.
  2169. </summary>
  2170. </member>
  2171. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer.#ctor(Cognex.VisionPro.ICogRecord)">
  2172. <summary>
  2173. Constructor using an ICogRecord.
  2174. </summary>
  2175. <param name="record">The ICogRecord to be contained by this object.</param>
  2176. </member>
  2177. <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer.ContainsResultType">
  2178. <summary>
  2179. Method which returns whether or not the "ResultType" SubRecord exists in the contained ICogRecord.
  2180. </summary>
  2181. <returns>Returns true if the contained ICogRecord contains a "ResultType" SubRecord.</returns>
  2182. </member>
  2183. <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer.ResultType">
  2184. <summary>
  2185. Returns the value container object for the ResultType collection.
  2186. </summary>
  2187. </member>
  2188. <member name="T:Cognex.VisionPro.Inspection.CogVerificationStatistics">
  2189. <summary>
  2190. This class holds various statistics that are generated when verification is run.
  2191. </summary>
  2192. </member>
  2193. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTotalCount">
  2194. <summary>
  2195. State flag for the TotalCount property.
  2196. </summary>
  2197. </member>
  2198. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfMatchesCount">
  2199. <summary>
  2200. State flag for the MatchesCount property.
  2201. </summary>
  2202. </member>
  2203. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfMismatchesCount">
  2204. <summary>
  2205. State flag for the MismatchesCount property.
  2206. </summary>
  2207. </member>
  2208. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTrueAcceptCount">
  2209. <summary>
  2210. State flag for the TrueAcceptCount property.
  2211. </summary>
  2212. </member>
  2213. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTrueRejectCount">
  2214. <summary>
  2215. State flag for the TrueRejectCount property.
  2216. </summary>
  2217. </member>
  2218. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfFalseAcceptCount">
  2219. <summary>
  2220. State flag for the FalseAcceptCount property.
  2221. </summary>
  2222. </member>
  2223. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfFalseRejectCount">
  2224. <summary>
  2225. State flag for the FalseRejectCount property.
  2226. </summary>
  2227. </member>
  2228. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfUnknownCount">
  2229. <summary>
  2230. State flag for the UnknownCount property.
  2231. </summary>
  2232. </member>
  2233. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfUndefinedCount">
  2234. <summary>
  2235. State flag for the UndefinedCount property.
  2236. </summary>
  2237. </member>
  2238. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfStartTime">
  2239. <summary>
  2240. State flag for the StartTime property.
  2241. </summary>
  2242. </member>
  2243. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfStopTime">
  2244. <summary>
  2245. State flag for the StopTime property.
  2246. </summary>
  2247. </member>
  2248. <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTotalTime">
  2249. <summary>
  2250. State flag for the TotalTime property.
  2251. </summary>
  2252. </member>
  2253. <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.#ctor">
  2254. <summary>
  2255. Constructor.
  2256. </summary>
  2257. </member>
  2258. <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2259. <summary>
  2260. Serialization Constructor.
  2261. </summary>
  2262. <param name="info">
  2263. Standard SerializationInfo argument.
  2264. </param>
  2265. <param name="context">
  2266. Standard StreamingContext argument.
  2267. </param>
  2268. </member>
  2269. <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.Reset">
  2270. <summary>
  2271. Reset all the statistics to zero (or the equivalent).
  2272. </summary>
  2273. </member>
  2274. <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.InitializeFrom(Cognex.VisionPro.Inspection.CogVerificationStatistics)">
  2275. <summary>
  2276. Initalize this object from the other object. Internal Use Only.
  2277. </summary>
  2278. <param name="other">The other object that will provide the statistics values for this object.</param>
  2279. </member>
  2280. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TotalCount">
  2281. <summary>
  2282. Get and set the total number of items verified.
  2283. </summary>
  2284. </member>
  2285. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.MatchesCount">
  2286. <summary>
  2287. Get and set the number of items that matched after verification has run.
  2288. </summary>
  2289. </member>
  2290. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.MismatchesCount">
  2291. <summary>
  2292. Get and set the number of items that mismatched after verification has run.
  2293. </summary>
  2294. </member>
  2295. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TrueAcceptCount">
  2296. <summary>
  2297. Get and set the number of items that were categorized as true accept after verification has run.
  2298. This statistics is only set when doing comparison with the SimpleResult item.
  2299. </summary>
  2300. </member>
  2301. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TrueRejectCount">
  2302. <summary>
  2303. Get and set the number of items that were categorized as true reject after verification has run.
  2304. This statistics is only set when doing comparison with the SimpleResult item.
  2305. </summary>
  2306. </member>
  2307. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.FalseAcceptCount">
  2308. <summary>
  2309. Get and set the number of items that were categorized as false accept after verification has run.
  2310. This statistics is only set when doing comparison with the SimpleResult item.
  2311. </summary>
  2312. </member>
  2313. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.FalseRejectCount">
  2314. <summary>
  2315. Get and set the number of items that were categorized as false reject after verification has run.
  2316. This statistics is only set when doing comparison with the SimpleResult item.
  2317. </summary>
  2318. </member>
  2319. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.UnknownCount">
  2320. <summary>
  2321. Get and set the number of items that were categorized as unknown after verification has run.
  2322. This statistics is only set when doing comparison with the SimpleResult item.
  2323. </summary>
  2324. </member>
  2325. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.UndefinedCount">
  2326. <summary>
  2327. Get and set the number of items that were categorized as undefined after verification has run.
  2328. This statistics is only set when doing comparison with the SimpleResult item.
  2329. </summary>
  2330. </member>
  2331. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.StartTime">
  2332. <summary>
  2333. Get and set the time when the verification started.
  2334. </summary>
  2335. </member>
  2336. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.StopTime">
  2337. <summary>
  2338. Get and set the time when the verification stopped.
  2339. </summary>
  2340. </member>
  2341. <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TotalTime">
  2342. <summary>
  2343. Get and set the total verification time.
  2344. </summary>
  2345. </member>
  2346. <member name="T:Cognex.VisionPro.Inspection.CogVerificationDataEventArgs">
  2347. <summary>
  2348. This EventArgs object is used by the CogVerificationData class hierarchy when a
  2349. CogVerificationData object needs to be passed as part of firing an event.
  2350. </summary>
  2351. </member>
  2352. <member name="M:Cognex.VisionPro.Inspection.CogVerificationDataEventArgs.#ctor(Cognex.VisionPro.Inspection.CogVerificationData)">
  2353. <summary>
  2354. Constructor that takes a data object.
  2355. </summary>
  2356. <param name="data">Data object to associate with this EventArgs object</param>
  2357. </member>
  2358. <member name="P:Cognex.VisionPro.Inspection.CogVerificationDataEventArgs.Data">
  2359. <summary>
  2360. Get the CogVerificationData object associated with this EventArgs object.
  2361. </summary>
  2362. </member>
  2363. <member name="T:Cognex.VisionPro.Inspection.CogVerificationKeyEventArgs">
  2364. <summary>
  2365. This EventArgs object is used by the CogVerificationData class hierarchy when a
  2366. key string needs to be passed as part of firing an event.
  2367. </summary>
  2368. </member>
  2369. <member name="M:Cognex.VisionPro.Inspection.CogVerificationKeyEventArgs.#ctor(System.String)">
  2370. <summary>
  2371. Constructor that takes a key string.
  2372. </summary>
  2373. <param name="key"></param>
  2374. </member>
  2375. <member name="P:Cognex.VisionPro.Inspection.CogVerificationKeyEventArgs.Key">
  2376. <summary>
  2377. Get the string key associated with this EventArgs object.
  2378. </summary>
  2379. </member>
  2380. <member name="T:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategoryEventArgs">
  2381. <summary>
  2382. This EventArgs object is used by the CogVerificationData class hierarchy when a
  2383. CogAnnotationCategory object needs to be passed as part of firing an event.
  2384. </summary>
  2385. </member>
  2386. <member name="M:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategoryEventArgs.#ctor(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
  2387. <summary>
  2388. Constructor that takes a CogAnnotationCategory object.
  2389. </summary>
  2390. <param name="category"></param>
  2391. </member>
  2392. <member name="P:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategoryEventArgs.Category">
  2393. <summary>
  2394. Get the CogAnnotationCategory object associated with this EventArgs object.
  2395. </summary>
  2396. </member>
  2397. <member name="T:Cognex.VisionPro.Inspection.CogVerificationGradeEventArgs">
  2398. <summary>
  2399. This EventArgs object is used by the CogVerificationDatabase class when a
  2400. grade needs to be passed as part of firing an event.
  2401. </summary>
  2402. </member>
  2403. <member name="M:Cognex.VisionPro.Inspection.CogVerificationGradeEventArgs.#ctor(System.String)">
  2404. <summary>
  2405. Constructor that takes a grade string.
  2406. </summary>
  2407. <param name="grade"></param>
  2408. </member>
  2409. <member name="P:Cognex.VisionPro.Inspection.CogVerificationGradeEventArgs.Grade">
  2410. <summary>
  2411. Get the string grade associated with this EventArgs object.
  2412. </summary>
  2413. </member>
  2414. <member name="T:Cognex.VisionPro.Inspection.CogVerifierRunCompletedEventArgs">
  2415. <summary>
  2416. This EventArg class is used when the verifier fires the RunCompleted event.
  2417. </summary>
  2418. </member>
  2419. <member name="M:Cognex.VisionPro.Inspection.CogVerifierRunCompletedEventArgs.#ctor(System.Exception,System.Boolean,System.Object)">
  2420. <summary>
  2421. </summary>
  2422. <param name="error">The exception if any was thrown during verification, null otherwise.</param>
  2423. <param name="cancelled">True if verification was cancelled, false otherwise.</param>
  2424. <param name="userState">Not used.</param>
  2425. </member>
  2426. <member name="T:Cognex.VisionPro.Inspection.CogVerifierRunProgressChangedEventArgs">
  2427. <summary>
  2428. This EventArg class is used when the verifier fires the RunProgress event.
  2429. </summary>
  2430. </member>
  2431. <member name="M:Cognex.VisionPro.Inspection.CogVerifierRunProgressChangedEventArgs.#ctor(System.Int32,Cognex.VisionPro.Inspection.CogVerificationData,System.Object)">
  2432. <summary>
  2433. </summary>
  2434. <param name="progressPercentage">The percentage the verifier has completed running (0-100).</param>
  2435. <param name="outputData">The output data object that was generated from the last iteration that was completed.</param>
  2436. <param name="userState">Not used.</param>
  2437. </member>
  2438. <member name="P:Cognex.VisionPro.Inspection.CogVerifierRunProgressChangedEventArgs.OutputData">
  2439. <summary>
  2440. Gets the CogVerificationData object associated with this EventArgs object.
  2441. </summary>
  2442. </member>
  2443. </members>
  2444. </doc>