Impact Vision SDK  11.8.1
VisionSDK.VisionFilePath Class Reference

This class represents VisionFile in a Path Format.
More...

Inheritance diagram for VisionSDK.VisionFilePath:
VisionSDK.VisionFile VisionSDK.IValidable

Public Member Functions

 VisionFilePath ()
 Constructor More...
 
 VisionFilePath (String path)
 Constructor More...
 
override bool IsValid ()
 Check if the Path is empty More...
 
- Public Member Functions inherited from VisionSDK.VisionFile
VisionFilePath AsVisionFilePath ()
 Cast the current instance to an a VisionFilePath More...
 

Static Public Attributes

static String ProgramsFolderPath = "/cf/VisionPrograms/"
 Return the Programs Folder absolute path More...
 
static String ImagesFolderPath = "/cf/Images/"
 Return the Images folder absolute path More...
 

Properties

String Path [get, set]
 The complete path of the File More...
 
String FileName [get]
 Return the Filename stripping the Path More...
 

Additional Inherited Members

- Static Public Member Functions inherited from VisionSDK.VisionFile
static VisionFilePath CreatePathRelativeToProgramsFolder (String fileName)
 Create a VisionFilePath relative to the Programs Folder More...
 
static VisionFilePath CreatePathRelativeToImagesFolder (String fileName)
 Create a VisionFilePath relative to the Images Folder More...
 
static VisionFilePath CreateAbsolutePath (String fileName)
 Create a VisionFilePath with the absolute path provided More...
 
- Protected Member Functions inherited from VisionSDK.VisionFile
 VisionFile ()
 Constructor More...
 

Detailed Description

This class represents VisionFile in a Path Format.

VisionFile file = new VisionFilePath( "Inspection.vp" );

Constructor & Destructor Documentation

VisionSDK.VisionFilePath.VisionFilePath ( )

Constructor

VisionSDK.VisionFilePath.VisionFilePath ( String  path)

Constructor

Parameters
pathThe File's absolute path ( ex. "/cf/VisionPrograms/file.vp" )

Member Function Documentation

override bool VisionSDK.VisionFilePath.IsValid ( )
virtual

Check if the Path is empty

Returns
true if the path is valid

Reimplemented from VisionSDK.VisionFile.

Member Data Documentation

String VisionSDK.VisionFilePath.ImagesFolderPath = "/cf/Images/"
static

Return the Images folder absolute path

Returns
String VisionSDK.VisionFilePath.ProgramsFolderPath = "/cf/VisionPrograms/"
static

Return the Programs Folder absolute path

Returns

Property Documentation

String VisionSDK.VisionFilePath.FileName
get

Return the Filename stripping the Path

String VisionSDK.VisionFilePath.Path
getset

The complete path of the File

HTML Footer Datalogic Automation, Inc.    ©2016 Datalogic Automation Inc. All Rights Reserved