The CogPMAlignMultiRunParams class. This class holds a CogPMAlignRunParams in addition to the mutli-model run parameters.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.PMAlign CogPMAlignMultiRunParams
Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 75.1.0.0
Syntax
The CogPMAlignMultiRunParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogPMAlignMultiRunParams | Constructs a default CogPMAlignMultiRunParams object. |
| CogPMAlignMultiRunParams(CogPMAlignMultiRunParams) | Constructs a deep copy of the supplied CogPMAlignMultiRunParams object. |
 | CogPMAlignMultiRunParams(SerializationInfo, StreamingContext) | Serialization constructor for CogPMAlignMutliRunParams 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.) |
| Dispose | |
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| 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.) |
Fields
| Name | Description | |
|---|---|---|
  | SfNextSf | |
 | SfPMAlignRunParams | This bit will be set in the EventArgs of a Changed event every time the value returned by PMAlignRunParams may have changed. |
| SfReportResultsFromOnePatternOnly | This bit will be set in the EventArgs of a Changed event every time the value returned by UseXYOverlapBetweenPatterns may have changed. |
| SfRuntimeMode | This bit will be set in the EventArgs of a Changed event every time the value returned by RuntimeMode may have changed. |
| SfStopSequentialThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by StopSequentialThreshold may have changed. |
| SfUseXYOverlapBetweenPatterns | This bit will be set in the EventArgs of a Changed event every time the value returned by UseXYOverlapBetweenPatterns may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | 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.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| PMAlignRunParams | Gets or sets the PMAlignRunParams. |
| ReportResultsFromOnePatternOnly | Gets or sets the ReportResultsFromOnePatternOnly Boolean. For Sequential search Sequential For SequentialMostRecentlySuccessful search SequentialMostRecentlySuccessful For SequentialMostSuccessful search SequentialMostSuccessful For Exhaustive search Exhaustive |
| RuntimeMode | Gets or sets the runtime mode. |
| 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.) |
| StopSequentialThreshold | Gets or sets the StopSequentialThreshold. This property is only used in Sequential search as one of the stopping condition criteria. Sequential searches will stop when the total number of found instances (with a score at or above this threshold) from a single pattern meets or exceeds the ApproximateNumberToFind. It does not alter the PatMax search algorithm. The value must be greater or equal to the AcceptThreshold otherwise a runtime error will be reported. |
| UseXYOverlapBetweenPatterns | Gets or sets the UseXYOverlapBetweenPatterns Boolean. If true, the overlap value from the PMAlignRunParams is used to discard overlapping instances of different patterns. Otherwise, the overlap value is only used to discard overlapping instances of a single pattern. |
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