Class ControllerObjectReference
Represents a real or virtual controller (or an object within a controller) that is referenced by RobotStudio.
Implements
Namespace: ABB.Robotics.RobotStudio.Controllers
Assembly: ABB.Robotics.RobotStudio.Controllers.dll
Syntax
public class ControllerObjectReference : ICustomContextType
Remarks
This class does not contain any methods for interacting with the controller. Using the SystemId property you can create an instance of the Controller class, from the namespace ABB.Robotics.Controllers of PC SDK, in order to interact with the contoller.
Properties
ContextType
Gets a string that specifies the context menu and tabs to display for this instance.
Declaration
public string ContextType { get; }
Property Value
Type | Description |
---|---|
String |
ControllerType
Returns the type of controller represented by this object
Declaration
public ControllerType ControllerType { get; }
Property Value
Type | Description |
---|---|
ControllerType |
IsServicePortController
Returns true if the controller is connected by the service port.
Declaration
public bool IsServicePortController { get; }
Property Value
Type | Description |
---|---|
Boolean |
IsStationController
Returns true if the controller represented by this object is part of a RobotStudio Station
Declaration
public bool IsStationController { get; }
Property Value
Type | Description |
---|---|
Boolean |
Name
Returns the name of the object (the last part of its Url)
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
String |
ObjectType
Returns the type of controller object represented by this instance.
Declaration
public ControllerObjectType ObjectType { get; }
Property Value
Type | Description |
---|---|
ControllerObjectType |
RelativeUrl
Returns a relative url uniquely identifiying this controller object within a controller
Declaration
public string RelativeUrl { get; }
Property Value
Type | Description |
---|---|
String |
Remarks
Does not include the system id; It is only unique within the corresponding controller. Starts with '/', unless it is empty.
RobControllerConnection
Internal use only.
Declaration
Compliant(false)]
public RobControllerConnection RobControllerConnection { get; }
Property Value
Type | Description |
---|---|
RobotStudio.Services.RobApi.RobControllerConnection |
Root
Returns a reference to the controller that contains this object.
Declaration
public ControllerObjectReference Root { get; }
Property Value
Type | Description |
---|---|
ControllerObjectReference |
SystemId
Gets the Guid that identifies the controller associated with this object.
Declaration
public Guid SystemId { get; }
Property Value
Type | Description |
---|---|
Guid |
SystemIdString
Gets the Guid that identifies the controller associated with this object
Declaration
public string SystemIdString { get; }
Property Value
Type | Description |
---|---|
String |
Remarks
Similar to the SystemId property, but returns the GUID as a string
Tag
Internal ABB use only
Declaration
public object Tag { get; }
Property Value
Type | Description |
---|---|
Object |
Url
Returns a url uniquely identifiying this controller object
Declaration
public string Url { get; }
Property Value
Type | Description |
---|---|
String |
Methods
GetRelations()
Returns transfer relations that involve this controller
Declaration
public IEnumerable<TransferRelation> GetRelations()
Returns
Type | Description |
---|---|
IEnumerable<RobotStudio.API.Internal.TransferRelation> |
ToString()
Returns a string that represents the current object
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |