Tool which locates features using a PMAlign pattern. This tool encompasses all of the classes required to run a PMAlign inspection.
Inheritance Hierarchy
System MarshalByRefObject
System.ComponentModel Component
Cognex.VisionPro.Implementation CogComponentBase
Cognex.VisionPro.Implementation CogSerializableComponentBase
Cognex.VisionPro.Implementation CogSerializableChangedEventComponentBase
Cognex.VisionPro.Implementation CogToolBase
Cognex.VisionPro.PMAlign CogPMAlignTool
Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 69.0.0.0
Syntax
The CogPMAlignTool type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogPMAlignTool | Constructs a new instance of this class. |
| CogPMAlignTool(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogPMAlignTool(CogPMAlignTool) | Constructs a new instance of this class as a deep copy of the given instance. |
Methods
| Name | Description | |
|---|---|---|
 | CheckRunConditions |
Check for run conditions including data binding.
(Inherited from CogToolBase.) |
| CheckRunConditionsNoThrow |
Check for run conditions including data binding,
returning an exception for the first problem
encountered.
(Inherited from CogToolBase.) |
| Clone | Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject. (Overrides CogToolBase Clone .) |
| CreateCurrentRecord |
Creates a new set of records that represents the tool's current state.
(Inherited from CogToolBase.) |
| CreateLastRunRecord |
Creates a new set of records that represents the tool's last-run state.
(Inherited from CogToolBase.) |
| 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.) |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) |
| Dispose(Boolean) | (Overrides Component Dispose(Boolean).) |
| Equals | (Inherited from Object.) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| 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 | (Overrides CogSerializableComponentBase GetObjectData(SerializationInfo, StreamingContext).) |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetProperties( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogComponentBase.) |
| GetService | (Inherited from Component.) |
| 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.) |
| InternalCreateCurrentRecord | (Overrides CogToolBase InternalCreateCurrentRecord(ICogRecord, Int32).) |
| InternalCreateLastRunRecord | (Overrides CogToolBase InternalCreateLastRunRecord(ICogRecord, Int32, Int32).) |
| InternalRun | (Overrides CogToolBase InternalRun(String ).) |
| 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 CogSerializableChangedEventComponentBase.) |
| 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 CogSerializableChangedEventComponentBase.) |
| OnDeserialization | (Overrides CogToolBase OnDeserialization(Object).) |
| OnRan |
Raises the Ran event.
(Inherited from CogToolBase.) |
| OnRunning |
Raises the Running event.
(Inherited from CogToolBase.) |
| 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 CogSerializableChangedEventComponentBase.) |
| Run | Runs the tool using the current parameter settings. (Overrides CogToolBase Run .) |
| SetRunStatus |
Cognex Internal use only.
(Inherited from CogToolBase.) |
| 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 CogSerializableChangedEventComponentBase.) |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
Fields
| Name | Description | |
|---|---|---|
 | CurrentRecordEnable_ |
Gets or sets the flags specifying the records to include based on the
tool's current state. The derived class exposes this as a strongly-
typed enum property.
(Inherited from CogToolBase.) |
| LastRunLastRunRecordDiagEnable_ |
Gets or sets the flags specifying the records to create during the next
invocation of the Run method.
(Inherited from CogToolBase.) |
| LastRunRecordDiagEnable_ |
Gets or sets the flags specifying the diagnostics records to include
based on the tool's last-run state. The derived class exposes this as
a strongly-typed enum property.
(Inherited from CogToolBase.) |
| LastRunRecordEnable_ |
Gets or sets the flags specifying the records to include based on the
tool's last-run state. The derived class exposes this as a strongly-
typed enum property.
(Inherited from CogToolBase.) |
| ProcessingTimeAdjustment_ |
Gets or sets the amount to offset reported tool processing time.
(Inherited from CogToolBase.) |
  | SfCurrentRecordEnable | This bit will be set in the EventArgs of a Changed event every time the value returned by CurrentRecordEnable may have changed. |
| SfInputImage | This bit will be set in the EventArgs of a Changed event every time the value returned by InputImage may have changed. |
| SfLastRunRecordDiagEnable | This bit will be set in the EventArgs of a Changed event every time the value returned by LastRunRecordDiagEnable may have changed. |
| SfLastRunRecordEnable | This bit will be set in the EventArgs of a Changed event every time the value returned by LastRunRecordEnable may have changed. |
| SfPattern | This bit will be set in the EventArgs of a Changed event every time the value returned by Pattern may have changed. |
| SfResults | This bit will be set in the EventArgs of a Changed event every time the value returned by Results may have changed. |
| SfRunParams | This bit will be set in the EventArgs of a Changed event every time the value returned by RunParams may have changed. |
| SfSearchRegion | This bit will be set in the EventArgs of a Changed event every time the value returned by SearchRegion may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
 | 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 CogSerializableChangedEventComponentBase.) |
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| CurrentRecordEnable | Enable creation of records by bitwise ORing the appropriate CurrentRecordConstants. |
| DataBindings |
Gets the data bindings for the tool.
(Inherited from CogToolBase.) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| FailOnInvalidDataBinding |
Specifies that the Run method is to fail if executed while one or more
data bindings are invalid.
(Inherited from CogToolBase.) |
| HasChanged | (Inherited from CogSerializableChangedEventComponentBase.) |
| InputImage | Search image used to run a PMAlign inspection. The SearchRegion is applied to this InputImage in order to define the region that will be used locate PMAlign pattern(s). |
| LastRunRecordDiagEnable | Enable creation of records by bitwise ORing the appropriate LastRunRecordDiagConstants. These are diagnostic records that may cause the Tool to have a longer execution time. |
| LastRunRecordEnable | Enable creation of records by bitwise ORing the appropriate LastRunRecordConstants. |
| Name | Gets or sets the name of the tool. (Overrides CogToolBase Name.) |
| Pattern | The PMAlign pattern. |
| Results | Results from the last invocation of the Run method. A gcnew CogPMAlignResults is factoried for each inspection. Previous results will be released prior to the new inspection. |
| RunParams | The PMAlign run parameters. |
| RunStatus | Gets general information about the last call to Run. (Overrides CogToolBase RunStatus.) |
| SearchRegion | Region of interest in the InputImage that is used to locate PMAlign pattern(s). NULL means use entire InputImage. The ICogPMAlignRunParams::SearchRegionMode property specifies exactly how the region will be applied to this image. |
| Site | (Inherited from Component.) |
| 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 CogSerializableChangedEventComponentBase.) |
| UserData |
Gets a CogDictionary object that can be used to store application-specific information.
(Inherited from CogToolBase.) |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventComponentBase.) |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) |
| Ran |
Event that is raised at the end of the tool's Run method.
(Inherited from CogToolBase.) |
| Running |
Event that is raised at the start of the tool's Run method.
(Inherited from CogToolBase.) |
Remarks
Primary interface of a CogPMAlignTool.
See Also