CogTrackedItemBase.ID Property

CogTrackedItemBase ID Property

Cognex VisionPro

Gets the ID property of the terminal

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

Syntax

C++

Copy to Clipboard Print

public string ID { get; }

public string ID { get; }

Public ReadOnly Property ID As String 
	Get

Public ReadOnly Property ID As String 
	Get

public:
virtual property String^ ID {
	String^ get () sealed;
}

public:
virtual property String^ ID {
	String^ get () sealed;
}

Property Value

Type: String

Implements

ICogTrackingCollectionTrackedItem ID

Remarks

The terminal ID holds a GUID string which identifies a particular terminal object instance. A new GUID is created and assinged to the ID property when a terminal is created using the (name, value) or (name, valueType) constructor. The ID property is serialized. The ID property is cloned. The ID property is used to index CogToolTerminalsCollection.

Indexing by ID provides a path for terminal links (or CogDataBindings) to CogToolBlock Inputs and Outputs.

Serializing or cloning a terminal will result in a terminal with the same ID as the oringinal terminal. This is desireable so that links (a.k.a. DataBindings) that use the ID property in their paths maitiain their links when copied or serialized.

This means that it is possilble to create multiple terminals with the same ID property. However, the ID field will always be unique amongst terminals within a CogToolBlockTerminalCollection.