Namespace ABB.Robotics.RobotStudio

Classes

AttributeCollection

Represents a collection of Attributes attached to a ProjectObject. Attributes are stored as a key/value pair. Keys can be associated with a Guid. A key with a Guid can only be removed by a client that knows the Guid.

AutoSaveAvailableEventArgs

Provides data for the AutoSaveAvailable event

CollectionChangedEventArgs

Provides data for the Changed event on various collections.

CompressorInfo

Contains information about a specific compressor (codec)

CustomProjectObject

Base class for custom ProjectObject derived classes.

DataRecorderBase

A data recorder collects data from all its souces, and distributes it to its sinks.

DataRecorderDataAddedEventArgs

DataRecorderSignal

Represents a piece of information that can be recorder by a DataRecorder

DataRecorderSignalCollection

Represents a collection of DataRecorderSignal objects.

DataRecorderSinkAddedEventArgs

Provides data for the DataRecorderSinkAdded event of the collection.

DataRecorderSinkBase

Base class for a data recorder sink, which will get notified when signals subscribed by the data recorder is updated.

DataRecorderSinkBase2

Base class for a data recorder sink, which will get notified when signals subscribed by the data recorder is updated.

DataRecorderSinkCollection

Represents a collection of DataRecorderSinkBase objects.

DataRecorderSinkRemovedEventArgs

Provides data for the DataRecorderSinkRemoved event of the collection.

DataRecorderSourceAddedEventArgs

Provides data for the DataRecorderSourceAdded event of the collection.

DataRecorderSourceBase

A data recorder source provides information to a data recorder.

DataRecorderSourceBaseAsync

A DataRecorderSourceBase that supports asynchronous operations for subscribing and unsubscribing signals.

DataRecorderSourceCollection

Represents a collection of DataRecorderSourceBase objects.

DataRecorderSourceRemovedEventArgs

Provides data for the DataRecorderSourceRemoved event of the collection.

DataRecorderSubscribeSignalResult

Provides information about the

DataRecorderTickEventArgs

Provides data for the Tick event.

DocumentHistoryEntry

Additional document properties for a specific point in time.

DocumentInfo

This class gives access to document properties such as title, comments, preview etc.

ExceptionEventArgs

Provides data for events such as DocumentProvider.Error.

ExceptionLogMessage

A log message representing an Exception.

HostedAddInBase

Base class for a PowerPac type add-in.

LicenseValidator

Manages licenses that unlock licensed features

LoadContext

Identifies the context (document) of a loaded CustomProjectObject

LogMessage

Represents a log message that can be added to the Logger.

LogMessageActivatedEventArgs

Provides data for the LogMessageActivated event of the Logger.

LogMessageAddedEventArgs

Provides data for the LogMessageAdded event of the Logger.

LogMessageRemovedEventArgs

Provides data for the LogMessageRemoved event of the Logger.

Logger

Provides methods and events to support logging of messages to the user.

MeasuringUnit

Represents a measuring unit such as meter, millimeter, m/s, rad/s2. A unit belongs to a quantity. For example meter and millimeter belongs to the quantity length, and m/s belongs to the quantity velocity.

MeasuringUnitCollection

Represents a collection of measuring units.

Options

Provides static methods, properties and events to store and read user options. Options are grouped in sections.

Project

Base class for all project types. Available project types will differ depending on the product that this API is used within.

ProjectDocument

Represents a document associated with a project.

ProjectDocumentCollection

Represents a collection of ProjectDocuments.

ProjectFileEventArgs

Provides data for the BeforeLoadProjectFile event.

ProjectFileLockedEventArgs

Provides data for the ProjectFileLocked event

ProjectObject

Abstract base class for all objects that can be part of a Project. It can not be instantiated.

ProjectObjectChangedEventArgs

Provides data for the ProjectObjectChanged event.

ProjectObjectCollection

Represents a collection of ProjectObjects

ProjectObjectPropertyChangedEventArgs

Provides data for events of type ProjectObjectPropertyChangedEventHandler.

ProjectObjectRemovedEventArgs

Provides data for the ProjectObjectRemoved event of the Project.

ProjectSelection

Represents a collection of all selected objects. Selection is a concept used from the user interface. Typically it is used to specify for which objects to perform an action, to view information for specific objects and to show which operations that are availble for specific objects. The most common way for a user to select an object is to click with the mouse in the graphic view or in a browser. Using this object you can programatically control which objects that are selected and get notified when selection has changed.

ProjectVersionEventArgs

Provides data for the ProjectFileDifferentVersion event.

Quantity

Represents a SI quantity such as length, time, area etc.

ReferencedProjectFileNotFoundEventArgs

Provides data for the ReferencedProjectFileNotFound event

ReferencedProjectFileNotSameEventArgs

Provides data for the ReferencedProjectFileNotSame event

RobotStudioAPI

Intended for internal use only.

RobotStudioLicenseException

This exception is thrown by certain API methods when the license check fails.

SavedState

Represents a set of object states (such as property or signal values) for one or more ProjectObjects.

SavedStateCollection

Represents a collection of SavedState objects.

SavingProjectEventArgs

Provides data for the Saving event

ScreenRecorder

Represents a recording device that can record frames from the screen.

SectionChangedEventArgs

Provides data for the Options.SectionChanged event

Selection

Provides access to a collection containing all selected objects.

SelectionEventArgs

Provides data for the ProjectSelection.ObjectAdded and ProjectSelection.ObjectRemoved events.

Solution

A Solution represents a project structure with associated station and documents.

ToolControlServices

Provides methods for showing a Control in the a singleton tool window.

UndoContext

Gives access to a state based undo mechanism for ProjectObjects. Each Project has its own undo context. The undo context makes it possible to group changes to ProjectObjects. All changes in the group can then be undone and redone.