Class StationServices

Contains high-level methods for working with stations.

Inheritance

object

StationServices

Namespace: ABB.Robotics.RobotStudio.Stations

Assembly: ABB.Robotics.RobotStudio.Stations.dll

Syntax

public static class StationServices

Methods

PackAndGo(Station, string)

Creates a Pack & Go file which includes a station and its dependencies. If the station file is saved inside a Solution folder, additional folders in the solution folder will be included.

Declaration

public static PackAndGoResult PackAndGo(Station station, string path)

Parameters

Type	Name	Description
Station	station	Station to pack.
string	path	Path to the Pack & Go (.rspag) file.

Returns

Type	Description
PackAndGoResult

Remarks

It is possible to add custom folders to a solution folder in addition to the folders created by RobotStudio, like Stations and Libraries. A developer of an Add-In which is creating, or reading from, such folders must make sure to use unique folder names to avoid conflicts with other Add-Ins, as well as with future standard folders of RobotStudio like, Stations, Libraries and Backups. It is strongly suggested to store Add-In specific content under a folder with the same name as the Add-Ins application ID. This method uses an undo step to roll back any changes made to the station. If the call is wrapped in an outer undo step, make sure it is closed immediately and does not contain any other changes.

PackAndGo(Station, string, PackAndGoLibraryCopyOptions, PackAndGoLibraryCopyOptions)

Creates a Pack & Go file which includes a station and its dependencies.

Declaration

public static PackAndGoResult PackAndGo(Station station, string path, PackAndGoLibraryCopyOptions libraryCopyOptions, PackAndGoLibraryCopyOptions abbLibraryCopyOptions)

Parameters

Type	Name	Description
Station	station	Station to pack.
string	path	Path to the Pack & Go (.rspag) file.
PackAndGoLibraryCopyOptions	libraryCopyOptions	Specifies how libraries should be packed.
PackAndGoLibraryCopyOptions	abbLibraryCopyOptions	Specifies how ABB libraries should be packed.

Returns

Type	Description
PackAndGoResult

Remarks

This method uses an undo step to roll back any changes made to the station. If the call is wrapped in an outer undo step, make sure it is closed immediately and does not contain any other changes.

PackAndGo(Station, string, PackAndGoLibraryCopyOptions, bool, bool, bool)

Creates a Pack & Go file which includes a station and its dependencies.

Declaration

public static PackAndGoResult PackAndGo(Station station, string path, PackAndGoLibraryCopyOptions libraryCopyOptions, bool abbLibraries, bool includeBackup, bool includeExternalMedia)

Parameters

Type	Name	Description
Station	station	Station to pack.
string	path	Path to the Pack & Go (.rspag) file.
PackAndGoLibraryCopyOptions	libraryCopyOptions	Specifies how libraries should be packed.
bool	abbLibraries	Include standard ABB library files in the package. Normally this is not needed.
bool	includeBackup	Include backups of controller systems.
bool	includeExternalMedia	Include media for external controller options.

Returns

Type	Description
PackAndGoResult

Remarks

This method uses an undo step to roll back any changes made to the station. If the call is wrapped in an outer undo step, make sure it is closed immediately and does not contain any other changes.

UnpackAndWork(string, string, bool)

Declaration

[Obsolete("Use UnpackAndWorkAsync() instead")]
public static PackAndGoResult UnpackAndWork(string filePath, string destinationPath, bool overwrite)

Parameters

Type	Name	Description
string	filePath
string	destinationPath
bool	overwrite

Returns

Type	Description
PackAndGoResult

UnpackAndWork(string, string, string, bool, bool)

Declaration

[Obsolete("Use UnpackAndWorkAsync() instead")]
public static PackAndGoResult UnpackAndWork(string filePath, string destinationPath, string mediaPoolPath, bool restoreBackup, bool overwrite)

Parameters

Type	Name	Description
string	filePath
string	destinationPath
string	mediaPoolPath
bool	restoreBackup
bool	overwrite

Returns

Type	Description
PackAndGoResult

UnpackAndWorkAsync(string, string, string, bool, bool, bool)

Unpacks a Pack & Go and optonally loads the contained station.

Declaration

public static Task<PackAndGoResult> UnpackAndWorkAsync(string filePath, string destinationPath, string mediaPoolPath = "", bool restoreBackup = true, bool overwrite = true, bool loadStation = true)

Parameters

Type	Name	Description
string	filePath
string	destinationPath
string	mediaPoolPath
bool	restoreBackup
bool	overwrite
bool	loadStation	True if the unpacked station should be loaded in RobotStudio and become the active station, false to not load the station.

Returns

Type	Description
Task<PackAndGoResult>	The containing the result of the Unpack & Work operation. Success indicates sucess or failure.