Class VirtualController

Administration class for virtual controller objects.

Inheritance

object

MarshalByRefObject

VirtualController

Implements

IDisposable

Inherited Members

MarshalByRefObject.MemberwiseClone(bool)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.CreateObjRef(Type)

Namespace: ABB.Robotics.Controllers

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public class VirtualController : MarshalByRefObject, IDisposable

Constructors

VirtualController(DirectoryInfo)

Creates a virtual controller object.

Declaration

public VirtualController(DirectoryInfo path)

Parameters

Type	Name	Description
DirectoryInfo	path	Path to system directory.

Properties

Info

Gets the ControllerInfo object for this virtual controller.

Declaration

public ControllerInfo Info { get; }

Property Value

Type	Description
ControllerInfo

Panel

Gets a virtual panel for this virtual controller.

Declaration

[Obsolete("use VirtualPanel.Attach() instead")]
public VirtualPanel Panel { get; }

Property Value

Type	Description
VirtualPanel

Path

Path to the system directory.

Declaration

public DirectoryInfo Path { get; }

Property Value

Type	Description
DirectoryInfo

StartTimeout

Sets the timeout for start operations.

Declaration

public static int StartTimeout { set; }

Property Value

Type	Description
int

State

Gets the current state of the Virtual Controller object.

Declaration

public VirtualControllersate State { get; }

Property Value

Type	Description
VirtualControllersate

Methods

Attach(ControllerInfo)

Attaches a virtual controller object to an existing virtual controller.

Declaration

public static VirtualController Attach(ControllerInfo controller)

Parameters

Type	Name	Description
ControllerInfo	controller	Controller to attach.

Returns

Type	Description
VirtualController	The attached controller.

Attach(Guid)

Attaches a virtual controller object.

Declaration

public static VirtualController Attach(Guid systemId)

Parameters

Type	Name	Description
Guid	systemId	System id for controller to attach.

Returns

Type	Description
VirtualController	The attached controller.

BeginStart(ControllerStartMode, AsyncCallback, object, ControllerLogOptions)

Begins a async start controller operation.

Declaration

public IAsyncResult BeginStart(ControllerStartMode mode, AsyncCallback callback, object state, ControllerLogOptions logOptions = ControllerLogOptions.NoChange)

Parameters

Type	Name	Description
ControllerStartMode	mode	Start behavior of controller.
AsyncCallback	callback	Callback to call when operation completes.
object	state	State for this operation. If this is null then the current object will be stored in state.
ControllerLogOptions	logOptions	Log options of controller.

Returns

Type	Description
IAsyncResult	The async result for this operation.

BeginStart(DirectoryInfo, ControllerStartMode, AsyncCallback)

Begins a async start controller operation. The state will contain the VirtualController object.

Declaration

public static IAsyncResult BeginStart(DirectoryInfo path, ControllerStartMode mode, AsyncCallback callback)

Parameters

Type	Name	Description
DirectoryInfo	path	System path.
ControllerStartMode	mode	Start behavior of controller.
AsyncCallback	callback	Callback to call when operation completes.

Returns

Type	Description
IAsyncResult	The async result for this operation.

BeginStart(DirectoryInfo, ControllerStartMode, AsyncCallback, ControllerLogOptions)

Begins a async start controller operation. The state will contain the VirtualController object.

Declaration

public static IAsyncResult BeginStart(DirectoryInfo path, ControllerStartMode mode, AsyncCallback callback, ControllerLogOptions logOptions)

Parameters

Type	Name	Description
DirectoryInfo	path	System path.
ControllerStartMode	mode	Start behavior of controller.
AsyncCallback	callback	Callback to call when operation completes.
ControllerLogOptions	logOptions	Log options of controller.

Returns

Type	Description
IAsyncResult	The async result for this operation.

Detach()

Detaches the current controller from this object. This operation can not be undone without creating a new object.

Declaration

public void Detach()

Dispose()

Disposes the current VC object, if connect it will disconnect.

Declaration

public void Dispose()

EndStart(IAsyncResult)

Ends the async start operation.

Declaration

public void EndStart(IAsyncResult result)

Parameters

Type	Name	Description
IAsyncResult	result	Result from BeginStart operation.

GetSystemId(DirectoryInfo)

Gets the System id from the path.

Declaration

public static Guid GetSystemId(DirectoryInfo directory)

Parameters

Type	Name	Description
DirectoryInfo	directory	Virtual controller directory.

Returns

Type	Description
Guid	The system id of the system.

GetSystemId(string)

Gets the System id from the path.

Declaration

public static Guid GetSystemId(string directory)

Parameters

Type	Name	Description
string	directory	Virtual controller directory.

Returns

Type	Description
Guid	The system id of the system.

Start(DirectoryInfo)

Starts a new VirtualController.

Declaration

public static VirtualController Start(DirectoryInfo path)

Parameters

Type	Name	Description
DirectoryInfo	path	System path.

Returns

Type	Description
VirtualController	The virtual controller object.

Start(DirectoryInfo, ControllerLogOptions)

Starts a new VirtualController.

Declaration

public static VirtualController Start(DirectoryInfo path, ControllerLogOptions logOptions)

Parameters

Type	Name	Description
DirectoryInfo	path	System path.
ControllerLogOptions	logOptions	Log options of controller.

Returns

Type	Description
VirtualController	The virtual controller object.

Start(DirectoryInfo, ControllerStartMode)

Starts a new VirtualController.

Declaration

public static VirtualController Start(DirectoryInfo path, ControllerStartMode mode)

Parameters

Type	Name	Description
DirectoryInfo	path	System path.
ControllerStartMode	mode	Controlls the start behavior of the controller.

Returns

Type	Description
VirtualController	The virtual controller object.

Start(DirectoryInfo, ControllerStartMode, ControllerLogOptions)

Starts a new VirtualController.

Declaration

public static VirtualController Start(DirectoryInfo path, ControllerStartMode mode, ControllerLogOptions logOptions)

Parameters

Type	Name	Description
DirectoryInfo	path	System path.
ControllerStartMode	mode	Controlls the start behavior of the controller.
ControllerLogOptions	logOptions	Log options of controller.

Returns

Type	Description
VirtualController	The virtual controller object.

Stop()

Stops the virtual controller. The controller must be started before this method can succeed.

Declaration

public void Stop()

Implements

IDisposable