Namespace ABB.Robotics.Controllers
Classes
AuthenticationException
An exception of this class is thrown if no specialized type is found.
Backup
Contains information about a backup on the controller.
BackupEventArgs
Event data from a restore event.
BackupException
This exception is thrown whenever a backup fails.
BackupManager
This class handles backup / restore operations.
ConfigurationHandler
this class handles the internal configuration of the controller api. This class must be public with a default ctor to enable reflection creation from the runtime when the configuration is requested.
Todo when adding a new section:
- Create a new parser method with signature void Method();
- Implement the parser with a simple check for the section and a trace if the section is missing.
- Add trace statements to TraceConfiguration().
- Create default values on the CapiConfig class to keep the api less sensitive to bad config files.
- Register the parser _sectionParsers array to enable execution.
ConnectionChangedEventArgs
This class is the event argument from a controller connection changed event.
ConnectionType
Defines the controller connection and authentication management.
Controller
The main entry point for any operation against the controller.
ControllerBoundStream
Stream object against a controller.
ControllerBufferOverflowException
An exception of this class is thrown if no specialized type is found.
ControllerEventArgs
Base class of all event args from the controller since they always contain a timestamp of the event.
ControllerFactory
utility class that creates controller instances from a ControllerInfo instance
ControllerInfo
This class contains the "simple" information that is available about a controller without connecting to it
ControllerInfoCollection
A collection of ControllerInfo object.
ControllerInfoComparer
Compares two instances of ControllerInfo through the IComparer interface. Used for sorting and searching. Built for extensibility since the default only compares the System Names.
DeviceDriverStream
This stream encapsulates the interface between a user mode application and a device driver on the controller.
DeviceManager
Manages the devices in the system.
FactoryFailedException
Thrown when factory failed to create instance.
GrantDemandRejectedException
An instance of this class is thrown when a DemandGrant operations fails.
LinkedListIndex<TValue>
Creates an index accessor for a linked lists.
LinkedListUtility
Utility class used to get the value from a linked list at the specified value.
MainComputerServiceInfo
Contains service information about the main computer of Controller. Not used for Virtual Controller.
Mastership
Defines mastership status of a robot controller resource.
MastershipChangedEventArgs
The data from a MastershipChanged event.
NamedObject
This abstract any class that has a readable name.
NetworkSettingsInfo
Contains information about the settings on a network adapter.
OperatingModeChangeEventArgs
Event args for OperatingModeChanged event.
RapidException
Base exception for Rapid operations.
RapidModuleNotFoundException
Thrown when a rapid module is missing.
RapidRoutineNotFoundException
Thrown when a routine is missing.
RapidSymbolNotFoundException
Thrown when a rapid symbol is missing.
RapidTaskNotFoundException
Thrown when a task is missing.
ReadOnlyObject
ReadOnlyObject is a special object that may be Readonly to enable immutable objects even though properties have set operations. Will throw an InvalidOperationException if write is attempted when object is in ReadOnly mode.
RemoteLogin
Methods that will allow a certain type of users to request a remote login/logout of a TPU user. When the TPU gets a remote login request it will logoff current user and login as the remote requested user.
RemoteLoginStateAndChangeCount
Remote login state and change count.
ResourceHeldException
This exception is thrown if a request for masterhip for a specific resource fails because the resource is held by another client
RobotWare
Describes a RobotWare version. Two instances are considered equal if they have the same version and the same option objects. The name isn't regarded.
RobotWareCollection
Holds a collection of RobotWareInfo objects.
RobotWareOption
An option of the controller software.
RobotWareOptionCollection
A collection of robot ware info objects.
SDKBase
This is the base class of all public classes in the api.
SDKControllerBoundBase
Base class for public classes in the api that needs a connection to the contorller. Not for public use.
ServiceInfo
Base class for all info objects.
ServiceNotSupportedException
An exception of this class is thrown if no specialized type is found.
StateChangedEventArgs
Event args for StateChanged.
SystemDirectoryCorruptException
This class is thrown a system directory was corrupt.
SystemRobotWare
Describes the currently running RobotWare.
UasCollectionBase<T>
Summary description for UasCollectionBase.
UasStringCollection
Summary description for UasStringCollection.
UserAuthorizationSystem
This class abstracts the UAS system of the controller into the CAPI programming model.
UserInfo
abstracts a user in the system
VirtualController
Administration class for virtual controller objects.
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.
VirtualPanelAttachFailedException
this exception is thrown if an Attach operation failes. NOTE: You cannot attach anything but virtual controllers.
Structs
Grant
Abstracts a controller grant.
MastershipInfo
Internal.
RegularExpression
This abstracts a ABB Regular exprssion. Use this instead of strings to avoid formatting errors.
RmmpInfo
Internal.
Interfaces
IController
Main interface of a controller.
IDeviceManager
Defines the interface of the device manager.
IDeviceNode
Defines the interface of a device node.
IMastershipResource
This class defines the interface of a resource that is controlled through the concept of Mastership.
IMastershipResourceController
This class defines the interface of write access to all controller resources that is controlled through the concept of Mastership.
INamedObject
Defines a named object in the api.
IPropertyNode
Defines the interface of a property node. A property node doesn't have any children and therefore always return an empty enumerator.
Enums
Availability
Describes the current availability of a Controller.
ControllerEnableState
Specifies the enable state of the controller.
ControllerFactoryProperty
Enumerator to control what property the factory uses to create Controller instance.
ControllerLogOptions
Defines the log options of a Virtual Controller.
ControllerMastershipPolicy
Specifies how mastership should be handled by a GUI client
ControllerOperatingMode
Specifies the operating modes of the controller.
ControllerStartMode
Defines the start mode of a Controller.
ControllerState
Specifies the states of the controller.
DeviceAccess
This enum controls how a stream to the controller is opened.
EventPriority
Predefined priority levels for events.
Level
Current run level of controller.
MastershipResource
Internal.
MastershipStatus
Internal.
RemoteLoginState
Remote login state.
RestoreIgnores
Enum to control what kind of mismatch errors that can be ignored during a restore operations.
RestoreIncludeControllerSettings
ABB internal use only
RestoreIncludes
Enum to control what to include from the backup during a restore operation.
RmmpStatus
Internal.
VirtualControllersate
Gets the state of the virtual controller.
Delegates
MastershipChangedEventHandler
Defines the delegate for the Mastership changed event.