Class RsInstruction
Inheritance
RsInstruction
Assembly: ABB.Robotics.RobotStudio.Stations.dll
Syntax
public abstract class RsInstruction : ProjectObject, ISupportCopy
Constructors
RsInstruction()
Declaration
protected RsInstruction()
RsInstruction(PimDocument)
Only for use by persistence system.
Declaration
protected RsInstruction(PimDocument doc)
Parameters
Type |
Name |
Description |
RobotStudio.API.Persistence.PimDocument |
doc |
|
Properties
DisplayName
Declaration
public override string DisplayName { get; }
Property Value
Overrides
InstructionArguments
Declaration
public RsInstructionArgumentCollection InstructionArguments { get; }
Property Value
Methods
Copy()
Creates a deep copy of the RsInstruction
Declaration
public virtual ProjectObject Copy()
Returns
GetArgumentsByDataType(RsTask, String)
Declaration
public IEnumerable<RsInstructionArgument> GetArgumentsByDataType(RsTask task, string dataType)
Parameters
Type |
Name |
Description |
RsTask |
task |
The RsTask that contains the instruction definition.
|
String |
dataType |
RAPID data type
|
Returns
GetArgumentsByDataType(String)
Declaration
public IEnumerable<RsInstructionArgument> GetArgumentsByDataType(string dataType)
Parameters
Returns
GetDescriptionInternal(RsTask, Boolean)
Declaration
protected RsInstructionDescription GetDescriptionInternal(RsTask task, bool throwOnFail)
Parameters
Returns
GetDescriptionInternal(Boolean)
Declaration
protected RsInstructionDescription GetDescriptionInternal(bool throwOnFail)
Parameters
Type |
Name |
Description |
Boolean |
throwOnFail |
|
Returns
GetInstructionDescription()
Declaration
public virtual RsInstructionDescription GetInstructionDescription()
Returns
GetTask(Boolean)
Declaration
protected RsTask GetTask(bool throwOnFail)
Parameters
Type |
Name |
Description |
Boolean |
throwOnFail |
|
Returns
InitializeCallFromTemplate(RsInstructionTemplate, String, Boolean)
Declaration
protected void InitializeCallFromTemplate(RsInstructionTemplate instructionTemplate, string descriptionName, bool makeEmptyInstruction)
Parameters
SetInstructionTemplate(RsInstructionTemplate)
Sets the instruction template of the RsInstruction
Declaration
public virtual void SetInstructionTemplate(RsInstructionTemplate instructionTemplate)
Parameters
Implements