Class BackupManager

This class handles backup / restore operations.

Inheritance
System.Object
NamedObject
SDKBase
SDKControllerBoundBase
BackupManager
Implements
System.IComparable
System.IDisposable
Inherited Members
Namespace: ABB.Robotics.Controllers
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public class BackupManager : SDKControllerBoundBase, IComparable, INamedObject, IDisposable

Constructors

BackupManager(Controller)

Creates a backup manager object for the supplied controller instance.

Declaration
public BackupManager(Controller controller)
Parameters
Type Name Description
Controller controller

Controller to create a backup manager for.

Properties

BackupDirectory

Gets the path to the backup directory of the controller.

Declaration
public string BackupDirectory { get; }
Property Value
Type Description
System.String

DefaultExtension

Gets the default extension of a backup file.

Declaration
public string DefaultExtension { get; }
Property Value
Type Description
System.String

IgnoredMismatches

Gets/Sets the ignore flag for restores.

Declaration
public RestoreIgnores IgnoredMismatches { get; set; }
Property Value
Type Description
RestoreIgnores

Includes

Controls what data that shall be included during the restore operation.

Declaration
public RestoreIncludes Includes { get; set; }
Property Value
Type Description
RestoreIncludes

InProgress

Flag that indicates if a backup operation is in progress or not.

Declaration
public bool InProgress { get; }
Property Value
Type Description
System.Boolean

LocalDirectory

Gets/Sets the local directory where the backup will be downloaded or uploaded from. The default value if the current directory. The directory must exist.

Declaration
public DirectoryInfo LocalDirectory { get; set; }
Property Value
Type Description
System.IO.DirectoryInfo

LocalName

Gets/Sets the local name.

Declaration
public string LocalName { get; set; }
Property Value
Type Description
System.String

RemoveBackupDirectory

Gets/Sets a value to indicate if the backup directory shall be removed from the controller after the operation has completed.

Declaration
public bool RemoveBackupDirectory { get; set; }
Property Value
Type Description
System.Boolean

TransferBackup

Gets/Sets a flag to indicate if the backup shall be transfered to/from the controller prior/after the restore/backup operation. The file to transfer to/from is indicated by the LocalDirectory + LocalName properties.

Declaration
public bool TransferBackup { get; set; }
Property Value
Type Description
System.Boolean

Methods

Backup()

Starts a backup operation.

Declaration
public void Backup()

BeginBackup(AsyncCallback, Object)

Starts an async backup operation.

Declaration
public IAsyncResult BeginBackup(AsyncCallback callback, object state)
Parameters
Type Name Description
System.AsyncCallback callback

Callback operation for completion notification
System.Object state

Operation state for user.
Returns
Type Description
System.IAsyncResult

Async result.

ClearBackupDirectory()

Deletes all backups stored in the /Backup directory of the controller.

Declaration
public void ClearBackupDirectory()

Dispose(Boolean)

Disposes the specified disposing.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

if set to true [disposing].
Overrides

EndBackup(IAsyncResult)

Completes the backup operation.

Declaration
public void EndBackup(IAsyncResult result)
Parameters
Type Name Description
System.IAsyncResult result

Result from begin backup operation.

Finalize()

Releases unmanaged resources and performs other cleanup operations before the BackupManager is reclaimed by garbage collection.

Declaration
protected void Finalize()

GetBackupDirectory(Controller)

Gets the backup directory from a controller object.

Declaration
public static string GetBackupDirectory(Controller controller)
Parameters
Type Name Description
Controller controller

Controller to get backup directory path from.
Returns
Type Description
System.String

The path to the backup directory for the controller.

GetBackups()

Returns all available backups in the /Backup directory.

Declaration
public Backup[] GetBackups()
Returns
Type Description
Backup[]

Restore()

Starts a restore operation.

Declaration
public void Restore()

Restore(DirectoryInfo, String)

Starts a restore operation from the dir and name.

Declaration
public void Restore(DirectoryInfo localDir, string name)
Parameters
Type Name Description
System.IO.DirectoryInfo localDir

Directory to start from.
System.String name

Name of file.

Restore(FileInfo)

Starts a restore operation with a the specified file.

Declaration
public void Restore(FileInfo file)
Parameters
Type Name Description
System.IO.FileInfo file

Restore(String)

Starts a restore operation from the local name.

Declaration
public void Restore(string localName)
Parameters
Type Name Description
System.String localName

LocalName to start restore from.

Restore(String, String)

Starts a restore operation from the dir and name.

Declaration
public void Restore(string localDir, string localName)
Parameters
Type Name Description
System.String localDir

Directory containing the file.
System.String localName

Filename to use during restore.

Implements

System.IComparable
System.IDisposable