Class containing the ID run parameters.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.ID CogID
Namespace: Cognex.VisionPro.ID
Assembly: Cognex.VisionPro.ID (in Cognex.VisionPro.ID.dll) Version: 69.0.0.0
Syntax
The CogID type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogID |
Construct a default CogID object.
|
| CogID(CogID) |
Construct a deep copy of the supplied CogID object.
|
Methods
| Name | Description | |
|---|---|---|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| DisableAll1DCodes | Helper function to disable all 1D codes. |
| DisableAll2DCodes | Helper function to disable all 2D codes. |
| DisableAllCodes | Helper function to disable all codes. |
| Dispose |
Destruct this CogID.
|
 | Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Execute | Find and decode up to NumToFind
symbols within the specified region of the input image. |
| Finalize |
Finalize this CogID.
(Overrides Object Finalize .) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetObjectData |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event if the
ChangedEventSuspended count is reduced to zero and any changes were
made while events were suspended. Must be called once for each call to
SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
| Train | Train the tool. |
| Untrain | Function to untrain the tool. |
Fields
| Name | Description | |
|---|---|---|
  | SfAllowIdenticalSymbols | This bit will be set in the EventArgs of a Changed event
every time the value returned by AllowIdenticalSymbols
may have changed. |
| SfAllowPartialResults | This bit will be set in the EventArgs of a Changed event
every time the value returned by AllowPartialResults
may have changed. |
| SfCodabar | This bit will be set in the EventArgs of a Changed event
every time the value returned by Codabar may have changed. |
| SfCode128 | This bit will be set in the EventArgs of a Changed event
every time the value returned by Code128 may have changed. |
| SfCode39 | This bit will be set in the EventArgs of a Changed event
every time the value returned by Code39 may have changed. |
| SfCode93 | This bit will be set in the EventArgs of a Changed event
every time the value returned by Code93 may have changed. |
| SfDataBar | This bit will be set in the EventArgs of a Changed event
every time the value returned by DataBar may have changed. |
| SfDataMatrix | This bit will be set in the EventArgs of a Changed event
every time the value returned by DataMatrix may have changed. |
| SfDecodedStringCodePage | This bit will be set in the EventArgs of a Changed event
every time the value returned by DecodedStringCodePage may have
changed. |
| SfEANUCCComposite | This bit will be set in the EventArgs of a Changed event
every time the value returned by EANUCCComposite
may have changed. |
| SfFourState | This bit will be set in the EventArgs of a Changed event
every time the value returned by FourState may have changed. |
| SfI2Of5 | This bit will be set in the EventArgs of a Changed event
every time the value returned by I2Of5 may have changed. |
 | SfNextSf | |
| SfNumToFind | This bit will be set in the EventArgs of a Changed event
every time the value returned by NumToFind may have changed. |
| SfPDF417 | This bit will be set in the EventArgs of a Changed event
every time the value returned by PDF417 may have changed. |
| SfPharmacode | This bit will be set in the EventArgs of a Changed event
every time the value returned by Pharmacode may have changed. |
| SfPlanet | This bit will be set in the EventArgs of a Changed event
every time the value returned by Planet may have changed. |
| SfPostnet | This bit will be set in the EventArgs of a Changed event
every time the value returned by Postnet may have changed. |
| SfProcessingMode | This bit will be set in the EventArgs of a Changed event
every time the value returned by ProcessingMode may have changed. |
| SfQRCode | This bit will be set in the EventArgs of a Changed event
every time the value returned by QRCode may have changed. |
| SfShortQuietZone | This bit will be set in the EventArgs of a Changed event
every time the value returned by ShortQuietZone
may have changed. |
| SfTimeout | This bit will be set in the EventArgs of a Changed event
every time the value returned by Timeout may have changed. |
| SfTimeoutEnabled | This bit will be set in the EventArgs of a Changed event
every time the value returned by TimeoutEnabled may have changed. |
| SfTrained | This bit will be set in the EventArgs of a Changed event
every time the value returned by Trained
may have changed. |
| SfTrainedData | This bit will be set in the EventArgs of a Changed event
every time the value returned by TrainedData
may have changed. |
| SfUpcEan | This bit will be set in the EventArgs of a Changed event
every time the value returned by UpcEan may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | AllowIdenticalSymbols | Get or set whether identical symbols within the
same image should be decoded. If true, decode results may
be returned for identical symbols within the same image.
Otherwise, at most one result for such symbols will be
returned. Two symbols are considered identical if they have
the same length, symbology tpe, and decoded string. |
| AllowPartialResults | Get or set whether to allow partial results
when timeout is enabled.
|
| ChangedEventSuspended |
If nonzero, indicates that the raising of the Changed event has been
suspended. This value is incremented when SuspendChangedEvent is called
and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.) |
| Codabar | The Codabar parameters. |
| Code128 | The Code 128 parameters. |
| Code39 | The Code 39 parameters. |
| Code93 | The Code 93 parameters. |
| DataBar | The DataBar parameters. |
| DataMatrix | The DataMatrix parameters. |
| DecodedStringCodePage | Code page to use when constructing a decoded string. |
| EANUCCComposite | The EANUCCComposite parameters. |
| FourState | The Four State parameters. |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| I2Of5 | The interleaved 2 of 5 parameters. |
| NumToFind | Maximum number of symbols to find and process. |
| PDF417 | The PDF417 parameters. |
| Pharmacode | The Pharmacode parameters. |
| Planet | The Planet parameters. |
| Postnet | The Postnet parameters. |
| ProcessingMode | Processing mode: IDQuick or IDMax. |
| QRCode | The QRCode parameters. |
| ShortQuietZone | Get or set whether the quiet zone can be shorter.
When true the quiet zone can be about 6X, when false, the quiet zone can
be 10X. |
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.) |
| Timeout |
The maximum execution time (msec) allowed to decode a
symbole. If decoding has not finished by the end of the timeout
period, it will stop soon thereafter and return E_Cog_TimeoutExpired.
This value only applies if TimeoutEnabled is true.
|
| TimeoutEnabled |
If true then the Timeout property limits the execution
time of the symbol decoding. If false then timeout is disabled and
the Timeout property is ignored."
|
| Trained | Returns true if the tool is trained. |
| TrainedData | The Trained Data. |
| UpcEan | The UpcEan parameters. |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also