ToolPinTrackingCollection ClassCognex VisionPro 9.10

ToolPinTracking Collection is a "live" Collection that holds a Tool's Inputs or Outputs.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.Implementation TrackingCollectionOfToolPinPtr
        Cognex.Vision.Implementation ToolPinTrackingCollection

Namespace: Cognex.Vision.Implementation
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.10.0.0
Syntax

public sealed class ToolPinTrackingCollection : TrackingCollectionOfToolPinPtr, 
	IObject

The ToolPinTrackingCollection type exposes the following members.

Constructors

  NameDescription
Public methodToolPinTrackingCollection 

Constructs a ToolPinTrackingCollection instance.

Public methodToolPinTrackingCollection(PinModeConstants)

Constructs a ToolPinTrackingCollection instance with the given pinMode.

Top
Methods

  NameDescription
Public methodAdd

Add an item to the end of this collection.

(Overrides TrackingCollectionOfToolPinPtr Add(ToolPin).)
Public methodAddRange
Adds the elements of the specified collection to the end of the collection.
Public methodClear

Remove all items from this collection.

(Overrides TrackingCollectionOfToolPinPtr Clear .)
Public methodContains(KeyValuePair String, ToolPin )

Determines whether this dictionary contains the specified nameOrID.

(Overrides TrackingCollectionOfToolPinPtr Contains(KeyValuePair String, ToolPin ).)
Public methodContains(ToolPin)

Determine whether an item is in this collection.

(Overrides TrackingCollectionOfToolPinPtr Contains(ToolPin).)
Public methodContainsKey

Determines whether this dictionary contains the specified nameOrID.

(Overrides TrackingCollectionOfToolPinPtr ContainsKey(String).)
Public methodCopyTo( KeyValuePair String, ToolPin  , Int32) (Overrides TrackingCollectionOfToolPinPtr CopyTo( KeyValuePair String, ToolPin  , Int32).)
Public methodCopyTo( ToolPin , 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 TrackingCollectionOfToolPinPtr CopyTo( ToolPin , Int32).)
Public methodEquals
Compares the equality of this object with another.
(Overrides ChangedEventShareableBase Equals(Object).)
Public methodGetEnumerator
Returns an IEnumerator for the collection.
(Overrides TrackingCollectionOfToolPinPtr GetEnumerator .)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides ChangedEventShareableBase GetHashCode .)
Public methodGetItem
Get the item at the specified index.
(Overrides TrackingCollectionOfToolPinPtr GetItem(Int32).)
Public methodGetItemByKey
Get the item at the specified index.
(Overrides TrackingCollectionOfToolPinPtr GetItemByKey(String).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Overrides TrackingCollectionOfToolPinPtr GetTypeMeta .)
Public methodIndexOf

Find the first item in this collection that matches the supplied item, and return its index.

(Overrides TrackingCollectionOfToolPinPtr IndexOf(ToolPin).)
Public methodInsert

Insert the given item at the specified index.

(Overrides TrackingCollectionOfToolPinPtr Insert(Int32, ToolPin).)
Public methodKey

Get the key at the specified index.

(Overrides TrackingCollectionOfToolPinPtr Key(Int32).)
Public methodMove

Move the selected item to a new index in this collection.

(Overrides TrackingCollectionOfToolPinPtr Move(Int32, Int32).)
Public methodRemove(String)

Remove the item with the specified nameOrID from this dictionary.

(Overrides TrackingCollectionOfToolPinPtr Remove(String).)
Public methodRemove(ToolPin)

Remove the specified item from this collection.

(Overrides TrackingCollectionOfToolPinPtr Remove(ToolPin).)
Public methodRemoveAt

Remove the item at the specified index.

(Overrides TrackingCollectionOfToolPinPtr RemoveAt(Int32).)
Public methodReserve

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 TrackingCollectionOfToolPinPtr Reserve(Int64).)
Public methodResumeAndRaiseChangedEvent

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 TrackingCollectionOfToolPinPtr ResumeAndRaiseChangedEvent .)
Public methodsetItem

Replace the element at the specified index.

(Overrides TrackingCollectionOfToolPinPtr setItem(Int32, ToolPin).)
Public methodSuspendChangedEvent

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 TrackingCollectionOfToolPinPtr SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides TrackingCollectionOfToolPinPtr ToString .)
Public methodTryGetByIndex

Get the key and value associated with the specified index.

(Overrides TrackingCollectionOfToolPinPtr TryGetByIndex(Int32, String , ToolPin ).)
Public methodTryGetValue

Get the item associated with the specified nameOrID.

(Overrides TrackingCollectionOfToolPinPtr TryGetValue(String, ToolPin ).)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two ToolPinTrackingCollection objects.
Public operatorStatic memberInequality
Compares the inequality of two ToolPinTrackingCollection objects.
Top
Properties

  NameDescription
Public propertyCapacity

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 TrackingCollectionOfToolPinPtr Capacity.)
Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides TrackingCollectionOfToolPinPtr ChangedEventSuspended.)
Public propertyCount

Get the number of elements contained in this collection.

(Overrides TrackingCollectionOfToolPinPtr Count.)
Public propertyHandle (Overrides TrackingCollectionOfToolPinPtr Handle.)
Public propertyIsReadOnly

Get whether or not this collection is read-only.

(Overrides TrackingCollectionOfToolPinPtr IsReadOnly.)
Public propertyItem Int32  (Overrides TrackingCollectionOfToolPinPtr Item Int32 .)
Public propertyItem String  (Overrides TrackingCollectionOfToolPinPtr Item String .)
Public propertyKeys (Inherited from TrackingCollectionOfToolPinPtr.)
Public propertyParent
Get

The Tool that owns or holds this collection of Pins.

Public propertyPinMode

Gets the PinMode of this PinCollection.

Public propertyValues (Inherited from TrackingCollectionOfToolPinPtr.)
Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides TrackingCollectionOfToolPinPtr Changed.)
Public eventCleared

Raised after the collection is cleared.

(Overrides TrackingCollectionOfToolPinPtr Cleared.)
Public eventClearing

Raised before the collection is cleared.

(Overrides TrackingCollectionOfToolPinPtr Clearing.)
Public eventInsertedItem

Raised after an item is inserted.

(Overrides TrackingCollectionOfToolPinPtr InsertedItem.)
Public eventInsertingItem

Raised before an item is inserted.

(Overrides TrackingCollectionOfToolPinPtr InsertingItem.)
Public eventMovedItem

Raised after an item is moved to a new index.

(Overrides TrackingCollectionOfToolPinPtr MovedItem.)
Public eventMovingItem

Raised before an item is moved to a new index.

(Overrides TrackingCollectionOfToolPinPtr MovingItem.)
Public eventRemovedItem

Raised after an item is removed.

(Overrides TrackingCollectionOfToolPinPtr RemovedItem.)
Public eventRemovingItem

Raised before an item is removed.

(Overrides TrackingCollectionOfToolPinPtr RemovingItem.)
Public eventReplacedItem

Raised after an item is replaced.

(Overrides TrackingCollectionOfToolPinPtr ReplacedItem.)
Public eventReplacingItem

Raised before an item is replaced.

(Overrides TrackingCollectionOfToolPinPtr ReplacingItem.)
Public eventTrackedItemNameChanging (Overrides TrackingCollectionOfToolPinPtr TrackedItemNameChanging.)
Top
See Also