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
Logger
Provides methods and events to support logging of messages to the user.
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.
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.
ToolControlTearOffEventArgs
ABB internal use.
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.
Structs
DataRecorderSignalInfo
Represents information such as data type and quantity of a DataRecorderSignal
LicenseInformation
Contains information about a license
Interfaces
IChange
Interface for objects that represent an undoable operation.
ICustomContextType
Enables context based UI based on instance data rather than object type.
IHasSystemId
Interface for objects that provide a SystemId property.
IProgressCallback
Callback interface for time-consuming operations.
IProgressCallback2
Callback interface for time-consuming operations.
ISupportCopy
This interface is implemented by project objects which are possible to copy. It is typically used when implementing Copy/Paste functionality.
Enums
BuiltinQuantity
Specifies the quantities which are supported.
CancelUndoStepType
Specifies how to cancel an undo step.
CollectionConflictPolicy
Specifies what to do when adding an item to a collection, if an equivalent item (e.g. same name) already exists in the collection.
LicenseHoldType
Specifies how an acquired license is released.
LicenseRuntime
LicenseType
Specifies the type of a license
LogMessageSeverity
Specifies the severity of a log message.
ProjectDocumentFlags
Specifies values for the Flags property.
ProjectDocumentType
Specifies the type of a ProjectDocument
ProjectFormat
Represents the storage format of a Project (station or component library). Also determines the folder structure created by Create(String, String, ProjectFormat)
ProjectObjectChangeType
Specifies in which way a project object has changed.
ProjectType
Specifies the type of a Project
Quantity.AccelerationUnit
Specifies a unit of the quantity Acceleration
Quantity.AngleUnit
Specifies a unit of the quantity Angle
Quantity.AngularAccelerationUnit
Specifies a unit of the quantity AngularAcceleration
Quantity.AngularElasticityUnit
Specifies a unit for the quantity Angular Elasticity
Quantity.AngularVelocityUnit
Specifies a unit of the quantity AngularVelocity
Quantity.AreaUnit
Specifies a unit of the quantity Area
Quantity.ElasticityUnit
Specifies a unit for the quantity Elasticity
Quantity.EnergyUnit
Specifies a unit of the quantity Energy
Quantity.ForceUnit
Specifies a unit for the quantity Force
Quantity.InertiaUnit
Specifies a unit of the quantity Inertia
Quantity.LengthUnit
Specifies a unit of the quantity Length
Quantity.MassUnit
Specifies a unit of the quantity Mass
Quantity.NoneUnit
Specifies a unit of the quantity None
Quantity.PowerUnit
Specifies a unit of the quantity Power
Quantity.PressureUnit
Specifies a unit for the quantity Pressure (also used for Young's modulus)
Quantity.QuaternionUnit
Specifies a unit for quaternions, to be able to specify decimals for the quaternions
Quantity.TimeUnit
Specifies a unit of the quantity Time
Quantity.TorqueUnit
Specifies a unit for the quantity Torque
Quantity.VelocityUnit
Specifies a unit of the quantity Velocity
Quantity.VolumeUnit
Specifies a unit of the quantity Volume
RecorderState
Specifies the different states that the ScreenRecorder can be in.
ScreenRecorderFileFormat
Specifies the different output file formats supported by the ScreenRecorder.
SelectionReason
Reasons for why an object was added to a ProjectSelection.
SignalDataType
Specifies the data type of a DataRecorderSignal
SignalInterpolationType
Specifies the type of interpolation for a DataRecorderSignal
Delegates
AutoSaveAvailableEventHandler
Represents the method that will handle the AutoSaveAvailable event of the Project.
CollectionChangedEventHandler
Represents the method that will handle the Changed event for various collections.
LogMessageActivatedEventHandler
Represents a method that will handle activated log messages.
LogMessageAddedEventHandler
Represents the method that will handle the LogMessageAdded event of the Logger class.
LogMessageRemovedEventHandler
Represents the method that will handle the LogMessageRemoved event of the Logger class.
ProgressNotification
Represents the method that will handle progress notification callbacks. Some time consuming methods provides a progress notification callback, and accepts this delegate as an argument.
ProjectFileEventHandler
Represents the method that will handle the BeforeLoadProjectFile event.
ProjectFileLockedEventHandler
Represents the method that will handle the ProjectFileLocked event of the Project.
ProjectObjectChangedEventHandler
Represents the method that will handle the ProjectObjectChangedevent of a ProjectObject.
ProjectObjectPropertyChangedEventHandler
Represents the method that will handle the ProjectObjectPropertyChangedEventArgs event.
ProjectObjectRemovedEventHandler
Represents the method that will handle the ProjectObjectRemoved event of the Project.
ReferencedProjectFileNotFoundEventHandler
Represents the method that will handle the ReferencedProjectFileNotFound event of the Project.
ReferencedProjectFileNotSameEventHandler
Represents the method that will handle the ReferencedProjectFileNotSame event of the Project.
SavingProjectEventHandler
Represents the method that will handle the Saving event of the Project.
SectionChangedEventHandler
Represents the method that will handle the SectionChanged event.
SelectionEventHandler
Represents a method that will handle the ObjectAdded and ObjectRemoved events.