Class RsInstructionDescription
Abstract base class for RsMoveInstructionDescription and RsActionInstructionDescription.
Inheritance
RsInstructionDescription
Inherited Members
Namespace: ABB.Robotics.RobotStudio.Stations
Assembly: ABB.Robotics.RobotStudio.Stations.dll
Syntax
public abstract class RsInstructionDescription : ProjectObject
Constructors
RsInstructionDescription()
Declaration
protected RsInstructionDescription()
RsInstructionDescription(PimDocument)
Only for use by persistence system.
Declaration
protected RsInstructionDescription(PimDocument doc)
Parameters
Type | Name | Description |
---|---|---|
RobotStudio.API.Persistence.PimDocument | doc |
Properties
InformationText
Gets or sets an informational text for the instruction description.
Declaration
public string InformationText { get; set; }
Property Value
Type | Description |
---|---|
String |
InstructionParameterGroups
Gets the RsInstructionParameterGroupCollection that defines all possible parameters of the instruction.
Declaration
public RsInstructionParameterGroupCollection InstructionParameterGroups { get; }
Property Value
Type | Description |
---|---|
RsInstructionParameterGroupCollection |
Methods
FindInstructionParameter(String)
Tries to find the RsInstructionParameter with the supplied name.
Declaration
public RsInstructionParameter FindInstructionParameter(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
String | parameterName | The name of the parameter to look for. |
Returns
Type | Description |
---|---|
RsInstructionParameter | The RsInstructionParameter if a matching name exists, otherwise null. |
GetInformationText()
Declaration
protected abstract string GetInformationText()
Returns
Type | Description |
---|---|
String |
GetInstructionParameterGroups()
Declaration
protected abstract RsInstructionParameterGroupCollection GetInstructionParameterGroups()
Returns
Type | Description |
---|---|
RsInstructionParameterGroupCollection |
SetInformationText(String)
Declaration
protected abstract void SetInformationText(string text)
Parameters
Type | Name | Description |
---|---|---|
String | text |