ToolTrackingCollection Class

Cognex VisionPro 9.24

An ordered collection of Vision Tools that raises events whenever a change is made.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.Implementation TrackingCollectionOfIToolPtr
        Cognex.Vision ToolTrackingCollection

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.24.0.0

Syntax

C++

Copy to Clipboard Print

public sealed class ToolTrackingCollection : TrackingCollectionOfIToolPtr, 
	IObject

public sealed class ToolTrackingCollection : TrackingCollectionOfIToolPtr, 
	IObject

Public NotInheritable Class ToolTrackingCollection 
	Inherits TrackingCollectionOfIToolPtr 
	Implements IObject

Public NotInheritable Class ToolTrackingCollection 
	Inherits TrackingCollectionOfIToolPtr 
	Implements IObject

public ref class ToolTrackingCollection sealed : public TrackingCollectionOfIToolPtr, 
	IObject

public ref class ToolTrackingCollection sealed : public TrackingCollectionOfIToolPtr, 
	IObject

The ToolTrackingCollection type exposes the following members.

Constructors

	Name	Description
	ToolTrackingCollection	Constructs a new instance of the collection class.
	ToolTrackingCollection(IObject)	Construct a new instance of the tracking collection class with a parent specified by the argument.
	ToolTrackingCollection(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 TrackingCollectionOfIToolPtr Add(ITool).)
	AddRange	Adds the elements of the specified collection to the end of the collection.
	Clear	Remove all items from this collection. (Overrides TrackingCollectionOfIToolPtr Clear .)
	Contains(KeyValuePair String, ITool )	Determines whether this dictionary contains the specified nameOrID. (Overrides TrackingCollectionOfIToolPtr Contains(KeyValuePair String, ITool ).)
	Contains(ITool)	Determine whether an item is in this collection. (Overrides TrackingCollectionOfIToolPtr Contains(ITool).)
	ContainsKey	Determines whether this dictionary contains the specified nameOrID. (Overrides TrackingCollectionOfIToolPtr ContainsKey(String).)
	CopyTo( KeyValuePair String, ITool , Int32)	(Overrides TrackingCollectionOfIToolPtr CopyTo( KeyValuePair String, ITool , Int32).)
	CopyTo( ITool , Int32)	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 TrackingCollectionOfIToolPtr CopyTo( ITool , Int32).)
	Equals	Compares the equality of this object with another. (Overrides ChangedEventShareableBase Equals(Object).)
	GenerateUniqueToolName	Generates a unique name for the input tool type name.
	GetEnumerator	Returns an IEnumerator for the collection. (Overrides TrackingCollectionOfIToolPtr GetEnumerator .)
	GetHashCode	Returns the hash code of this object. (Overrides ChangedEventShareableBase GetHashCode .)
	GetItem	Get the item at the specified index. (Overrides TrackingCollectionOfIToolPtr GetItem(Int32).)
	GetItemByKey	Get the item at the specified index. (Overrides TrackingCollectionOfIToolPtr GetItemByKey(String).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeMeta	Get the TypeMeta that describes the type of this object. (Overrides TrackingCollectionOfIToolPtr GetTypeMeta .)
	IndexOf	Find the first item in this collection that matches the supplied item, and return its index. (Overrides TrackingCollectionOfIToolPtr IndexOf(ITool).)
	Insert	Insert the given item at the specified index. (Overrides TrackingCollectionOfIToolPtr Insert(Int32, ITool).)
	InsertFromToolTypeName	Insert a tool of the type specified by the input toolTypeName. Generate and assign this tool a unique name using its type.
	Key	Get the key at the specified index. (Overrides TrackingCollectionOfIToolPtr Key(Int32).)
	Move	Move the selected item to a new index in this collection. (Overrides TrackingCollectionOfIToolPtr Move(Int32, Int32).)
	Remove(String)	Remove the item with the specified nameOrID from this dictionary. (Overrides TrackingCollectionOfIToolPtr Remove(String).)
	Remove(ITool)	Remove the specified item from this collection. (Overrides TrackingCollectionOfIToolPtr Remove(ITool).)
	RemoveAt	Remove the item at the specified index. (Overrides TrackingCollectionOfIToolPtr RemoveAt(Int32).)
	Reserve	Set the collection capacity to 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 TrackingCollectionOfIToolPtr 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 TrackingCollectionOfIToolPtr ResumeAndRaiseChangedEvent .)
	setItem	Replace the element at the specified index. (Overrides TrackingCollectionOfIToolPtr setItem(Int32, ITool).)
	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 TrackingCollectionOfIToolPtr SuspendChangedEvent .)
	ToString	Returns a human readable string that represents the object. (Overrides TrackingCollectionOfIToolPtr ToString .)
	TryGetByIndex	Get the key and value associated with the specified index. (Overrides TrackingCollectionOfIToolPtr TryGetByIndex(Int32, String , ITool ).)
	TryGetValue	Get the item associated with the specified nameOrID. (Overrides TrackingCollectionOfIToolPtr TryGetValue(String, ITool ).)

Top

Operators

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

Top

Fields

	Name	Description
	SfParent

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 TrackingCollectionOfIToolPtr Capacity.)
	ChangedEventSuspended	Indicates if raising the ChangedEvent has been suspended. (Overrides TrackingCollectionOfIToolPtr ChangedEventSuspended.)
	Count	Get the number of elements contained in this collection. (Overrides TrackingCollectionOfIToolPtr Count.)
	Handle	(Overrides TrackingCollectionOfIToolPtr Handle.)
	IsReadOnly	Get whether or not this collection is read-only. (Overrides TrackingCollectionOfIToolPtr IsReadOnly.)
	Item Int32	(Overrides TrackingCollectionOfIToolPtr Item Int32 .)
	Item String	(Overrides TrackingCollectionOfIToolPtr Item String .)
	Keys	(Inherited from TrackingCollectionOfIToolPtr.)
	Parent	Get Gets the parent object of this CogToolTrackingCollection.
	Values	(Inherited from TrackingCollectionOfIToolPtr.)

Top

Events

	Name	Description
	Changed	The actual event. (Overrides TrackingCollectionOfIToolPtr Changed.)
	Cleared	Raised after the collection is cleared. (Overrides TrackingCollectionOfIToolPtr Cleared.)
	Clearing	Raised before the collection is cleared. (Overrides TrackingCollectionOfIToolPtr Clearing.)
	InsertedItem	Raised after an item is inserted. (Overrides TrackingCollectionOfIToolPtr InsertedItem.)
	InsertingItem	Raised before an item is inserted. (Overrides TrackingCollectionOfIToolPtr InsertingItem.)
	MovedItem	Raised after an item is moved to a new index. (Overrides TrackingCollectionOfIToolPtr MovedItem.)
	MovingItem	Raised before an item is moved to a new index. (Overrides TrackingCollectionOfIToolPtr MovingItem.)
	RemovedItem	Raised after an item is removed. (Overrides TrackingCollectionOfIToolPtr RemovedItem.)
	RemovingItem	Raised before an item is removed. (Overrides TrackingCollectionOfIToolPtr RemovingItem.)
	ReplacedItem	Raised after an item is replaced. (Overrides TrackingCollectionOfIToolPtr ReplacedItem.)
	ReplacingItem	Raised before an item is replaced. (Overrides TrackingCollectionOfIToolPtr ReplacingItem.)
	TrackedItemLastRunRecordChanged	This event is raised when any of the contained tools raises a Changed event with the SfCreateLastRunRecord state flag.
	TrackedItemNameChanging	(Overrides TrackingCollectionOfIToolPtr TrackedItemNameChanging.)

Top