This class holds common parameters used by
Execute(ICogVisionData)
to control what output images are produced.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.Trevista CogTrevistaCommonImageParams
Cognex.VisionPro.Trevista CogTrevistaDepthImageParams
Namespace: Cognex.VisionPro.Trevista
Assembly: Cognex.VisionPro.Trevista (in Cognex.VisionPro.Trevista.dll) Version: 93.1.0.0
Syntax
The CogTrevistaCommonImageParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogTrevistaCommonImageParams |
Construct a default CogTrevistaCommonImageParams object.
|
| CogTrevistaCommonImageParams(CogTrevistaCommonImageParams) |
Construct a deep copy of the supplied CogTrevistaCommonImageParams object.
|
| CogTrevistaCommonImageParams(Double, Double) | |
 | CogTrevistaCommonImageParams(SerializationInfo, StreamingContext) |
Serialization constructor for CogTrevistaCommonImageParams object.
|
| CogTrevistaCommonImageParams(Boolean, CogTrevistaImageTypeConstants, Double, Double) |
Construct a CogTrevistaCommonImageParams object with the supplied values.
|
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.) |
| Equals | Determines whether the specified Object is equal to the current Object. (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 | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | mBlackLevel | |
| mEnabled | |
| mImageType | |
| mWhiteLevel | |
  | SfBlackLevel |
This bit will be set in the EventArgs of a Changed event every time the
value returned by BlackLevel 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.
|
| SfImageType |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ImageType may have changed.
|
| SfNextSf | |
| SfWhiteLevel |
This bit will be set in the EventArgs of a Changed event every time the
value returned by WhiteLevel may have changed.
|
Properties
| Name | Description | |
|---|---|---|
 | BlackLevel |
Gets or sets the floating point pixel value that will be mapped to
black in VisionPro output images.
|
| 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 whether the output image associated with this
CogTrevistaCommonImageParams
should be produced. If false, the associated output image
result property will be null.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| ImageType |
Gets or sets the desired type of the output image associated with this
CogTrevistaCommonImageParams.
|
| 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.) |
| WhiteLevel |
Gets or sets the floating point pixel value that will be mapped to
white in VisionPro output images.
|
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