Class FileSystem

This class represents the FileSystem domain of a Robot controller.

Inheritance

object

NamedObject

SDKBase

SDKControllerBoundBase

FileSystem

Implements

IComparable

INamedObject

IDisposable

IFileSystem

Inherited Members

NamedObject.Equals(string)

NamedObject.Equals(NamedObject)

NamedObject.Equals(object)

NamedObject.CompareTo(string)

NamedObject.CompareTo(NamedObject)

NamedObject.CompareTo(object)

NamedObject.GetHashCode()

NamedObject.ToString()

NamedObject.Name

Namespace: ABB.Robotics.Controllers.FileSystemDomain

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public sealed class FileSystem : SDKControllerBoundBase, IComparable, INamedObject, IDisposable, IFileSystem

Fields

Prefix

Prefix for controller paths.

Declaration

public const string Prefix = "ctrl:"

Field Value

Type	Description
string

Properties

LocalDirectory

Gets or set the directory on the local system.

Declaration

public string LocalDirectory { get; set; }

Property Value

Type	Description
string	The text associated to the local directory.

RemoteDirectory

Gets or set the directory on the Robot Controller.

Declaration

public string RemoteDirectory { get; set; }

Property Value

Type	Description
string	The text associated to the remote directory.

Methods

BeginCopyDirectory(string, string, AsyncCallback, object)

Starts an async directory copy operation on the controller.

Declaration

public IAsyncResult BeginCopyDirectory(string source, string destination, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	source	Source directory.
string	destination	Destination directory.
AsyncCallback	callback	Callback method.
object	state	User defined state object.

Returns

Type	Description
IAsyncResult	Result object.

BeginCopyDirectory(string, string, bool, AsyncCallback, object)

Starts an async directory copy operation on the controller.

Declaration

public IAsyncResult BeginCopyDirectory(string source, string destination, bool overwrite, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	source	Source directory.
string	destination	Destination directory.
bool	overwrite	True to overwrite any existing directory.
AsyncCallback	callback	Callback method.
object	state	User defined state object.

Returns

Type	Description
IAsyncResult	Result object.

BeginCopyFile(string, string, AsyncCallback, object)

Starts a new async file copy operation.

Declaration

public IAsyncResult BeginCopyFile(string source, string destination, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	source	Source file.
string	destination	Destination file.
AsyncCallback	callback	Callback.
object	state	User defined state object.

Returns

Type	Description
IAsyncResult	Result object.

BeginCopyFile(string, string, bool, AsyncCallback, object)

Starts a new async file copy operation.

Declaration

public IAsyncResult BeginCopyFile(string source, string destination, bool overwrite, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	source	Source file.
string	destination	Destination file.
bool	overwrite	True to overwrite any existing file.
AsyncCallback	callback	Callback.
object	state	User defined state object.

Returns

Type	Description
IAsyncResult	Result object.

BeginCreateDirectory(string, AsyncCallback, object)

Starts a CreateDirectory operation on the controller.

Declaration

public IAsyncResult BeginCreateDirectory(string name, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	name	Name of directory.
AsyncCallback	callback	Completion callback.
object	state	User state object.

Returns

Type	Description
IAsyncResult	\Result object.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

BeginDirectoryExists(string, AsyncCallback, object)

Starts a directory exists operation.

Declaration

public IAsyncResult BeginDirectoryExists(string path, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	path	Path of directory.
AsyncCallback	callback	Callback.
object	state	State.

Returns

Type	Description
IAsyncResult	\Result object.

Remarks

Requires the ReadFtp grant.

BeginFileExists(string, AsyncCallback, object)

Starts a begin file operation.

Declaration

public IAsyncResult BeginFileExists(string path, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	path	Path to file.
AsyncCallback	callback	Callback.
object	state	State.

Returns

Type	Description
IAsyncResult	\ \

Remarks

Requires the ReadFtp grant.

BeginGetDirectory(string, string, bool, AsyncCallback, object)

Starts a get operation for a complete directory.

Declaration

public IAsyncResult BeginGetDirectory(string remoteDirectory, string localDirectory, bool overwrite, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	remoteDirectory	Name of remote directory.
string	localDirectory	Name of local directory.
bool	overwrite	true to overwrite local if exists.
AsyncCallback	callback	Callback.
object	state	State.

Returns

Type	Description
IAsyncResult	\ \

Remarks

Requires the ReadFtp grant.

BeginGetFile(string, string, bool, AsyncCallback, object)

Starts a get file operation.

Declaration

public IAsyncResult BeginGetFile(string remoteFile, string localFile, bool overwrite, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	remoteFile	Remote file.
string	localFile	Local file.
bool	overwrite	Flag indicating if to overwrite any existing file.
AsyncCallback	callback	Callback method.
object	state	State object.

Returns

Type	Description
IAsyncResult	\Result object.

Remarks

Requires the ReadFtp grant.

BeginListDirectory(string, AsyncCallback, object)

Starts a list directory operation.

Declaration

public IAsyncResult BeginListDirectory(string filter, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	filter	Filter expression.
AsyncCallback	callback	Callback method.
object	state	State object.

Returns

Type	Description
IAsyncResult	\ \

Remarks

Requires the ReadFtp grant.

BeginPutDirectory(string, string, bool, AsyncCallback, object)

Starts a put directory operation.

Declaration

public IAsyncResult BeginPutDirectory(string localDirectory, string remoteDirectory, bool overwrite, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	localDirectory	Local directory.
string	remoteDirectory	Remote directory.
bool	overwrite	true to overwrite remote directory if already present.
AsyncCallback	callback	Callback.
object	state	State.

Returns

Type	Description
IAsyncResult

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

BeginPutFile(string, string, bool, AsyncCallback, object)

Starts a put file operation.

Declaration

public IAsyncResult BeginPutFile(string localFile, string remoteFile, bool overwrite, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	localFile	Local file.
string	remoteFile	Remote file.
bool	overwrite	True to overwrite if already present.
AsyncCallback	callback	Callback method.
object	state	State.

Returns

Type	Description
IAsyncResult	\Result object.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

BeginRemoveDirectory(string, bool, AsyncCallback, object)

Starts an remove directory operation.

Declaration

public IAsyncResult BeginRemoveDirectory(string path, bool recursive, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	path	Path of directory.
bool	recursive	True, to remove directory recursively.
AsyncCallback	callback	Callback.
object	state	State.

Returns

Type	Description
IAsyncResult	\Result object.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

BeginRemoveFile(string, AsyncCallback, object)

Starts a remove file operation.

Declaration

public IAsyncResult BeginRemoveFile(string path, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	path	\File to remove.
AsyncCallback	callback	Callback.
object	state	State.

Returns

Type	Description
IAsyncResult	\Result object.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

BeginRename(string, string, AsyncCallback, object)

Starts a new rename operation.

Declaration

public IAsyncResult BeginRename(string path, string name, AsyncCallback callback, object state)

Parameters

Type	Name	Description
string	path	Path to file or directory to rename.
string	name	New name.
AsyncCallback	callback	Callback.
object	state	State object.

Returns

Type	Description
IAsyncResult	AsyncResult object.

Remarks

Requires the WriteFtp and the ReadFtp grants.

CopyDirectory(string, string)

Copies a directory locally on the controller.

Declaration

public void CopyDirectory(string source, string destination)

Parameters

Type	Name	Description
string	source	Source directory.
string	destination	Destination directory.

Remarks

Requires the WriteFtp and the ReadFtp grants.

CopyDirectory(string, string, bool)

Copies a directory locally on the controller.

Declaration

public void CopyDirectory(string source, string destination, bool overwrite)

Parameters

Type	Name	Description
string	source	Source directory.
string	destination	Destination directory.
bool	overwrite	True replace any exists directory.

Remarks

Requires the WriteFtp and the ReadFtp grants.

CopyFile(string, string)

Copies a file locally on the controller, from the source to the destination.

Declaration

public void CopyFile(string source, string destination)

Parameters

Type	Name	Description
string	source	Source to copy.
string	destination	Destination.

Remarks

Requires the WriteFtp and the ReadFtp grants.

CopyFile(string, string, bool)

Copies a file locally on the controller, from the source to the destination.

Declaration

public void CopyFile(string source, string destination, bool overwrite)

Parameters

Type	Name	Description
string	source	Source to copy.
string	destination	Destination.
bool	overwrite	True to overwrite any existing \file.

Remarks

Requires the WriteFtp and the ReadFtp grants.

CreateDirectory(string)

Creates a directory on the Robot Controller.

Declaration

public ControllerDirectoryInfo CreateDirectory(string name)

Parameters

Type	Name	Description
string	name	Name of the directory to create.

Returns

Type	Description
ControllerDirectoryInfo

Remarks

The directory is created under the directorys specified by the property RemoteDirectory

DirectoryExists(string)

Verifies that a directory exists.

Declaration

public bool DirectoryExists(string path)

Parameters

Type	Name	Description
string	path	Path to directory.

Returns

Type	Description
bool	True if the directory exist.

Remarks

Requires the ReadFtp grant.

EndCopyDirectory(IAsyncResult)

Ends an async directory copy operation.

Declaration

public void EndCopyDirectory(IAsyncResult result)

Parameters

Type	Name	Description
IAsyncResult	result	Result object from BeginCopyFile operation.

EndCopyFile(IAsyncResult)

Ends an async file copy operation.

Declaration

public void EndCopyFile(IAsyncResult result)

Parameters

Type	Name	Description
IAsyncResult	result	Result object from BeginCopyFile operation.

EndCreateDirectory(IAsyncResult)

End an async directory creation operation.

Declaration

public ControllerDirectoryInfo EndCreateDirectory(IAsyncResult result)

Parameters

Type	Name	Description
IAsyncResult	result	AsyncResult from start operation.

Returns

Type	Description
ControllerDirectoryInfo	Info object for directory.

EndDirectoryExists(IAsyncResult)

Ends the directory exists operation.

Declaration

public bool EndDirectoryExists(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Result from BeginDirectoryExists.

Returns

Type	Description
bool	True if the file exists, otherwise false.

EndFileExists(IAsyncResult)

Ends a FileExists operation.

Declaration

public bool EndFileExists(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	AsyncResult.

Returns

Type	Description
bool	true if file exists.

EndGetDirectory(IAsyncResult)

Ends a GetDirectory operation.

Declaration

public string EndGetDirectory(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Async resul.t

Returns

Type	Description
string	Path to local directory.

EndGetFile(IAsyncResult)

Ends a get file operation.

Declaration

public string EndGetFile(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Async result.

Returns

Type	Description
string	Path to local file.

EndListDirectory(IAsyncResult)

Ends a list directory operation.

Declaration

public ControllerFileSystemInfo[] EndListDirectory(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Async result.

Returns

Type	Description
ControllerFileSystemInfo[]	The matching file entries.

EndPutDirectory(IAsyncResult)

Ends a put directory operation.

Declaration

public string EndPutDirectory(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Async result.

Returns

Type	Description
string	Path to remote directory.

EndPutFile(IAsyncResult)

Ends an PutFile operation.

Declaration

public string EndPutFile(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Async result.

Returns

Type	Description
string	Destination path.

EndRemoveDirectory(IAsyncResult)

Ends an RemoveDirectory operation.

Declaration

public void EndRemoveDirectory(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Result.

EndRemoveFile(IAsyncResult)

Ends an RemoveFile operation.

Declaration

public void EndRemoveFile(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	Result.

EndRename(IAsyncResult)

Ends the rename operation.

Declaration

public string EndRename(IAsyncResult ar)

Parameters

Type	Name	Description
IAsyncResult	ar	AsyncResult.

Returns

Type	Description
string	New path.

FileExists(string)

Checks if the file exists.

Declaration

public bool FileExists(string name)

Parameters

Type	Name	Description
string	name	Name of file.

Returns

Type	Description
bool	true if file exists, otherwise false.

Remarks

Requires the ReadFtp grant.

GetDirectory(string)

Get a remote directory, creates a local directory with the same name as the remote.

Declaration

public void GetDirectory(string remoteDirectory)

Parameters

Type	Name	Description
string	remoteDirectory	Remote directory.

Remarks

Requires the ReadFtp grant.

GetDirectory(string, bool)

Get a remote directory, creates a local directory with the same name as the remote.

Declaration

public void GetDirectory(string remoteDirectory, bool overwrite)

Parameters

Type	Name	Description
string	remoteDirectory	Remote directory.
bool	overwrite	true to overwrite any existing local directory.

Remarks

Requires the ReadFtp grant.

GetDirectory(string, string)

Gets a complete directory recursively.

Declaration

public void GetDirectory(string remoteDirectory, string localDirectory)

Parameters

Type	Name	Description
string	remoteDirectory	Name of remote directory.
string	localDirectory	Name of local directory.

Remarks

Requires the ReadFtp grant.

GetDirectory(string, string, bool)

Gets a complete directory recursively.

Declaration

public void GetDirectory(string remoteDirectory, string localDirectory, bool overwrite)

Parameters

Type	Name	Description
string	remoteDirectory	Name of remote directory.
string	localDirectory	Name of local directory.
bool	overwrite	true to overwrite any existing local directories.

Remarks

Requires the ReadFtp grant.

GetDirectoryAccessTime(string)

Gets the accesstime for a directory.

Declaration

public DateTime GetDirectoryAccessTime(string directory)

Parameters

Type	Name	Description
string	directory	Directory to get access time for.

Returns

Type	Description
DateTime	DateTime for last access.

Remarks

Requires the ReadFtp grant.

GetDirectoryAttributes(string)

Gets the attributes for a directory.

Declaration

public FileAttributes GetDirectoryAttributes(string directory)

Parameters

Type	Name	Description
string	directory	Name of directory.

Returns

Type	Description
FileAttributes	Attribute of directory.

Remarks

Requires the ReadFtp grant.

GetDirectoryCreationTime(string)

Gets the creation time for a directory.

Declaration

public DateTime GetDirectoryCreationTime(string directory)

Parameters

Type	Name	Description
string	directory	Name of directory.

Returns

Type	Description
DateTime	Time of creation.

Remarks

Requires the ReadFtp grant.

GetDirectoryWriteTime(string)

Gets the last write time for a directory.

Declaration

public DateTime GetDirectoryWriteTime(string directory)

Parameters

Type	Name	Description
string	directory	Name of directory.

Returns

Type	Description
DateTime	Last write time.

Remarks

Requires the ReadFtp grant.

GetFile(string)

Gets a file from the Robot Controller and stores it on the local system. Stores file locally with same name as on the controller.

Declaration

public void GetFile(string remoteFile)

Parameters

Type	Name	Description
string	remoteFile	Name of a file to retrieve from the Robot Controller.

Remarks

Requires the ReadFtp grant.

GetFile(string, bool)

Gets a file from the Robot Controller and stores it on the local system. Stores file locally with same name as on the controller.

Declaration

public void GetFile(string remoteFile, bool overwrite)

Parameters

Type	Name	Description
string	remoteFile	Name of a file to retrieve from the Robot Controller.
bool	overwrite	true, to overwrite local file.

Remarks

Requires the ReadFtp grant.

Exceptions

Type	Condition
InvalidOperationException	The file to overwrite is Read-only.

GetFile(string, string)

Gets a file from the Robot Controller and stores it on the local system.

Declaration

public void GetFile(string remoteFile, string localFile)

Parameters

Type	Name	Description
string	remoteFile	Name of a file to retrieve from the Robot Controller.
string	localFile	Name of the file to create in the local file system.

Remarks

Requires the ReadFtp grant.

GetFile(string, string, bool)

Gets a file from the Robot Controller and stores it on the local system.

Declaration

public void GetFile(string remoteFile, string localFile, bool overwrite)

Parameters

Type	Name	Description
string	remoteFile	Name of a file to retrieve from the Robot Controller.
string	localFile	Name of the file to create on the local system.
bool	overwrite	true, to overwrite local file.

Remarks

Requires the ReadFtp grant.

Exceptions

Type	Condition
InvalidOperationException	The file to overwrite is Read-only.

GetFileAccessTime(string)

Gets the last access time for a file.

Declaration

public DateTime GetFileAccessTime(string file)

Parameters

Type	Name	Description
string	file	Name of remote file.

Returns

Type	Description
DateTime	DateTime for last access.

Remarks

Requires the ReadFtp grant.

GetFileAttributes(string)

Gets the file attributes for a remote file.

Declaration

public FileAttributes GetFileAttributes(string file)

Parameters

Type	Name	Description
string	file	Name of remote file.

Returns

Type	Description
FileAttributes	FileAttributes for file.

Remarks

Requires the ReadFtp grant.

GetFileCreationTime(string)

Get the time of creation for a file.

Declaration

public DateTime GetFileCreationTime(string file)

Parameters

Type	Name	Description
string	file	Name of remote file.

Returns

Type	Description
DateTime	Time of creation.

Remarks

Requires the ReadFtp grant.

GetFileWriteTime(string)

Gets the last write time for the remote file.

Declaration

public DateTime GetFileWriteTime(string file)

Parameters

Type	Name	Description
string	file	Name of remote file.

Returns

Type	Description
DateTime	Last write time.

Remarks

Requires the ReadFtp grant.

GetFilesAndDirectories(string)

Returns the info objects of files and directories on the controller file system that matches the specified search pattern. To get the list of files and directories use the search pattern "*".

Declaration

public ControllerFileSystemInfo[] GetFilesAndDirectories(string searchPattern)

Parameters

Type	Name	Description
string	searchPattern	The search string to match against the names of files in path.

Returns

Type	Description
ControllerFileSystemInfo[]	An array of ControllerFileSystemInfo objects matching the search criteria.

Remarks

Requires the ReadFtp grant.

GetLocalPath(string)

Gets the combined path from name and LocalDirectory.

Declaration

public string GetLocalPath(string name)

Parameters

Type	Name	Description
string	name	Filename.

Returns

Type	Description
string	Complete local path.

GetRemotePath(string)

Gets the combined path from name and RemoteDirectory.

Declaration

public string GetRemotePath(string name)

Parameters

Type	Name	Description
string	name	Name of file or directory.

Returns

Type	Description
string	Combined path.

GetSize(string)

Gets the size of a file.

Declaration

public long GetSize(string name)

Parameters

Type	Name	Description
string	name	Name of file.

Returns

Type	Description
long	The size of the file in bytes.

Remarks

Requires the ReadFtp grant.

GetStorageDevices()

Gets all available drives.

Declaration

public StorageDeviceInfo[] GetStorageDevices()

Returns

Type	Description
StorageDeviceInfo[]	Array of available drives.

PutDirectory(string)

Puts a directory from the local computer to the filesytem of the controller.

Declaration

public void PutDirectory(string localDirectory)

Parameters

Type	Name	Description
string	localDirectory	Name of local directory.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

PutDirectory(string, bool)

Puts a directory from the local computer to the filesytem of the controller.

Declaration

public void PutDirectory(string localDirectory, bool overwrite)

Parameters

Type	Name	Description
string	localDirectory	Name of local directory.
bool	overwrite	true to overwrite remote directory if already present.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

PutDirectory(string, string)

Puts a directory from the local computer to the filesytem of the controller.

Declaration

public void PutDirectory(string localDirectory, string remoteDirectory)

Parameters

Type	Name	Description
string	localDirectory	Name of local directory.
string	remoteDirectory	Name of remote directory.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

PutDirectory(string, string, bool)

Puts a directory from the local computer to the filesytem of the controller.

Declaration

public void PutDirectory(string localDirectory, string remoteDirectory, bool overwrite)

Parameters

Type	Name	Description
string	localDirectory	Name of local directory.
string	remoteDirectory	Name of remote directory.
bool	overwrite	true to overwrite remote directory if already present.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

PutFile(string)

Stores a file from the local system to the Robot Controller.

Declaration

public void PutFile(string localFile)

Parameters

Type	Name	Description
string	localFile	Name of a file to send from the local system.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

PutFile(string, bool)

Stores a file from the local system to the Robot Controller.

Declaration

public void PutFile(string localFile, bool overwrite)

Parameters

Type	Name	Description
string	localFile	Name of a file to send from the local system.
bool	overwrite	true, to overwrite existing file.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

PutFile(string, string)

Stores a file from the local system to the Robot Controller.

Declaration

public void PutFile(string localFile, string remoteFile)

Parameters

Type	Name	Description
string	localFile	Name of a file to send from the local system.
string	remoteFile	Name of the file to create on the Robot Controller.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

PutFile(string, string, bool)

Stores a file from the local system to the Robot Controller.

Declaration

public void PutFile(string localFile, string remoteFile, bool overwrite)

Parameters

Type	Name	Description
string	localFile	Name of a file to send from the local system.
string	remoteFile	Name of the file to create on the Robot Controller.
bool	overwrite	true, to overwrite existing file.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

RemoveDirectory(string)

Removes the specified directory from Robot Controller.

Declaration

public void RemoveDirectory(string path)

Parameters

Type	Name	Description
string	path	Path of the directory to be removed.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

RemoveDirectory(string, bool)

Removes the specified directory from Robot Controller.

Declaration

public void RemoveDirectory(string path, bool recursive)

Parameters

Type	Name	Description
string	path	Path of the directory to be removed.
bool	recursive	True to remove all directories recursively.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

RemoveFile(string)

Deletes the specified file from the Robot Controller.

Declaration

public void RemoveFile(string path)

Parameters

Type	Name	Description
string	path	Name of the file to remove.

Remarks

Requires the UAS_WRITE_FTP WriteFtp.

RenameDirectory(string, string)

Renames the specified directory on the Robot Controller.

Declaration

public void RenameDirectory(string existingDirectory, string newName)

Parameters

Type	Name	Description
string	existingDirectory	Name of the directory to be renamed.
string	newName	New name of the directory.

Remarks

Requires the WriteFtp and the ReadFtp grants.

RenameFile(string, string)

Renames the specified file on the Robot Controller.

Declaration

public void RenameFile(string existingFile, string newName)

Parameters

Type	Name	Description
string	existingFile	Name of the file to be renamed.
string	newName	New name of the file.

Remarks

Requires the WriteFtp and the ReadFtp grants.

Implements

IComparable

INamedObject

IDisposable

IFileSystem