ClassItemCollection Class

Cognex VisionPro 9.21 SR1

Class which holds a collection of ClassItem.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.ELCore.Implementation CollectionOfClassItemPtr
        Cognex.Vision.ELCore ClassItemCollection

Namespace: Cognex.Vision.ELCore
Assembly: Cognex.Vision.ELCore.Net (in Cognex.Vision.ELCore.Net.dll) Version: 9.21.1.1

Syntax

C++

Copy to Clipboard Print

public sealed class ClassItemCollection : CollectionOfClassItemPtr, 
	IObject

public sealed class ClassItemCollection : CollectionOfClassItemPtr, 
	IObject

Public NotInheritable Class ClassItemCollection 
	Inherits CollectionOfClassItemPtr 
	Implements IObject

Public NotInheritable Class ClassItemCollection 
	Inherits CollectionOfClassItemPtr 
	Implements IObject

public ref class ClassItemCollection sealed : public CollectionOfClassItemPtr, 
	IObject

public ref class ClassItemCollection sealed : public CollectionOfClassItemPtr, 
	IObject

The ClassItemCollection type exposes the following members.

Constructors

	Name	Description
	ClassItemCollection	Constructs a new instance of the collection class.
	ClassItemCollection(Int64)	Constructs a new instance of the collection class with an initial capacity specified by the argument.

Top

Methods

	Name	Description
	Add	Add an item to the end of this collection. (Overrides CollectionOfClassItemPtr Add(ClassItem).)
	AddRange	Adds the elements of the specified collection to the end of the collection.
	Clear	Remove all items from this collection. (Overrides CollectionOfClassItemPtr Clear .)
	Contains	Determine whether an item is in this collection. (Overrides CollectionOfClassItemPtr Contains(ClassItem).)
	CopyTo	Copies all the elements of the collection to the specified one-dimensional array starting at the specified destination array index. The index is specified as a 32-bit integer. (Overrides CollectionOfClassItemPtr CopyTo( ClassItem , Int32).)
	Equals	Compares the equality of this object with another. (Overrides ChangedEventShareableBase Equals(Object).)
	GetClassItem	Returns the class item associated with the provided identifier.
	GetEnumerator	Returns an IEnumerator for the collection. (Overrides CollectionOfClassItemPtr GetEnumerator .)
	GetHashCode	Returns the hash code of this object. (Overrides ChangedEventShareableBase GetHashCode .)
	GetItem	Get the item at the specified index. (Overrides CollectionOfClassItemPtr GetItem(Int32).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeMeta	Get the TypeMeta that describes the type of this object. (Overrides CollectionOfClassItemPtr GetTypeMeta .)
	IndexOf	Find the first item in this collection that matches the supplied item, and return its index. (Overrides CollectionOfClassItemPtr IndexOf(ClassItem).)
	Insert	Insert the given item at the specified index. (Overrides CollectionOfClassItemPtr Insert(Int32, ClassItem).)
	Move	Move the selected item to a new index in this collection. (Overrides CollectionOfClassItemPtr Move(Int32, Int32).)
	Remove	Remove the specified item from this collection. (Overrides CollectionOfClassItemPtr Remove(ClassItem).)
	RemoveAt	Remove the item at the specified index. (Overrides CollectionOfClassItemPtr RemoveAt(Int32).)
	Reserve	Set the collection capacity be at least the specified number of items. If minimumCapacity is greater than the current collection capacity, this method will cause the collection to reallocate its storage, increasing its capacity to at least minimumCapacity. Attempts to set capacity to a value less than or equal to the current value are ignored. (Overrides CollectionOfClassItemPtr Reserve(Int64).)
	ResumeAndRaiseChangedEvent	Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent 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. (Overrides CollectionOfClassItemPtr ResumeAndRaiseChangedEvent .)
	setItem	Replace the element at the specified index. (Overrides CollectionOfClassItemPtr setItem(Int32, ClassItem).)
	SuspendChangedEvent	Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. (Overrides CollectionOfClassItemPtr SuspendChangedEvent .)
	ToString	Returns a human readable string that represents the object. (Overrides CollectionOfClassItemPtr ToString .)

Top

Operators

	Name	Description
	Equality	Compares the equality of two ClassItemCollection objects.
	Inequality	Compares the inequality of two ClassItemCollection objects.

Top

Properties

	Name	Description
	Capacity	Get the capacity of this collection. This is the maximum number of items that may be stored in this collection without reallocation. Capacity is increased automatically as needed to hold added items. (Overrides CollectionOfClassItemPtr Capacity.)
	ChangedEventSuspended	Indicates if raising the ChangedEvent has been suspended. (Overrides CollectionOfClassItemPtr ChangedEventSuspended.)
	Count	Get the number of elements contained in this collection. (Overrides CollectionOfClassItemPtr Count.)
	Handle	(Overrides CollectionOfClassItemPtr Handle.)
	IsReadOnly	Get whether or not this collection is read-only. (Overrides CollectionOfClassItemPtr IsReadOnly.)
	Item	(Overrides CollectionOfClassItemPtr Item Int32 .)

Top

Events

	Name	Description
	Changed	The actual event. (Overrides CollectionOfClassItemPtr Changed.)
	Cleared	Raised after the collection is cleared. (Overrides CollectionOfClassItemPtr Cleared.)
	Clearing	Raised before the collection is cleared. (Overrides CollectionOfClassItemPtr Clearing.)
	InsertedItem	Raised after an item is inserted. (Overrides CollectionOfClassItemPtr InsertedItem.)
	InsertingItem	Raised before an item is inserted. (Overrides CollectionOfClassItemPtr InsertingItem.)
	MovedItem	Raised after an item is moved to a new index. (Overrides CollectionOfClassItemPtr MovedItem.)
	MovingItem	Raised before an item is moved to a new index. (Overrides CollectionOfClassItemPtr MovingItem.)
	RemovedItem	Raised after an item is removed. (Overrides CollectionOfClassItemPtr RemovedItem.)
	RemovingItem	Raised before an item is removed. (Overrides CollectionOfClassItemPtr RemovingItem.)
	ReplacedItem	Raised after an item is replaced. (Overrides CollectionOfClassItemPtr ReplacedItem.)
	ReplacingItem	Raised before an item is replaced. (Overrides CollectionOfClassItemPtr ReplacingItem.)

Top

Remarks

The ClassItems in the ClassItemCollection must each have a unique identifier. Duplicate ClassItems are not allowed. ClassItems are allowed to have the same Class name.