CogTrackingCollection(T) Class

CogTrackingCollection T Class

Cognex VisionPro 9.7

A collection which can be indexed by name, index, or a string ID. The indexing by ID is designed to be semi-permenent (where name and index may change)to facilitate DataBinding where a constant path that identifies an entry in the collection is valuable.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Implementation CogSerializableCollectionBase T
            Cognex.VisionPro.Implementation CogTrackingCollection T
              Cognex.VisionPro.Comm CogPrioEventCollection
              Cognex.VisionPro.ToolBlock CogToolBlockTerminalCollection

Namespace: Cognex.VisionPro.Implementation
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 73.0.0.0 (73.0.0.0)

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public abstract class CogTrackingCollection<T> : CogSerializableCollectionBase<T>, 
	IDeserializationCallback 
where T : ICogTrackingCollectionTrackedItem

[SerializableAttribute]
public abstract class CogTrackingCollection<T> : CogSerializableCollectionBase<T>, 
	IDeserializationCallback 
where T : ICogTrackingCollectionTrackedItem

<SerializableAttribute>
Public MustInherit Class CogTrackingCollection(Of T As ICogTrackingCollectionTrackedItem)
	Inherits CogSerializableCollectionBase(Of T)
	Implements IDeserializationCallback

<SerializableAttribute>
Public MustInherit Class CogTrackingCollection(Of T As ICogTrackingCollectionTrackedItem)
	Inherits CogSerializableCollectionBase(Of T)
	Implements IDeserializationCallback

[SerializableAttribute]
generic<typename T>
where T : ICogTrackingCollectionTrackedItem 
public ref class CogTrackingCollection abstract : public CogSerializableCollectionBase<T>, 
	IDeserializationCallback

[SerializableAttribute]
generic<typename T>
where T : ICogTrackingCollectionTrackedItem 
public ref class CogTrackingCollection abstract : public CogSerializableCollectionBase<T>, 
	IDeserializationCallback

Type Parameters

T: The type of objects that will be tracked in this collection

The CogTrackingCollection T type exposes the following members.

Constructors

	Name	Description
	CogTrackingCollection T
	CogTrackingCollection T (Object)
	CogTrackingCollection T ( T )
	CogTrackingCollection T (SerializationInfo, StreamingContext)
	CogTrackingCollection T ( T , Object)

Top

Methods

	Name	Description
	Add	Adds value to the end of the collection. (Inherited from CogSerializableCollectionBase T .)
	Clear	Removes all objects from the collection. (Inherited from CogSerializableCollectionBase T .)
	Contains(T)	Returns true if value is in the collection (Inherited from CogSerializableCollectionBase T .)
	Contains(String)	Returns true if the collection contains an item with the specified Name or ID.
	CopyTo	Copies the collection to an array (Inherited from CogSerializableCollectionBase T .)
	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.)
	GetEnumerator	Returns an enumerator that can iterate through the collection's items.
	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 )	Returns a collection containing all PropertyDescriptors found in the standard fasion, augmented with property descriptors name and ID of the tracked item that can be obtained using the string overload of the item indexer. (Overrides CogObjectBase GetProperties( Attribute ).)
	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.)
	IndexOf	Returns the index of value in the collection, or -1 if value is not in the collection. (Inherited from CogSerializableCollectionBase T .)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	Insert	Inserts the value at the specified index of the collection (Inherited from CogSerializableCollectionBase T .)
	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. (Inherited from CogSerializableCollectionBase T .)
	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.)
	OnCleared	Raises the Cleared event. (Inherited from CogSerializableCollectionBase T .)
	OnClearing	Raises the Clearing event. (Overrides CogSerializableCollectionBase T OnClearing .)
	OnDeserialization
	OnInsertedItem	Raises the InsertedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnInsertingItem	Raises the InsertingItem event. (Overrides CogSerializableCollectionBase T OnInsertingItem(Int32, Object).)
	OnMovedItem	(Overrides CogSerializableCollectionBase T OnMovedItem(Int32, Int32).)
	OnMovingItem	Raises the MovingItem event. (Inherited from CogSerializableCollectionBase T .)
	OnRemovedItem	Raises the RemovedItem event. (Overrides CogSerializableCollectionBase T OnRemovedItem(Int32, Object).)
	OnRemovingItem	Raises the RemovingItem event. (Inherited from CogSerializableCollectionBase T .)
	OnReplacedItem	Raises the ReplacedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnReplacingItem	Raises the ReplacingItem event. (Overrides CogSerializableCollectionBase T OnReplacingItem(Int32, Object, Object).)
	OnStartTracking	Called when a new item in the collection needs to be tracked
	OnStopTracking	Called when an item in the collection no longer needs to be tracked
	OnTrackedItemNameChanging
	Remove(T)	Removes value from the collection (Inherited from CogSerializableCollectionBase T .)
	Remove(String)	Removes the item with the specified Name or ID from the collection.
	RemoveAt	Removes the element at the specified index. (Inherited from CogSerializableCollectionBase T .)
	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.)

Top

Fields

	Name	Description
	SfIDKeys	StateFlag indicating that the ID of an Item in the collection may have changed
	SfNameKeys	StateFlag indicating that the name of an Item in the collection may have changed
	SfNextSf

Top

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.)
	Count	Gets the number of elements contained in the collection. (Inherited from CogSerializableCollectionBase T .)
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	InnerList	Gets the internal List containing the list of elements. (Inherited from CogSerializableCollectionBase T .)
	IsFixedSize	returns false (Inherited from CogSerializableCollectionBase T .)
	IsReadOnly	Returns true if this collection is ReadOnly (Inherited from CogSerializableCollectionBase T .)
	IsSynchronized	(Inherited from CogSerializableCollectionBase T .)
	Item Int32	Returns the T at index (Inherited from CogSerializableCollectionBase T .)
	Item String	Gets the T with the specified Name or ID.
	List	Gets an the IList interface of this collection. (Inherited from CogSerializableCollectionBase T .)
	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.)
	SyncRoot	(Inherited from CogSerializableCollectionBase T .)

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	Cleared	Raised after the collection is cleared. (Inherited from CogSerializableCollectionBase T .)
	Clearing	Raised before the collection is cleared. (Inherited from CogSerializableCollectionBase T .)
	InsertedItem	Raised after an item is inserted. (Inherited from CogSerializableCollectionBase T .)
	InsertingItem	Raised before an item is inserted. (Inherited from CogSerializableCollectionBase T .)
	MovedItem	Raised after an item is moved to a new index. (Inherited from CogSerializableCollectionBase T .)
	MovingItem	Raised before an item is moved to a new index. (Inherited from CogSerializableCollectionBase T .)
	RemovedItem	Raised after an item is removed. (Inherited from CogSerializableCollectionBase T .)
	RemovingItem	Raised before an item is removed. (Inherited from CogSerializableCollectionBase T .)
	ReplacedItem	Raised after an item is replaced. (Inherited from CogSerializableCollectionBase T .)
	ReplacingItem	Raised before an item is replaced. (Inherited from CogSerializableCollectionBase T .)
	TrackedItemNameChanging	Event raised when a tracked item is about to change its name.

Top

Remarks

Each item in the collection must have a unique name and ID.