Base class for a generic ordered collection of values that
raises events whenever any change is made.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogChangedEventBase
Cognex.VisionPro.Implementation CogCollectionBase
Cognex.VisionPro.QuickBuild CogJobResultHistoryCollection
Namespace: Cognex.VisionPro.Implementation
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 75.0.0.0 (75.0.0.0)
Syntax
The CogCollectionBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogCollectionBase |
Constructs a new instance of the CogCollectionBase class.
|
| CogCollectionBase(CogCollectionBase) |
Constructs a new instance of the CogCollectionBase class initially
containing items cloned from the supplied instance.
|
Methods
| Name | Description | |
|---|---|---|
 | Clear |
Removes all objects from the collection.
|
| Clone |
Creates a deep copy of the object. Must be overridden in derived classes.
|
| CopyTo |
Copies the contents of the collection to an array.
|
| 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 | (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.) |
| 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.) |
| Move |
Moves an item from one position to another.
|
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogChangedEventBase.) |
| 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 CogChangedEventBase.) |
| OnCleared |
Raises the Cleared event.
|
| OnClearing |
Raises the Clearing event.
|
| OnInsertedItem |
Raises the InsertedItem event.
|
| OnInsertingItem |
Raises the InsertingItem event.
|
| OnMovedItem |
Raises the MovedItem event.
|
| OnMovingItem |
Raises the MovingItem event.
|
| OnRemovedItem |
Raises the RemovedItem event.
|
| OnRemovingItem |
Raises the RemovingItem event.
|
| OnReplacedItem |
Raises the ReplacedItem event.
|
| OnReplacingItem |
Raises the ReplacingItem event.
|
| RemoveAt |
Removes the element at the specified index.
|
| 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 CogChangedEventBase.) |
| 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 CogChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfCount |
State flag for the Count property.
|
| SfItem |
State flag for the Item (indexer) property.
|
 | SfNextSf |
Next state flag to be used in derived classes.
|
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 CogChangedEventBase.) |
| Count |
Gets the number of elements contained in the collection.
|
 | InnerList |
Gets the internal ArrayList containing the list of elements.
|
| IsFixedSize | |
| List |
Gets an the IList interface of this collection.
|
| 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 CogChangedEventBase.) |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogChangedEventBase.) |
| Cleared |
Raised after the collection is cleared.
|
| Clearing |
Raised before the collection is cleared.
|
| InsertedItem |
Raised after an item is inserted.
|
| InsertingItem |
Raised before an item is inserted.
|
| MovedItem |
Raised after an item is moved to a new index.
|
| MovingItem |
Raised before an item is moved to a new index.
|
| RemovedItem |
Raised after an item is removed.
|
| RemovingItem |
Raised before an item is removed.
|
| ReplacedItem |
Raised after an item is replaced.
|
| ReplacingItem |
Raised before an item is replaced.
|
See Also