VisionSDK.VisionPortPath Class Reference

This object is used by the SDK to represent a VisionPort in a Path Format.
The easy way to retrieve this Path in VPM is to go to the tool's Properties tab (below the image window),
right click on the desired port, then copy and paste the Path into your code
The typical path formats are:
"ProgramName.TaskName.ToolName:PortName" For example "Inspection.Image In Task.My Ocr Tool.Input Image"
"ProgramName.TaskName:PortName" For example "Inspection.Image In Task.Image"
"Vision System.SettingsName:PortName" For example "Vision System.Camera:Gain"
More...

Inheritance diagram for VisionSDK.VisionPortPath:

Public Member Functions
	VisionPortPath (String path)
	VisionPortPath ()
	Constructor More...
override bool	IsValid ()
	Checks if the path has been set or not More...
override int	GetHashCode ()
bool	Equals (VisionPort obj)
override bool	Equals (object obj)
override string	ToString ()
Public Member Functions inherited from VisionSDK.VisionPort
VisionPortPath	AsVisionPortPath ()
	Return the VisionPort cast as a Vision Port Path More...
Public Member Functions inherited from VisionSDK.VisionObject
override string	ToString ()
string	ToJson ()
override int	GetHashCode ()
override bool	Equals (object obj)

Properties
String	Path [get, set]
	The String that contains the path More...

Additional Inherited Members
Static Public Member Functions inherited from VisionSDK.VisionPort
static VisionPortPath	CreateFromPath (String path)
	Create a VisionPort by instantiating a default implementation of it (VisionPortPath) More...

Detailed Description

This object is used by the SDK to represent a VisionPort in a Path Format.
The easy way to retrieve this Path in VPM is to go to the tool's Properties tab (below the image window),
right click on the desired port, then copy and paste the Path into your code
The typical path formats are:
"ProgramName.TaskName.ToolName:PortName" For example "Inspection.Image In Task.My Ocr Tool.Input Image"
"ProgramName.TaskName:PortName" For example "Inspection.Image In Task.Image"
"Vision System.SettingsName:PortName" For example "Vision System.Camera:Gain"

VisionPort port = new VisionPortPath( "Inspection.Image In Task:Image" );

Constructor & Destructor Documentation

VisionSDK.VisionPortPath.VisionPortPath

(

String

path

)

VisionSDK.VisionPortPath.VisionPortPath

(

)

Constructor

Member Function Documentation

bool VisionSDK.VisionPortPath.Equals

(

VisionPort

obj

)

override bool VisionSDK.VisionPortPath.Equals

(

object

obj

)

override int VisionSDK.VisionPortPath.GetHashCode

(

)

override bool VisionSDK.VisionPortPath.IsValid ( )

virtual

Checks if the path has been set or not

Reimplemented from VisionSDK.VisionPort.

override string VisionSDK.VisionPortPath.ToString

(

)

Property Documentation

String VisionSDK.VisionPortPath.Path

getset

The String that contains the path