Class RobotStudioAPI

Intended for internal use only.

Inheritance

object

RobotStudioAPI

Namespace: ABB.Robotics.RobotStudio

Assembly: ABB.Robotics.RobotStudio.dll

Syntax

public static class RobotStudioAPI

Properties

DataDirectory

Gets path to the directory where RobotStudios data files are stored, typically equal to the installation directory.

Declaration

public static string DataDirectory { get; }

Property Value

Type	Description
string

EnableProjectObjectChangedEvents

Used to temporarily disable the ProjectObjectChanged event.

Declaration

public static bool EnableProjectObjectChangedEvents { get; set; }

Property Value

Type	Description
bool

Initialized

Gets a value that indicates if the API has been properly initialized.

Declaration

public static bool Initialized { get; }

Property Value

Type	Description
bool

IsAddinHost

Gets if the running application is a minimal add-in host rather than the full RobotStudio executable.

Declaration

public static bool IsAddinHost { get; }

Property Value

Type	Description
bool

IsCondemned

Can be set before starting shutdown. Acts as a hint that proper cleanup of memory is not needed (if time consuming), since the process is about to die anyway.

Declaration

public static bool IsCondemned { get; set; }

Property Value

Type	Description
bool

MainThread

Gets the main (GUI) System.Threading.Thread of the application.

Declaration

public static Thread MainThread { get; }

Property Value

Type	Description
Thread

Platform

Provides platform-specific functionality that differs in imeplementation between e.g. Windows and Linux.

Declaration

public static IPlatformAbstraction Platform { get; set; }

Property Value

Type	Description
IPlatformAbstraction

Remarks

Internal use only.

SyncContext

Represents the synchronization context that most API methods must be called on.

Declaration

public static SynchronizationContext SyncContext { get; }

Property Value

Type	Description
SynchronizationContext

SynchronizeInvoke

Internal use only.

Declaration

public static ISynchronizeInvoke SynchronizeInvoke { get; }

Property Value

Type	Description
ISynchronizeInvoke

Version

Gets the application version number.

Declaration

public static Version Version { get; }

Property Value

Type	Description
Version

Methods

AssertMainThread()

Declaration

[Conditional("DEBUG")]
public static void AssertMainThread()

Initialize()

Performs initialization necessary before any other API can be used.

Declaration

public static void Initialize()

Initialize(string)

Performs initialization necessary before any other API can be used.

Declaration

public static void Initialize(string dataDirectory)

Parameters

Type	Name	Description
string	dataDirectory

RunOnMainThread(Action)

Runs an action on the main (GUI) application thread.

Declaration

public static void RunOnMainThread(Action a)

Parameters

Type	Name	Description
Action	a	Action to execute

Remarks

If calling from the main thread the action is executed synchronously without error handling.

RunOnMainThread(Action, bool)

Runs an action on the main (GUI) application thread.

Declaration

public static void RunOnMainThread(Action a, bool throwOnFailureToExecute)

Parameters

Type	Name	Description
Action	a	Action to execute
bool	throwOnFailureToExecute	True to throw an System.InvalidOperationException if the main thread could not be used, typically if the application is in startup or shutdown phase.

Remarks

If calling from the main thread the action is executed synchronously without error handling.

Shutdown()

Performs cleanup before exiting the application. After calling this no other API can be used.

Declaration

public static void Shutdown()

Events

ShuttingDown

Occurs when Shutdown() is called.

Declaration

public static event EventHandler ShuttingDown

Event Type

Type	Description
EventHandler