VisionSDK.VisionFile Class Reference

This abstract class represents a file inside a Vision Device
To instantiate a VisionFile use a valid subclass ex VisionFilePath More...

Inheritance diagram for VisionSDK.VisionFile:

Public Member Functions
virtual bool	IsValid ()
	This method must be overridden to check if a VisionFile is Valid More...
VisionFilePath	AsVisionFilePath ()
	Cast the current instance to an a VisionFilePath More...

Static Public Member Functions
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
	VisionFile ()
	Constructor More...

Detailed Description

This abstract class represents a file inside a Vision Device
To instantiate a VisionFile use a valid subclass ex VisionFilePath

Constructor & Destructor Documentation

VisionSDK.VisionFile.VisionFile ( )

protected

Constructor

Member Function Documentation

VisionFilePath VisionSDK.VisionFile.AsVisionFilePath

(

)

Cast the current instance to an a VisionFilePath

Returns

The current instance casted to a VisionFilePath

static VisionFilePath VisionSDK.VisionFile.CreateAbsolutePath ( String  fileName )

static

Create a VisionFilePath with the absolute path provided

Parameters

fileName

The absolute path of the file ( e.g. /cf/VisionPrograms/filename )

Returns

The VisionFilePath

static VisionFilePath VisionSDK.VisionFile.CreatePathRelativeToImagesFolder ( String  fileName )

static

Create a VisionFilePath relative to the Images Folder

Parameters

fileName

The file name ( ex file.vp )

Returns

The VisionFilePath

static VisionFilePath VisionSDK.VisionFile.CreatePathRelativeToProgramsFolder ( String  fileName )

static

Create a VisionFilePath relative to the Programs Folder

Parameters

fileName

The file name ( ex file.vp )

Returns

The VisionFilePath

virtual bool VisionSDK.VisionFile.IsValid ( )

virtual

This method must be overridden to check if a VisionFile is Valid

Returns

false

Implements VisionSDK.IValidable.

Reimplemented in VisionSDK.VisionFilePath.