Class VirtualPanel
handles all specific functions that are specific to the virtual controller. Through this interface we can change most "settings" on the panel of the controller.
Implements
Inherited Members
Namespace: ABB.Robotics.Controllers
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public sealed class VirtualPanel : MarshalByRefObject, IDisposable
Properties
AcknowledgeModeChanges
Gets / sets the acknowledge behavior of mode changes.
Declaration
[Obsolete("VirtualPanel.ChangeMode() always acknowledges mode changes automatically.")]
public bool AcknowledgeModeChanges { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
Attach(Controller)
attaches a panel object to a controller
Declaration
public static VirtualPanel Attach(Controller controller)
Parameters
Type | Name | Description |
---|---|---|
Controller | controller | controller to attach, must be virtual |
Returns
Type | Description |
---|---|
VirtualPanel | the panel object |
BeginChangeOperatingMode(ControllerOperatingMode, AsyncCallback, Object)
Starts an asynchronous operating-mode change operation. Mode changes are automatically acknowledged.
Declaration
public IAsyncResult BeginChangeOperatingMode(ControllerOperatingMode newMode, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
ControllerOperatingMode | newMode | New mode of controller. |
AsyncCallback | callback | Callback of completion routine. |
Object | state | User defined state object. |
Returns
Type | Description |
---|---|
IAsyncResult | Async result. |
BeginChangeState(ControllerState, AsyncCallback)
Starts an asynchronous state change operation of controller.
Declaration
public IAsyncResult BeginChangeState(ControllerState newState, AsyncCallback callback)
Parameters
Type | Name | Description |
---|---|---|
ControllerState | newState | New state of controller. |
AsyncCallback | callback | Callback of completion routine. |
Returns
Type | Description |
---|---|
IAsyncResult | Async result. |
ChangeMode(ControllerOperatingMode)
New controller operating mode, no Change modes are valid.
Declaration
public void ChangeMode(ControllerOperatingMode newMode)
Parameters
Type | Name | Description |
---|---|---|
ControllerOperatingMode | newMode | New controller operating mode. |
ChangeMode(ControllerOperatingMode, Int32)
Starts a change operating mode and waits for specifed time for the operation to complete. Throws a timeout exception if the new mode isn't reached in the specified time. Mode changes are automatically acknowledged.
Declaration
public void ChangeMode(ControllerOperatingMode newMode, int timeout)
Parameters
Type | Name | Description |
---|---|---|
ControllerOperatingMode | newMode | New mode of the Controller. |
Int32 | timeout | Max time in milliseconds to reach new mode. |
ChangeMode(ControllerOperatingMode, TimeSpan)
Starts a change operating mode and waits for specifed time for the operation to complete. Throws a timeout exception if the new mode isn't reached in the specified time. Mode changes are automatically acknowledged.
Declaration
public void ChangeMode(ControllerOperatingMode newMode, TimeSpan timeout)
Parameters
Type | Name | Description |
---|---|---|
ControllerOperatingMode | newMode | New mode of the Controller. |
TimeSpan | timeout | Max time to reach new mode. |
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
EnableDevice(ControllerEnableState)
Enable or disable the device.
Declaration
public void EnableDevice(ControllerEnableState state)
Parameters
Type | Name | Description |
---|---|---|
ControllerEnableState | state | New enable state of the device. |
EndChangeOperatingMode(IAsyncResult)
This completes the change operating mode async operation.
Declaration
public void EndChangeOperatingMode(IAsyncResult result)
Parameters
Type | Name | Description |
---|---|---|
IAsyncResult | result |
Finalize()
Makes sure to disconnect any existing subscriptions.
Declaration
protected void Finalize()