Class used to expose Tool Input and Output data for linking in the GUI.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision.Implementation TrackedItemBase
Cognex.Vision.Implementation ToolPin
Namespace: Cognex.Vision.Implementation
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.21.0.0
The ToolPin type exposes the following members.
| Name | Description | |
|---|---|---|
 | ToolPin(String) | Constructs a ToolPin with the given name and path. |
| ToolPin(String, TypeMeta) | Constructs a ToolPin with the given name and pinType. |
| ToolPin(String, Object) | Constructs a ToolPin with the given name and value. |
| ToolPin(String, String) | Constructs a ToolPin with the given name and path. |
| ToolPin(String, TypeMeta, Object) | Constructs a ToolPin with the given name and value. |
| Name | Description | |
|---|---|---|
| AddLink | Adds a link between this pin and pinToLink. |
| CanLink | Determines if two pins can be linked. |
 | CheckTypeCompatibilty | Check two Vision types for compatibility. |
| Equals | Compares the equality of this object with another. (Overrides TrackedItemBase Equals(Object).) |
| GetContainerAsILinkManager | Get the container which contains the Tool which contains this ToolPin. |
| GetHashCode | Returns the hash code of this object. (Overrides TrackedItemBase GetHashCode .) |
| GetLinkablePins | Gets all the pins that may be linked with this pin. |
| GetLinkedPins | Gets all the pins that are linked to/from this pin. |
| GetLinkedPins(LinkStateConstants) | Gets all the pins that are linked to/from this pin that match the given linkState. |
| GetToolOwner | Gets the Tool which contains this pin. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. |
| IsInput | Gets whether the pin is an input. |
| IsOutput | Gets whether the pin is an output. |
| IsValidName | COGNEX INTERNAL USE ONLY. |
| RemoveLink | Removes any links from this ToolPin to/from the ToolPin provided as an argument. |
| RemoveLinks | Removes all links from this ToolPin to/from any other ToolPins. |
| 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. |
| 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. |
| ToString | Returns a human readable string that represents the object. |
| Name | Description | |
|---|---|---|
 | Equality | Compares the equality of two ToolPin objects. |
| Inequality | Compares the inequality of two ToolPin objects. |
| Name | Description | |
|---|---|---|
 | SfPath | |
| SfPinType | |
| SfValue |
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. |
| Handle | (Overrides TrackedItemBase Handle.) |
| ID | Gets the ID of the tracked item. |
| Mode | Gets/sets whether the ToolPin has dedicated storage for its value or fetches its value from the given Path of the Tool. |
| Name | Get (Overrides TrackedItemBase Name.)Gets the name of the pin. |
| Parent | Return a reference to the containing tracking collection. May be null. |
| Path | Get Gets/sets the string path to the property of the Tool which this pin exposes. |
| PinType | Gets the type of the ToolPin's value, used when determining compatibility of two pins for linking. |
| Value | Get Gets/sets the actual value that this ToolPin exposes. |
| Name | Description | |
|---|---|---|
 | Changed | The actual event. |
| NameChanging | This event is raised when the Name is about to change. Note that this is a cancellable event. |