The PMAlign composite data item class.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.PMAlign CogPMAlignCompositeDataItem
Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 65.1.0.0
Syntax
The CogPMAlignCompositeDataItem type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogPMAlignCompositeDataItem | Construct a default CogPMAlignCompositeDataItem object. |
| CogPMAlignCompositeDataItem(CogPMAlignCompositeDataItem) | Construct a deep copy of the supplied CogPMAlignCompositeDataItem object except for the PercentCoarseFeaturesUsed, PercentFineFeaturesUsed and GraphicsIndex because these values are generated at train time. |
 | CogPMAlignCompositeDataItem(SerializationInfo, StreamingContext) | Serialization constructor for CogPMAlignCompositeDataItem object. The PercentCoarseFeaturesUsed, PercentFineFeaturesUsed and GraphicsIndex are not serialized because they are generated at train time. |
Methods
| Name | Description | |
|---|---|---|
| CanEnable | Indicates that the image and the pose are not null and the item can be enabled. |
| 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.) |
| SetImagePoseEnabled | Sets the training image, the pose and the enabled properties in one shot. |
| 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 | |
|---|---|---|
  | SfAlignmentFeatures | This bit will be set in the EventArgs of a Changed event every time the value returned by AlignmentFeatures may have changed. |
| SfEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by Enabled may have changed. |
| SfImage | This bit will be set in the EventArgs of a Changed event every time the value returned by Image may have changed. |
 | SfNextSf | NextSf state flag. |
| SfPercentCoarseFeaturesUsed | This bit will be set in the EventArgs of a Changed event every time the value returned by PercentCoarseFeaturesUsed may have changed. |
| SfPercentFineFeaturesUsed | This bit will be set in the EventArgs of a Changed event every time the value returned by PercentFineFeaturesUsed may have changed. |
| SfPose | This bit will be set in the EventArgs of a Changed event every time the value returned by Pose may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | AlignmentFeatures | Internal Cognex use only |
| 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.) |
| Enabled | Gets or sets the Enabled property. This property indicates whether to use the pattern in composite training or not. |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| Image | Gets or sets the training image. |
| PercentCoarseFeaturesUsed | Gets the percentage of the coarse features that were used in the pattern.The value is set when the user calls train and the item is enabled. |
| PercentFineFeaturesUsed | Gets the percentage of the fine feature that were used in the pattern.The value is set when the user calls train and the item is enabled. |
| Pose | Gets or sets the pattern pose in the training image Pose. |
| 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.) |
| TrainGraphicsIndex | Internal Cognex only. |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
Remarks
See Also