| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Cognex.VisionPro.Inspection</name>
- </assembly>
- <members>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory">
- <summary>
- This class represents an annotation category.
- An annotation category consists of two pieces of information: a name and color.
- Annotation categories are defined and used in the Image Grading Utility.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.SfName">
- <summary>
- State flag for the Name property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.SfColor">
- <summary>
- State flag for Color the property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.SfNextSf">
- <summary>
- Next state flag to be used in derived classes.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.#ctor(System.String,Cognex.VisionPro.CogColorConstants)">
- <summary>
- Constructor for annotation category.
- </summary>
- <param name="name">Name of the annotation category, must be unique.</param>
- <param name="color">The annotation category's color that is used for drawing the graphics</param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.Name">
- <summary>
- Get and set the name of this annotation category.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory.Color">
- <summary>
- Set and set the color of this annotation category.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Range">
- <summary>
- string key of ExpectedOutput's epsilon value
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.RecordVersion_1_0">
- <summary>
- CogRecord structure version identifier 1.0
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Grade">
- <summary>
- RecordKey for CogRecord's AdvancedGrade field name
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ExpectedResult">
- <summary>
- RecordKey for "ExpectedResult" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ActualResult">
- <summary>
- RecordKey for "ActualResult" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ExpectedOutputs">
- <summary>
- RecordKey for "ExpectedOutputs" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ExpectedRunStatus">
- <summary>
- RecordKey for "ExpectedRunStatus" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Inputs">
- <summary>
- RecordKey for "Inputs" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Params">
- <summary>
- RecordKey for "Params" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.Results">
- <summary>
- RecordKey for "Results" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.OverallVerificationResult">
- <summary>
- RecordKey for "OverallVerificationResult" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerificationTimestamp">
- <summary>
- RecordKey for "VerificationTimestamp" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerifiedOutputs">
- <summary>
- RecordKey for "VerifiedOutputs" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerifiedRunStatus">
- <summary>
- RecordKey for "VerifiedRunStatus" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.LastRunRecord">
- <summary>
- RecordKey for "LastRunRecord" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.SimpleResult">
- <summary>
- RecordKey for "SimpleResult" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.VerificationResult">
- <summary>
- RecordKey for "VerificationResult" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.ResultType">
- <summary>
- RecordKey for "ResultType" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.InputImage">
- <summary>
- RecordKey for "InputImage" field
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogFieldNameConstants.NullValueDisplayValue">
- <summary>
- String representation of the value NULL;
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.ICogVerifier">
- <summary>
- Interface for verifier in the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.Run">
- <summary>
- Run the verifier synchronously.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsync">
- <summary>
- Run the verifier asynchronously.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsyncCancel">
- <summary>
- Cancel an asynchronous run of the verifier.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsyncPause">
- <summary>
- Pause an asynchronous run of the verifier.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.RunAsyncResume">
- <summary>
- Resume an asynchronous run of the verifier.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.ICogVerifier.SetupVisionToolInputs(Cognex.VisionPro.Inspection.CogVerificationData,Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Setup the VisionTool's inputs using the specified verificationData object.
- </summary>
- <param name="verificationData"></param>
- <param name="outputData"></param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.InputDatabase">
- <summary>
- Get and set the input database.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.InputDatabaseSubset">
- <summary>
- Get and set the input subset array.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.OutputDatabase">
- <summary>
- Get and set the output database.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.VisionTool">
- <summary>
- Get and set the vision tool under test.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.UnknownResultBehavior">
- <summary>
- Get and set the behavior of the verifier when it encounters an Unknown SimpleResult.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.IsBusy">
- <summary>
- Get the current state of the verifier.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.Statistics">
- <summary>
- Get the statistics object associated with the verifier.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerifier.OutputDatabaseEnable">
- <summary>
- Get and set the flags which control what gets stored into the output database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunStarted">
- <summary>
- Raised when the verifier starts running.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunProgressChanged">
- <summary>
- Raised when the verifier completes one iteration.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunCompleted">
- <summary>
- Raised when the verifier has completely finished running.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunPaused">
- <summary>
- Raised when the verifier is paused.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.ICogVerifier.RunResumed">
- <summary>
- Raised when the verifier is resumed.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationDatabase">
- <summary>
- This class contains an ICogDatabase and adds additional methods that
- are specific to the verification framework. This class should be
- used whenever interacting with a verification database.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.#ctor(Cognex.VisionPro.Database.ICogDatabase)">
- <summary>
- Constructor using the specifed ICogDatabase reference.
- </summary>
- <param name="database">The underlying database object to contain within the newly constructed CogVerificationDatabase.</param>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the specified database is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization constructor.
- </summary>
- <param name="info">Standard SerializationInfo argument.</param>
- <param name="context">Standard StreamingContext argument.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Add(Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Add a new data object to this verification database.
- The data records's key must be unique.
- </summary>
- <param name="newData">The new data object to add.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <event cref="E:Cognex.VisionPro.Inspection.AddingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Inspection.AddedEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Remove(System.String)">
- <summary>
- Removes the specified data object from the verification database.
- </summary>
- <param name="key">The key of the data object to remove.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <event cref="E:Cognex.VisionPro.Inspection.RemovingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Inspection.RemovedEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Replace(Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Replaces data inside the verification database using the specified data.
- The key of the replacementData record is used to find which data object to replace.
- </summary>
- <param name="replacementData">The replacement CogVerificationData.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <event cref="E:Cognex.VisionPro.Inspection.ReplacingEvent">
- Fires at the start of a call to this method.
- </event>
- <event cref="E:Cognex.VisionPro.Inspection.ReplacedEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Fetch(System.String)">
- <summary>
- Create a CogVerificationData that duplicates the item specified
- by the supplied key. Note that a new ICogRecord is
- created every time this method is called.
- </summary>
- <param name="key">Specifies the item to fetch from the database.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <returns>A newly created instance of the requested database item.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Fetch(System.Int32)">
- <summary>
- Create a CogVerificationData that duplicates the item specified
- by the supplied index. Note that a new ICogRecord is
- created every time this method is called.
- </summary>
- <param name="index">This index specifies the item to fetch from the database.
- Indexing is with respect to the list of keys returned by
- the GetKeys method.
- </param>
- <returns>A newly created instance of the requested database item.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
- <summary>
- Adds the specified image to this verification database.
- If the image cannot be loaded, this method stops and throws an exception.
- </summary>
- <param name="imageFilename">The full path to the image to be added.</param>
- <param name="referenceImage">Set this to true if the images should be referenced by their full path.
- Set this to false if the images should be embedded (copied) into the database.
- </param>
- <param name="defaultSimpleResult">The default simple result for all the added images</param>
- <returns>An array of all the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if imageFilanem is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the imageFilename is not found.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the image cannot be added to the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
- <summary>
- Adds the specified image to this verification database.
- If the image cannot be loaded, this method stops and throws an exception.
- </summary>
- <param name="imageFilename">The full path to the image to be added.</param>
- <param name="referenceImage">Set this to true if the images should be referenced by their full path.
- Set this to false if the images should be embedded (copied) into the database.
- </param>
- <param name="defaultSimpleResult">The default simple result for all the added images</param>
- <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>
- <returns>An array of all the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if imageFilanem is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the imageFilename is not found.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the image cannot be added to the database.
- </exception>
- <example>
- <code lang="Visual Basic">
- Imports Cognex.VisionPro
- Imports Cognex.VisionPro.Database
- Imports Cognex.VisionPro.Inspection
-
- Private Sub Init()
- Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
- mInputDatabase.Connect()
- ' Add image to the database with no grade
- mInputDatabase.AddImage("C:\Images\sample.bmp", True, CogVerificationSimpleResultConstants.Accept, "Excellent")
- mInputDatabase.Disconnect()
- End Sub
- </code>
- <code lang="C#">
- using Cognex.VisionPro;
- using Cognex.VisionPro.Database;
- using Cognex.VisionPro.Inspection;
- private Init()
- {
- CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
- mInputDatabase.Connect();
- // Add image to the database with no grade
- mInputDatabase.AddImage(@"C:\Images\sample.bmp",true,CogVerificationSimpleResultConstants.Accept,"Excellent");
- mInputDatabase.Disconnect();
- }
- </code>
- </example>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
- <summary>
- Adds all the images in the specified image directory to this verification database.
- If any image in the image directory cannot be loaded, this method stops and throws an exception.
- </summary>
- <param name="imageDirectory">The full path to the directoy that holds the images to be added.</param>
- <param name="referenceImages">Set this to true if the images should be referenced by their full path.
- Set this to false if the images should be embedded (copied) into the database.
- </param>
- <param name="defaultSimpleResult">The default simple result for all the add images</param>
- <returns>An array of all the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if imageDirectory is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if imageDirectory is not found.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String,System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
- <summary>
- Adds all the images in the specified image directory to this verification database.
- If any image in the image directory cannot be loaded, this method stops and throws an exception.
- </summary>
- <param name="imageDirectory">The full path to the directoy that holds the images to be added.</param>
- <param name="referenceImages">Set this to true if the images should be referenced by their full path.
- Set this to false if the images should be embedded (copied) into the database.
- </param>
- <param name="defaultSimpleResult">The default simple result for all the add images</param>
- <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>
- <returns>An array of all the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if imageDirectory is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if imageDirectory is not found.
- </exception>
- <example>
- <code lang="Visual Basic">
- Imports Cognex.VisionPro
- Imports Cognex.VisionPro.Database
- Imports Cognex.VisionPro.Inspection
-
- Private Sub Init()
- Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
- mInputDatabase.Connect()
- ' Add image to the database with no grade
- mInputDatabase.AddImage("C:\Images", True, CogVerificationSimpleResultConstants.Accept, "Excellent")
- mInputDatabase.Disconnect()
- End Sub
- </code>
- <code lang="C#">
- using Cognex.VisionPro;
- using Cognex.VisionPro.Database;
- using Cognex.VisionPro.Inspection;
- private Init()
- {
- CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
- mInputDatabase.Connect();
- // Add image to the database with no grade
- mInputDatabase.AddImage(@"C:\Images",true,CogVerificationSimpleResultConstants.Accept,"Excellent");
- mInputDatabase.Disconnect();
- }
- </code>
- </example>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String[],System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
- <summary>
- Adds all the images in the specified array to this verification database.
- If any image in the specified array cannot be loaded, this method stops and throws an exception.
- </summary>
- <param name="images">An array that holds the full path to the images to be added.</param>
- <param name="referenceImages">Set this to true if the images should be referenced by their full path.
- Set this to false if the images should be embedded (copied) into the database.
- </param>
- <param name="defaultSimpleResult">The default simple result for all the added images</param>
- <returns>An array of all the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if images is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if images is zero length.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImages(System.String[],System.Boolean,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
- <summary>
- Adds all the images in the specified array to this verification database.
- If any image in the specified array cannot be loaded, this method stops and throws an exception.
- </summary>
- <param name="images">An array that holds the full path to the images to be added.</param>
- <param name="referenceImages">Set this to true if the images should be referenced by their full path.
- Set this to false if the images should be embedded (copied) into the database.
- </param>
- <param name="defaultSimpleResult">The default simple result for all the added images</param>
- <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>
- <returns>An array of all the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if images is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if images is zero length.
- </exception>
- <example>
- <code lang="Visual Basic">
- Imports Cognex.VisionPro
- Imports Cognex.VisionPro.Database
- Imports Cognex.VisionPro.Inspection
-
- Private Sub Init()
- Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
- mInputDatabase.Connect()
- ' Create an array which contains the full path for the images
- Dim images As String() = New String() {"C:\Images\sample1.bmp", "C:\Images\sample2.bmp"}
- ' Add image to the database with no grade
- mInputDatabase.AddImage(images, True, CogVerificationSimpleResultConstants.Accept, "Excellent")
- mInputDatabase.Disconnect()
- End Sub
- </code>
- <code lang="C#">
- using Cognex.VisionPro;
- using Cognex.VisionPro.Database;
- using Cognex.VisionPro.Inspection;
- private Init()
- {
- CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
- mInputDatabase.Connect();
-
- // Create an array which contains the full path for the images
- string[] images = new string[]{@"C:\Images\sample1.bmp",@"C:\Images\sample2.bmp"};
-
- // Add image to the database with no grade
- mInputDatabase.AddImage(images,true,CogVerificationSimpleResultConstants.Accept,"Excellent");
- mInputDatabase.Disconnect();
- }
- </code>
- </example>
- </member>
- <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)">
- <summary>
- Adds the specified image to this verification database.
- If the image cannot be loaded, this method stops and throws an exception.
- </summary>
- <param name="image">The ICogImage object that will be added to tha database</param>
- <param name="referenceImage">Set this to true if the images should be referenced by their full path.
- Set this to false if the images should be embedded (copied) into the database.
- </param>
- <param name="imageFilename">The full path to the image to be added. (only needed if referenceImage is set to true)</param>
- <param name="defaultKey">The value of the record key the CogRecord should be created with</param>
- <param name="defaultGrade">The default grade for the added image</param>
- <param name="imageIndex">The index of the image if it will be a referenced image coming from a container has multimple images inside</param>
- <param name="defaultSimpleResult">The default simple result for the added image</param>
- <returns>A key of the image that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if imageFilanem is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the imageFilename is not found.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the defaultKey is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the image cannot be added to the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
- <summary>
- Adds the specified image to this verification database.
- </summary>
- <param name="image">The ICogImage object that will be added to tha database</param>
- <param name="defaultSimpleResult">The default simple result for the added image</param>
- <returns>A key of the image that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if image is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the image cannot be added to the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage,Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
- <summary>
- Adds the specified image to this verification database.
- </summary>
- <param name="image">The ICogImage object that will be added to tha database</param>
- <param name="defaultSimpleResult">The default simple result for the added image</param>
- <param name="defaultGrade">The default grade for the added image</param>
- <returns>A key of the image that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if image is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the image cannot be added to the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage[],Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants)">
- <summary>
- Adds the specified images to this verification database.
- </summary>
- <param name="images">The array of ICogImage objects that will be added to tha database</param>
- <param name="defaultSimpleResult">The default simple result for all the added images</param>
- <returns>The keys of the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if any of the images is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the image cannot be added to the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddImage(Cognex.VisionPro.ICogImage[],Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants,System.String)">
- <summary>
- Adds the specified images to this verification database.
- </summary>
- <param name="images">The array of ICogImage objects that will be added to tha database</param>
- <param name="defaultSimpleResult">The default simple result for all the added images</param>
- <param name="defaultGrade">The default grade for all the added images</param>
- <returns>The keys of the images that were added to the database.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if any of the images is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the image cannot be added to the database.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetAnnotationCategories">
- <summary>
- Gets all the annotation categories in this verification database.
- </summary>
- <returns>An array of defined annotation categories.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddAnnotationCategory(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
- <summary>
- Adds the specified annotatation category to the database.
- </summary>
- <param name="newAnnotationCategory">The new annotation category to add.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if newAnnotationCategory Name is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if newAnnotationCategory Name is not unique.
- </exception>
- <event cref="E:Cognex.VisionPro.Inspection.AddedAnnotationCategoryEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemoveAnnotationCategory(System.String)">
- <summary>
- Removes the specified annotation category definition from the verification database.
- Note, this method does not remove any defined defects using the removed category, it
- just removes the definition of the annotation category. Users wanting to remove any
- defects using the removed annotation category need to do this themselves manually.
- </summary>
- <param name="annotationCategoryToRemove">Annotation category to remove.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if annoationCategoryToRemove is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if annoationCategoryToRemove not found.
- </exception>
- <event cref="E:Cognex.VisionPro.Inspection.RemovedAnnotationCategoryEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetGrades">
- <summary>
- Gets all the grades in this verification database.
- </summary>
- <returns>An array of defined string grades.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddGrade(System.String)">
- <summary>
- Adds the specified grade to the database.
- </summary>
- <param name="newGrade">The new grade to add.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if newGrade is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if newGrade is not unique.
- </exception>
- <event cref="E:Cognex.VisionPro.Inspection.AddedGradeEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemoveGrade(System.String)">
- <summary>
- Removes the specified string grade from the verification database.
- Note, this method does not remove any set grades from individual records, it
- just removes the grade from the list of possible grades. Users wanting to remove the
- grade from any database record need to do this themselves.
- </summary>
- <param name="gradeToRemove">Grade to remove.</param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if gradeToRemove is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Thrown if gradeToRemove not found.
- </exception>
- <event cref="E:Cognex.VisionPro.Inspection.RemovedGradeEvent">
- Fires at the end of a call to this method.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetStatistics">
- <summary>
- Gets the statistics object from this database.
- </summary>
- <returns>A reference to the statistics object.</returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.SetStatistics(Cognex.VisionPro.Inspection.CogVerificationStatistics)">
- <summary>
- Sets the statistics object for this database. Internal use only.
- </summary>
- <param name="newStatistics"></param>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Connect">
- <summary>
- Connect to the underlying ICogDatabase.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Disconnect">
- <summary>
- Disconnect from the underlying contained ICogDatabase.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.Clear">
- <summary>
- Clear the underlying contained ICogDatabase.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAdding(Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Raise the Adding event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAdded(Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Raise the Added event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemoving(System.String)">
- <summary>
- Raise the Removing event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemoved(System.String)">
- <summary>
- Raise the Removed event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnReplacing(Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Raise the Replacing event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnReplaced(Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Raise the Replaced event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnClearing">
- <summary>
- Raise the Clearing event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnCleared">
- <summary>
- Raise the Cleared event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAddedAnnotationCategory(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
- <summary>
- Raise the AddedAnnotationCategory event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemovedAnnotationCategory(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
- <summary>
- Raise the RemovedAnnotationCategory event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnAddedGrade(System.String)">
- <summary>
- Raise the AddedAnnotationCategory event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnRemovedGrade(System.String)">
- <summary>
- Raise the RemovedAnnotationCategory event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.OnStatisticsSet">
- <summary>
- Raise the StatisticsSet event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.GetEnumerator">
- <summary>
- Create a strongly typed enumerator to facilitate
- iterating through the items in this database. Note that
- enumerators are fragile - externally adding or removing items
- from this database will invalidate the enumerator. Also note
- that modifying a CogVerificationData returned by (the Current property of)
- this enumerator will have absolutely no affect on the database
- since it is a freshly created copy of the database item, just
- as with the Fetch method.
- </summary>
- <returns>
- An enumerator whose Current property is of type CogVerificationData.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Create a strongly typed enumerator to facilitate
- iterating through the items in this database. Note that
- enumerators are fragile - externally adding or removing items
- from this database will invalidate the enumerator. Also note
- that modifying a CogVerificationData returned by (the Current property of)
- this enumerator will have absolutely no affect on the database
- since it is a freshly created copy of the database item, just
- as with the Fetch method.
- </summary>
- <returns>
- An enumerator whose Current property is of type Object.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- Thrown if not currently connected.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationDatabase.Database">
- <summary>
- Get the unerlying contained ICogDatabase object.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Adding">
- <summary>
- Raised before adding data to the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Added">
- <summary>
- Raised after data has been added to the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Removing">
- <summary>
- Raised before removing data from the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Removed">
- <summary>
- Raised after data has been removed from the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Replacing">
- <summary>
- Raised before replacing data in the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Replaced">
- <summary>
- Raised after data has been replaced in the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Clearing">
- <summary>
- Raised before clearing the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.Cleared">
- <summary>
- Raised after the verification database has been cleared.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddedAnnotationCategory">
- <summary>
- Raised after an annotation category has been added to the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemovedAnnotationCategory">
- <summary>
- Raised after an annotation category has been removed from the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.AddedGrade">
- <summary>
- Raised after a grade has been added to the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.RemovedGrade">
- <summary>
- Raised after a grade has been removed from the verification database.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerificationDatabase.StatisticsSet">
- <summary>
- Raised after a statistics object has been set for the verification database.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.#ctor(Cognex.VisionPro.Inspection.CogVerificationDatabase)">
- <summary>
-
- </summary>
- <param name="database"></param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.MoveNext">
- <summary>
-
- </summary>
- <returns></returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Reset">
- <summary>
-
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Dispose">
- <summary>
-
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Dispose(System.Boolean)">
- <summary>
-
- </summary>
- <param name="bDisposing"></param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.Current">
- <summary>
-
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationDatabase.CogVerificationDatabaseEnumerator.System#Collections#IEnumerator#Current">
- <summary>
-
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogImageReferenceRecord">
- <summary>
- This class is used to implement a CogRecord that references an image instead of
- embedding. The image is referenced via a full path and index (if the referenced image
- contains multiple images).
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogImageReferenceRecord.SfImageFilename">
- <summary>
- This bit will be set in the EventArgs of a Changed event every
- time the value returned by ImageFilename may have changed.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogImageReferenceRecord.CheckImageFilename">
- <summary>
- Verifies that the referenced image exists. If there is a problem loading the image,
- an exception is thrown, otherwise this method just returns.
- </summary>
- <exception cref="T:System.ArgumentNullException">
- Thrown if the ImageFilename is null.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Thrown if the ImageIndex is out of range.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogImageReferenceRecord.Content">
- <summary>
- Gets the record's content. This is a read-only property, even though it has a setter.
- </summary>
- <value>The record's content.</value>
- /// <exception cref="T:System.InvalidOperationException">
- Thrown if the setter of this property is called.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogImageReferenceRecord.ImageFilename">
- <summary>
- Get/set the filename of the referenced image.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogImageReferenceRecord.ImageIndex">
- <summary>
- Get/set the image index, if the referenced image is a multi-image container.
- Default unitialized value is -1, but should be set to zero in the constructor if the index is not used.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants">
- <summary>
- This enumeration holds the expected value for the VisionTool.RunStatus.Result property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants.Accept">
- <summary>
- The expected RunStatus.Result from the Vision Tool is Accept.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants.Reject">
- <summary>
- The expected RunStatus.Result from the Vision Tool is Reject.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationSimpleResultConstants.Unknown">
- <summary>
- The expected RunStatus.Result from the Vision Tool is Unknown.
- The verifier has a property called UnknownResultBehavior which controls what happens during
- verification when this enumeration is encountered.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationUnknownResultBehaviorConstants">
- <summary>
- This enumeration is used by the verifier's UnknownResultBehavior property to control what the
- result of the verification when the CogVerificationSimpleResultConstants.Unknown is encountered.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationUnknownResultBehaviorConstants.AlwaysMismatch">
- <summary>
- Always fail/mismatch the verification.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationUnknownResultBehaviorConstants.AlwaysMatch">
- <summary>
- Always pass/match the verification.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants">
- <summary>
- This enumeration is the ResultType category for verification results.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.TrueAccept">
- <summary>
- The expected result was Accept and the actual result from the VisionTool was Accept.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.TrueReject">
- <summary>
- The expected result was Reject and the actual result from the VisionTool was Reject.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.FalseAccept">
- <summary>
- The expected result was Reject and the actual result from the VisionTool was Accept.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.FalseReject">
- <summary>
- The expected result was Accept and the actual result from the VisionTool was Reject.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.UnknownAlwaysMatch">
- <summary>
- The expected result was Unknown and the verifier's UnknownResultBehavior property was set to AlwaysMismatch.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.UnknownAlwaysMismatch">
- <summary>
- The expected result was Unknown and the verifier's UnknownResultBehavior property was set to AlwaysMatch.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationResultTypeConstants.Undefined">
- <summary>
- The VisionTool's result was either Warning or Error.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants">
- <summary>
- This enumeration is a set of OR-able flags that control what gets stored into the output database.
- when the verifier is running.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants.None">
- <summary>
- None of the user controllable data is stored into the output database.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants.StoreLastRunRecord">
- <summary>
- The LastRunRecord is stored into the output database.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationOutputDatabaseEnableConstants.All">
- <summary>
- All user controllable data is stored into the output database.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerifierBasic">
- <summary>
- This class is an implementation of the ICogVerifier interface. This class
- takes as input an input database, an output database, and a CogToolBlock under test. After given
- these inputs, this verifier goes through the input database, setting up inputs to
- the CogToolBlock, runs the CogToolBlock, and then compares the expected values in the input
- database to the actaul values generated by the CogToolBlock. The results of this comparison is
- finally stored in the output database.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfInputDatabase">
- <summary>
- State flag for the InputDatabase property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfOutputDatabase">
- <summary>
- State flag for the OutputDatabase property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfVisionTool">
- <summary>
- State flag for the VisionTool property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfInputDatabaseSubset">
- <summary>
- State flag for the InputDatabaseSubset property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfUnknownResultBehavior">
- <summary>
- State flag for the UnknownResultBehavior property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerifierBasic.SfOutputDatabaseEnable">
- <summary>
- State flag for the OutputDatabaseEnable property.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.#ctor">
- <summary>
- Default constructor. You will need to provide the vision tool (CogToolBlock), input database, and output database
- via the properties on this class if you use this constructor.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.#ctor(Cognex.VisionPro.ICogTool,Cognex.VisionPro.Inspection.CogVerificationDatabase,Cognex.VisionPro.Inspection.CogVerificationDatabase)">
- <summary>
- Constructor which takes all necessary inputs to the verifier.
- </summary>
- <param name="visionTool">The CogToolBlock under test.</param>
- <param name="inputDatabase">The input database where the golden/known results are stored.</param>
- <param name="outputDatabase">The output database where the results of the verification will be stored.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization Constructor.
- </summary>
- <param name="info">
- Standard SerializationInfo argument.
- </param>
- <param name="context">
- Standard StreamingContext argument.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.Run">
- <summary>
- Runs the verifier synchronously. This method will block until the entire input database is iterated over.
- This method should not be called from a GUI callback handler (such as a button click handler)
- since it can take a very long time to run. Please use the RunAsync() method instead (and subscribe
- to the various verifier events).
- </summary>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is already running.</exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsync">
- <summary>
- Runs the verifier asynchronously. As the verifier runs, various events are fired which
- the user should be subscribed to.
- </summary>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is already running.</exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsyncCancel">
- <summary>
- Cancels an asynchronous run of the verifier.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsyncPause">
- <summary>
- Pauses an asynchronous run of the verifier.
- </summary>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is currently idle.</exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.RunAsyncResume">
- <summary>
- Resumes a currently paused verifier.
- </summary>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is not paused.</exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.SetupVisionToolInputs(Cognex.VisionPro.Inspection.CogVerificationData,Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Sets up the various inputs on the CogToolBlock from the specified data object.
- </summary>
- <param name="verificationData">The data object that contains the inputs to the CogToolBlock</param>
- <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>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunStarted">
- <summary>
- Raise the RunStarted event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunCompleted(System.Exception,System.Boolean,System.Object)">
- <summary>
- Raise the RunCompleted event.
- </summary>
- <param name="error">The exception if any was thrown during verification, null otherwise.</param>
- <param name="cancelled">True if verification was cancelled, false otherwise.</param>
- <param name="userState">Not used.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunProgress(System.Int32,Cognex.VisionPro.Inspection.CogVerificationData,System.Object)">
- <summary>
- Raise the RunProgress event.
- </summary>
- <param name="progressPercentage">The percentage the verifier has completed running (0-100).</param>
- <param name="outputData">The output data object that was generated from the last iteration that was completed.</param>
- <param name="userState">Not used.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunPaused">
- <summary>
- Raise the RunPaused event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierBasic.OnRunResumed">
- <summary>
- Raise the RunResumed event.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.InputDatabase">
- <summary>
- Get and set the input database.
- </summary>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.InputDatabaseSubset">
- <summary>
- Get and set the subset of keys that the verifier should run against. The specified
- keys must exist in the input database, otherwise the verifier will thrown an exception
- during runtime.
- </summary>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.OutputDatabase">
- <summary>
- Get and set the output database where the results of verification will be stored.
- </summary>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.VisionTool">
- <summary>
- Get and set the CogToolBlock under test. Note, the type of this property is ICogTool, but
- the input must be of type CogToolBlock.
- </summary>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.UnknownResultBehavior">
- <summary>
- Get and set the behavior of the verifier (either match or mismatch) when an Unknown SimpleResult is encountered.
- </summary>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.IsBusy">
- <summary>
- Get the current state of the verifier. Returns true if the verifier is busy, otherwise returns false.
- No properties can be changed when the verifier is busy.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.Statistics">
- <summary>
- Get the statistics object associated with this verifier object.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierBasic.OutputDatabaseEnable">
- <summary>
- Get and set the various flags that control what gets stored into the output database when the
- verifier runs.
- </summary>
- <event cref="E:Cognex.VisionPro.ChangedEvent">
- Fires when this property changes.
- </event>
- <exception cref="T:System.InvalidOperationException">Thrown if the verifier is busy.</exception>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunStarted">
- <summary>
- Raised when the verifier starts running.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunProgressChanged">
- <summary>
- Raised when the verifier completes one iteration.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunCompleted">
- <summary>
- Raised when the verifier has completely finished running.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunPaused">
- <summary>
- Raised when the verifier is paused.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.Inspection.CogVerifierBasic.RunResumed">
- <summary>
- Raised when the verifier is resumed.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation">
- <summary>
- Class that defines a image annotation in the verification framework.
- An image annotation is a graphic (rectangle) that encompasses some region of interest on an image.
- The image annotation also has additional information associated with it including a unique name, a category, and a free form description string.
- 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.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfAnnotationName">
- <summary>
- State flag for the AnnotationName property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfCategory">
- <summary>
- State flag for Category the property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfDescription">
- <summary>
- State flag for Description the property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfGraphic">
- <summary>
- State flag for Graphic the property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.SfNextSf">
- <summary>
- Next state flag to be used in derived classes.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.#ctor(System.String,System.String,System.String,Cognex.VisionPro.ICogGraphicInteractive)">
- <summary>
- Constructor for an image annotation
- </summary>
- <param name="annotationName">The name of the image annotation, must be unique</param>
- <param name="category">The category for the image annotation.</param>
- <param name="description">A free form description of the image annotation</param>
- <param name="graphic">A graphic that encompasses a region on an image. The derived type must be of type CogRectangle.</param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.AnnotationName">
- <summary>
- Get and set the annotation name.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.Category">
- <summary>
- Get and set the annotation category.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.Description">
- <summary>
- Get and set the description of this annotation.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationImageAnnotation.Graphic">
- <summary>
- Get and set the annotation graphic. Note, this graphic must be of type CogRectangle.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.ICogVerificationData">
- <summary>
- Interface for data which is contained inside a verification database
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.ICogVerificationData.Record">
- <summary>
- Returns the contained ICogRecord.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">
- <summary>
- Invalid structure exception class.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogInvalidStructureException.#ctor(System.String)">
- <summary>
- Constructor which takes an human readable string that states what went wrong.
- </summary>
- <param name="message"></param>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationRecordContainer">
- <summary>
- Non-change event implementation of ICogVerificationData.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationRecordContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationRecordContainer.Contains(System.String)">
- <summary>
- Returns a boolean if the specified SubRecord (via key parameter) is contained in the record this class holds.
- </summary>
- <param name="key">A string which is the key to be search for in the contained record.</param>
- <returns>True if the contained record contains key, false otherwise.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationRecordContainer.Record">
- <summary>
- Returns the contained ICogRecord.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer">
- <summary>
- Change event implementation of ICogVerificationData.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer.Contains(System.String)">
- <summary>
- Returns a boolean if the specified SubRecord (via key parameter) is contained in the record this class holds.
- </summary>
- <param name="key">A string which is the key to be search for in the contained record.</param>
- <returns></returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationChangedRecordContainer.Record">
- <summary>
- Returns the contained ICogRecord
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1">
- <summary>
- Container class that provides generic type Value API.
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1.SfValue">
- <summary>
- This bit will be set in the EventArgs of a Changed event every
- time the value returned by Value may have changed.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationValueContainer`1.Value">
- <summary>
- Get and set the Contents of the ICogRecord that is contained in this object.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1">
- <summary>
- Container class for verified output results.
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ContainsVerificationResult">
- <summary>
- Method which returns whether or not the "VerificationResult" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "VerificationResult" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ContainsActualResult">
- <summary>
- Method which returns whether or not the "ActualResult" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "ActualResult" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ContainsExpectedResult">
- <summary>
- Method which returns whether or not the "Expected" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Expected" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.VerificationResult">
- <summary>
- Get the verification result for this verified output.
- The verification result is a boolean that indicates if the expected value matched the actual value.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ActualResult">
- <summary>
- Get the actual result from the vision tool under test for this verified output.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputContainer`1.ExpectedResult">
- <summary>
- Get the expected result from the vision tool under test for this verified output.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationData">
- <summary>
- Data class that contains all attributes, params, and results used and generated by the verifier.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.#ctor(System.String)">
- <summary>
- Constructor using a key. A brand new CogRecord is constructed using the specified key.
- All necessary SubRecords necessary for use with the verification framework are added to the new CogRecord.
- </summary>
- <param name="key">The key that is used by the contained ICogRecord.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.ContainsAttributes">
- <summary>
- Method which returns whether or not the "Attributes" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Attributes" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.ContainsParams">
- <summary>
- Method which returns whether or not the "Params" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Params" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.ContainsResults">
- <summary>
- Method which returns whether or not the "Results" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Results" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationData.CheckStructure">
- <summary>
- Checks the structure of the contained ICogRecord to make sure that it contains the necessary SubRecords for use in the verification framework.
- This method will throw various exceptions describing any found errors. This method does not check the "Results" SubRecord since it may not be present.
- If no errors are found, no exception is thrown and this method just returns.
- </summary>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record is null.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record's key is null.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.CreationTimestamp SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.Description SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.Name SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Attributes.Version SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedOutputs SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedRunStatus SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.Inputs SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedRunStatus.SimpleResult SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record does not have the Params.ExpectedOutputs.Grade SubRecord.</exception>
- <exception cref="T:Cognex.VisionPro.Inspection.CogInvalidStructureException">Thrown if the contained record's InputImage SubRecord is invalid.</exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationData.Attributes">
- <summary>
- Returns the container object for the Attributes collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationData.Params">
- <summary>
- Returns the container object for the Params collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationData.Results">
- <summary>
- Returns the container object for the Results collection.
- Note, only data objects that are outputs from the verifier will have this collection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer">
- <summary>
- Class that contains all attributes used by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsName">
- <summary>
- Method which returns whether or not the "Name" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Name" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsDescription">
- <summary>
- Method which returns whether or not the "Description" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Description" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsVersion">
- <summary>
- Method which returns whether or not the "Version" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.ContainsCreationTimestamp">
- <summary>
- Method which returns whether or not the "CreationTimestamp" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "CreationTimestamp" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.Name">
- <summary>
- Returns the value container object for the Name collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.Description">
- <summary>
- Returns the value container object for the Description collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.Version">
- <summary>
- Returns the value container object for the Version collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationAttributesContainer.CreationTimestamp">
- <summary>
- Returns the value container object for the CreationTimestamp collection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsContainer">
- <summary>
- Class that contains all params used by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ContainsInputs">
- <summary>
- Method which returns whether or not the "Inputs" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Inputs" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ContainsExpectedOutputs">
- <summary>
- Method which returns whether or not the "ExpectedOutputs" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "ExpectedOutputs" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ContainsExpectedRunStatus">
- <summary>
- Method which returns whether or not the "ExpectedRunStatus" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "ExpectedRunStatus" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.Inputs">
- <summary>
- Returns the container object for the Inputs collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ExpectedOutputs">
- <summary>
- Returns the container object for the ExpectedOutputs collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsContainer.ExpectedRunStatus">
- <summary>
- Returns the container object for the ExpectedRunStatus collection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer">
- <summary>
- Class that contains inputs used by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.ContainsInputImage">
- <summary>
- Method which returns whether or not the "InputImage" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "InputImage" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.Add(System.String,System.Object)">
- <summary>
- Adds an input record with the given key and inputValue to the record.
- </summary>
- <param name="key">The key to be added to the record's Inputs parameters. The key has to be unique</param>
- <param name="inputValue">The value to be assigned with the given key</param>
- <exception cref="T:Exception">Thrown if the key is not unique.</exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.Remove(System.String)">
- <summary>
- Removes subrecord with the given key from this record.
- </summary>
- <param name="key">The key of the subrecord to remove</param>
- <exception cref="T:Exception">Thrown if the key is null.</exception>
- <exception cref="T:Exception">Thrown if the key is not found.</exception>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.InputImage">
- <summary>
- Returns the container object for the InputImage collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsInputsContainer.Keys">
- <summary>
- Gets all the expected keys added to this record.
- Returns null if there are no records.
- Note: this will always return at least string[] { "InputImage" } since that was added to the records by default.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer">
- <summary>
- Class that contains the InputImage used by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.GetImageAnnotations">
- <summary>
- Gets all the annotations associated with this InputImage.
- </summary>
- <returns>An array of image annotations</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.AddImageAnnotation(Cognex.VisionPro.Inspection.CogVerificationImageAnnotation)">
- <summary>
- Adds the specified annotation to this InputImage.
- </summary>
- <param name="annotation">The annotation to be added.</param>
- <exception cref="T:System.ArgumentException">Thrown if the new annotation name is not unique.</exception>
- <exception cref="T:System.ArgumentException">Thrown if the new annotation graphic is not a CogRectangle.</exception>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationInputImageContainer.RemoveImageAnnotation(System.String)">
- <summary>
- Removes the specified annotation from this InputImage.
- </summary>
- <param name="annotationName">The name of the annotation to remove</param>
- <exception cref="T:System.ArgumentException">Thrown if the specified annotation name is not found.</exception>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer">
- <summary>
- Class that contains the ExpectedOutputs used by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.ContainsGrade">
- <summary>
- Method which returns whether or not the "Grade" SubRecord exists in the contained ICogRecord. Internal Use Only.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Grade" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Add(System.String,System.Object)">
- <summary>
- Adds an expected output with the given key and expectedValue to the record.
- </summary>
- <param name="key">The key to be added to the Record's ExpectedOutput parameters. The key has to be unique</param>
- <param name="expectedValue">The value to be assigned with the given key</param>
- <exception cref="T:Exception">Thrown if the key is not unique.</exception>
- <example>
- <code lang="Visual Basic">
- Imports Cognex.VisionPro
- Imports Cognex.VisionPro.Database
- Imports Cognex.VisionPro.Inspection
- Private Sub AddProperty()
- Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
- mInputDatabase.Connect()
- Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
- ' Add additional property to the record with the name "Area" and a value of 3.1415
- mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415)
- ' Change the additional property "Area"
- mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords("Area").Content = 2.7182
- ' Update the record in the database
- mInputDatabase.Replace(mCurrentRecord)
- mInputDatabase.Disconnect()
- End Sub
- </code>
- <code lang="C#">
- using Cognex.VisionPro;
- using Cognex.VisionPro.Database;
- using Cognex.VisionPro.Inspection;
- private AddProperty()
- {
- CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
- mInputDatabase.Connect();
- CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
- // Add additional property to the record with the name "Area" and a value of 3.1415
- mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415);
- // Change the additional property "Area"
- mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords["Area"].Content = 2.7182;
-
- // Update the record in the database
- mInputDatabase.Replace(mCurrentRecord);
- mInputDatabase.Disconnect();
- }
- </code>
- </example>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Add(System.String,System.Double,System.Double)">
- <summary>
- Adds an expected output with the given key, an expectedValue and a range to the record.
- </summary>
- <param name="key">The key to be added to the Record's ExpectedOutput parameters. The key has to be unique</param>
- <param name="expectedValue">The value to be assigned with the given key</param>
- <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>
- <exception cref="T:Exception">Thrown if the key is not unique.</exception>
- <example>
- <code lang="Visual Basic">
- Imports Cognex.VisionPro
- Imports Cognex.VisionPro.Database
- Imports Cognex.VisionPro.Inspection
-
- Private Sub AddProperty()
- Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
- mInputDatabase.Connect()
- Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
- ' Add additional property to the record with the name "Area", a value of 3.1415 and a range of +-0.5
- mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415, 0.5)
- ' Change the additional property "Area"
- mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords("Area").Content = 2.7182
- ' Change the range for the additional property "Area"
- ' WARNING: Works only if the additional property was created with a range
- mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords("Area").SubRecords(CogFieldNameConstants.RkRange).Content = 0.2
- ' Update the record in the database
- mInputDatabase.Replace(mCurrentRecord)
- mInputDatabase.Disconnect()
- End Sub
- </code>
- <code lang="C#">
- using Cognex.VisionPro;
- using Cognex.VisionPro.Database;
- using Cognex.VisionPro.Inspection;
- private AddProperty()
- {
- CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
- mInputDatabase.Connect();
- CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
- // Add additional property to the record with the name "Area", a value of 3.1415 and a range of +-0.5
- mCurrentRecord.Params.ExpectedOutputs.Add("Area", 3.1415 , 0.5);
- // Change the additional property "Area"
- mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords["Area"].Content = 2.7182;
-
- // Change the range for the additional property "Area"
- // WARNING: Works only if the additional property was created with a range
- mCurrentRecord.Params.ExpectedOutputs.Record.SubRecords["Area"].SubRecords[CogFieldNameConstants.RkRange].Content = 0.2;
-
- // Update the record in the database
- mInputDatabase.Replace(mCurrentRecord);
- mInputDatabase.Disconnect();
- }
- </code>
- </example>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Remove(System.String)">
- <summary>
- Removes subrecord with the given key from this record.
- </summary>
- <param name="key">The key of the subrecord to remove</param>
- <exception cref="T:Exception">Thrown if the key is null.</exception>
- <exception cref="T:Exception">Thrown if the key is not found.</exception>
- <example>
- <code lang="Visual Basic">
- Imports Cognex.VisionPro
- Imports Cognex.VisionPro.Database
- Imports Cognex.VisionPro.Inspection
-
- Private Sub New()
- Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
- mInputDatabase.Connect()
- Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
- ' Remove additional property "Area" from the record
- mCurrentRecord.Params.ExpectedOutputs.Remove("Area")
- ' Update the record in the database
- mInputDatabase.Replace(mCurrentRecord)
- mInputDatabase.Disconnect()
- End Sub
- </code>
- <code lang="C#">
- using Cognex.VisionPro;
- using Cognex.VisionPro.Database;
- using Cognex.VisionPro.Inspection;
- private RemoveProperty()
- {
- CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
- mInputDatabase.Connect();
- CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
- // Remove additional property "Area" from the record
- mCurrentRecord.Params.ExpectedOutputs.Remove("Area");
- // Update the record in the database
- mInputDatabase.Replace(mCurrentRecord);
- mInputDatabase.Disconnect();
- }
- </code>
- </example>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.AddExpectedBase(System.String,System.Object)">
- <summary>
- Adds an expected output with the given key and expectedValue.
- </summary>
- <param name="key">The key to be added to the Record's ExpectedOutput parameters. The key has to be unique</param>
- <param name="expectedValue">The value to be assigned with the given key</param>
- <exception cref="T:Exception">Thrown if the key is not unique.</exception>
- <returns>Returns the created ICogRecord</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Grade">
- <summary>
- Returns the value container object for the Grade collection.
- </summary>
- <example>
- <code lang="Visual Basic">
- Imports Cognex.VisionPro
- Imports Cognex.VisionPro.Database
- Imports Cognex.VisionPro.Inspection
- Private Sub SetGrade()
- Dim mInputDatabase As New CogVerificationDatabase(New CogDatabaseDirectory("C:\SampleDatabase"))
- mInputDatabase.Connect()
- Dim mCurrentRecord As CogVerificationData = mInputDatabase.Fetch(0)
- ' The grade which will be added
- Dim grade As String = "Good"
- ' Step one: add this grade to the metadata
- ' WARNING: If the metadata already contains this grade an exception will be thrown.
- mInputDatabase.AddGrade(grade)
- ' Step two: set the record's grade
- mCurrentRecord.Params.ExpectedOutputs.Grade.Value = grade
- ' Update the record in the database
- mInputDatabase.Replace(mCurrentRecord)
- mInputDatabase.Disconnect()
- End Sub
- </code>
- <code lang="C#">
- using Cognex.VisionPro;
- using Cognex.VisionPro.Database;
- using Cognex.VisionPro.Inspection;
- private SetGrade()
- {
- CogVerificationDatabase mInputDatabase = new CogVerificationDatabase(new CogDatabaseDirectory(@"C:\SampleDatabase"));
- mInputDatabase.Connect();
- CogVerificationData mCurrentRecord = mInputDatabase.Fetch(0);
- // The grade which will be added
- string grade = "Good";
- // Step one: add this grade to the metadata
- // WARNING: If the metadata already contains this grade an exception will be thrown.
- mInputDatabase.AddGrade(grade);
- // Step two: set the record's grade
- mCurrentRecord.Params.ExpectedOutputs.Grade.Value = grade;
- // Update the record in the database
- mInputDatabase.Replace(mCurrentRecord);
- mInputDatabase.Disconnect();
- }
- </code>
- </example>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedOutputsContainer.Keys">
- <summary>
- Gets all the expected keys added to this record.
- Returns null if there are no records.
- Note: this will always return at least string[] { "Grade" } since that was added to the records by default.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer">
- <summary>
- Class that contains the ExpectedRunStatus used by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer.ContainsSimpleResult">
- <summary>
- Method which returns whether or not the "SimpleResult" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "SimpleResult" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationParamsExpectedRunStatusContainer.SimpleResult">
- <summary>
- Returns the value container object for the SimpleResult collection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationResultsContainer">
- <summary>
- Class that contains the results used and generated by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsOverallVerificationResult">
- <summary>
- Method which returns whether or not the "OverallVerificationResult" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "OverallVerificationResult" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsVerificationTimestamp">
- <summary>
- Method which returns whether or not the "VerificationTimestamp" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "VerificationTimestamp" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsVerifiedOutputs">
- <summary>
- Method which returns whether or not the "VerifiedOutputs" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "VerifiedOutputs" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsVerifiedRunStatus">
- <summary>
- Method which returns whether or not the "VerifiedRunStatus" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "VerifiedRunStatus" SubRecord.</returns>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.ContainsLastRunRecord">
- <summary>
- Method which returns whether or not the "LastRunRecord" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "LastRunRecord" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.OverallVerificationResult">
- <summary>
- Returns the value container object for the OverallVerificationResult collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.VerificationTimestamp">
- <summary>
- Returns the value container object for the VerificationTimestamp collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.VerifiedOutputs">
- <summary>
- Returns the container object for the VerifiedOutputs collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.VerifiedRunStatus">
- <summary>
- Returns the container object for the VerifiedRunStatus collection.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationResultsContainer.LastRunRecord">
- <summary>
- Returns the container object for the LastRunRecord collection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer">
- <summary>
- Class that contains the VerifiedOutputs generated by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer.ContainsGrade">
- <summary>
- Method which returns whether or not the "Grade" SubRecord exists in the contained ICogRecord. Internal Use Only.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "Grade" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedOutputsContainer.Grade">
- <summary>
- Returns the value container object for the Grade collection. Internal Use Only.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer">
- <summary>
- Class that contains the VerifiedRunStatus generated by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer.ContainsSimpleResult">
- <summary>
- Method which returns whether or not the "SimpleResult" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "SimpleResult" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedRunStatusContainer.SimpleResult">
- <summary>
- Returns the value container object for the SimpleResult collection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer">
- <summary>
- Class that contains the VerifiedSimpleResult generated by the verification framework.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer.#ctor(Cognex.VisionPro.ICogRecord)">
- <summary>
- Constructor using an ICogRecord.
- </summary>
- <param name="record">The ICogRecord to be contained by this object.</param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer.ContainsResultType">
- <summary>
- Method which returns whether or not the "ResultType" SubRecord exists in the contained ICogRecord.
- </summary>
- <returns>Returns true if the contained ICogRecord contains a "ResultType" SubRecord.</returns>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationVerifiedSimpleResultContainer.ResultType">
- <summary>
- Returns the value container object for the ResultType collection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationStatistics">
- <summary>
- This class holds various statistics that are generated when verification is run.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTotalCount">
- <summary>
- State flag for the TotalCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfMatchesCount">
- <summary>
- State flag for the MatchesCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfMismatchesCount">
- <summary>
- State flag for the MismatchesCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTrueAcceptCount">
- <summary>
- State flag for the TrueAcceptCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTrueRejectCount">
- <summary>
- State flag for the TrueRejectCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfFalseAcceptCount">
- <summary>
- State flag for the FalseAcceptCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfFalseRejectCount">
- <summary>
- State flag for the FalseRejectCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfUnknownCount">
- <summary>
- State flag for the UnknownCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfUndefinedCount">
- <summary>
- State flag for the UndefinedCount property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfStartTime">
- <summary>
- State flag for the StartTime property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfStopTime">
- <summary>
- State flag for the StopTime property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.Inspection.CogVerificationStatistics.SfTotalTime">
- <summary>
- State flag for the TotalTime property.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.#ctor">
- <summary>
- Constructor.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization Constructor.
- </summary>
- <param name="info">
- Standard SerializationInfo argument.
- </param>
- <param name="context">
- Standard StreamingContext argument.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.Reset">
- <summary>
- Reset all the statistics to zero (or the equivalent).
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationStatistics.InitializeFrom(Cognex.VisionPro.Inspection.CogVerificationStatistics)">
- <summary>
- Initalize this object from the other object. Internal Use Only.
- </summary>
- <param name="other">The other object that will provide the statistics values for this object.</param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TotalCount">
- <summary>
- Get and set the total number of items verified.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.MatchesCount">
- <summary>
- Get and set the number of items that matched after verification has run.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.MismatchesCount">
- <summary>
- Get and set the number of items that mismatched after verification has run.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TrueAcceptCount">
- <summary>
- Get and set the number of items that were categorized as true accept after verification has run.
- This statistics is only set when doing comparison with the SimpleResult item.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TrueRejectCount">
- <summary>
- Get and set the number of items that were categorized as true reject after verification has run.
- This statistics is only set when doing comparison with the SimpleResult item.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.FalseAcceptCount">
- <summary>
- Get and set the number of items that were categorized as false accept after verification has run.
- This statistics is only set when doing comparison with the SimpleResult item.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.FalseRejectCount">
- <summary>
- Get and set the number of items that were categorized as false reject after verification has run.
- This statistics is only set when doing comparison with the SimpleResult item.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.UnknownCount">
- <summary>
- Get and set the number of items that were categorized as unknown after verification has run.
- This statistics is only set when doing comparison with the SimpleResult item.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.UndefinedCount">
- <summary>
- Get and set the number of items that were categorized as undefined after verification has run.
- This statistics is only set when doing comparison with the SimpleResult item.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.StartTime">
- <summary>
- Get and set the time when the verification started.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.StopTime">
- <summary>
- Get and set the time when the verification stopped.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationStatistics.TotalTime">
- <summary>
- Get and set the total verification time.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationDataEventArgs">
- <summary>
- This EventArgs object is used by the CogVerificationData class hierarchy when a
- CogVerificationData object needs to be passed as part of firing an event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationDataEventArgs.#ctor(Cognex.VisionPro.Inspection.CogVerificationData)">
- <summary>
- Constructor that takes a data object.
- </summary>
- <param name="data">Data object to associate with this EventArgs object</param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationDataEventArgs.Data">
- <summary>
- Get the CogVerificationData object associated with this EventArgs object.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationKeyEventArgs">
- <summary>
- This EventArgs object is used by the CogVerificationData class hierarchy when a
- key string needs to be passed as part of firing an event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationKeyEventArgs.#ctor(System.String)">
- <summary>
- Constructor that takes a key string.
- </summary>
- <param name="key"></param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationKeyEventArgs.Key">
- <summary>
- Get the string key associated with this EventArgs object.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategoryEventArgs">
- <summary>
- This EventArgs object is used by the CogVerificationData class hierarchy when a
- CogAnnotationCategory object needs to be passed as part of firing an event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategoryEventArgs.#ctor(Cognex.VisionPro.Inspection.CogVerificationAnnotationCategory)">
- <summary>
- Constructor that takes a CogAnnotationCategory object.
- </summary>
- <param name="category"></param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationAnnotationCategoryEventArgs.Category">
- <summary>
- Get the CogAnnotationCategory object associated with this EventArgs object.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerificationGradeEventArgs">
- <summary>
- This EventArgs object is used by the CogVerificationDatabase class when a
- grade needs to be passed as part of firing an event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerificationGradeEventArgs.#ctor(System.String)">
- <summary>
- Constructor that takes a grade string.
- </summary>
- <param name="grade"></param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerificationGradeEventArgs.Grade">
- <summary>
- Get the string grade associated with this EventArgs object.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerifierRunCompletedEventArgs">
- <summary>
- This EventArg class is used when the verifier fires the RunCompleted event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierRunCompletedEventArgs.#ctor(System.Exception,System.Boolean,System.Object)">
- <summary>
-
- </summary>
- <param name="error">The exception if any was thrown during verification, null otherwise.</param>
- <param name="cancelled">True if verification was cancelled, false otherwise.</param>
- <param name="userState">Not used.</param>
- </member>
- <member name="T:Cognex.VisionPro.Inspection.CogVerifierRunProgressChangedEventArgs">
- <summary>
- This EventArg class is used when the verifier fires the RunProgress event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.Inspection.CogVerifierRunProgressChangedEventArgs.#ctor(System.Int32,Cognex.VisionPro.Inspection.CogVerificationData,System.Object)">
- <summary>
-
- </summary>
- <param name="progressPercentage">The percentage the verifier has completed running (0-100).</param>
- <param name="outputData">The output data object that was generated from the last iteration that was completed.</param>
- <param name="userState">Not used.</param>
- </member>
- <member name="P:Cognex.VisionPro.Inspection.CogVerifierRunProgressChangedEventArgs.OutputData">
- <summary>
- Gets the CogVerificationData object associated with this EventArgs object.
- </summary>
- </member>
- </members>
- </doc>
|