Class RsInstructionParameter
Describes the data type and other properties of an RsInstructionArgument.
Inherited Members
Namespace: ABB.Robotics.RobotStudio.Stations
Assembly: ABB.Robotics.RobotStudio.Stations.dll
Syntax
sistent("ParameterDeclaration")]
public sealed class RsInstructionParameter : ProjectObject
Examples
RsInstructionParameter example.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
Constructors
RsInstructionParameter(String)
Creates and initializes a new RsInstructionParameter object.
Declaration
olete("Use RsInstructionParameter(string name, string dataType) instead. RsInstructionParameter.DataType has no valid default value.")]
public RsInstructionParameter(string name)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the RsInstructionParameter. |
Examples
Create a RsInstructionParameter.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
RsInstructionParameter(String, String)
Creates and initializes a new RsInstructionParameter object.
Declaration
public RsInstructionParameter(string name, string dataType)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the RsInstructionParameter. |
String | dataType | The RAPID data type of the RsInstructionParameter. |
Examples
Create a RsInstructionParameter.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
Properties
AccessMode
Get or sets the access mode of the parameter.
Declaration
public ParameterAccessMode AccessMode { get; set; }
Property Value
Type | Description |
---|---|
ParameterAccessMode |
Examples
Get/Set AccessMode.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
DataType
Get or sets the RAPID data type of the parameter.
Declaration
public string DataType { get; set; }
Property Value
Type | Description |
---|---|
String |
Examples
Get/Set data type.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
Dimensions
Get or sets the dimension of the parameter.
Declaration
public int Dimensions { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Examples
Get/Set Dimensions.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
Optional
Get or sets whether the parameter is an optional argument or not.
Declaration
public bool Optional { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Examples
Get/Set Optional.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
PointType
Get or sets the RsPointType of the parameter.
Declaration
public RsPointType PointType { get; set; }
Property Value
Type | Description |
---|---|
RsPointType |
Examples
Get/Set PointType.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}
ReadOnly
Declaration
olete("not used")]
public bool ReadOnly { get; }
Property Value
Type | Description |
---|---|
Boolean |
SyncReferencedData
Get or sets whether the parameter should be syncronized to and from the VC. If set to true when syncing from the VC data declarations corresponding to the Parameter will be added to the station.
Declaration
public bool SyncReferencedData { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Remarks
This property has no effect for ToolData, WorkObjects and for RobTargets with the PointType set, since these are always synchronized.
Examples
Get/Set SyncReferencedData.
Project.UndoContext.BeginUndoStep("RsMoveInstructionDescriptionProperties");
try
{
// Instance active station.
Station station = Station.ActiveStation;
// Create a MoveInstructionDescription.
RsMoveInstructionDescription myMoveInstrDesc = new RsMoveInstructionDescription("SearchL", MotionType.Linear);
myMoveInstrDesc.InformationText = "Search Linear";
// Create InstructionPrameterGroups and InstructionParameters
// and add them to the group.
RsInstructionParameterGroup myIPG = new RsInstructionParameterGroup();
RsInstructionParameter myArg = new RsInstructionParameter("Stop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("PStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("SStop");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("Sup");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Signal");
myArg.AccessMode = ParameterAccessMode.Variable;
myArg.DataType = "signaldi";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Flanks");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("SearchPoint");
myArg.AccessMode = ParameterAccessMode.InOut;
myArg.DataType = "robtarget";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ToPoint");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "robtarget";
myArg.Optional = false;
myArg.PointType = RsPointType.ToPoint;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("ID");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "identno";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Speed");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "speeddata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("V");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myArg = new RsInstructionParameter("T");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "num";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Tool");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "tooldata";
myArg.Optional = false;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("WObj");
myArg.AccessMode = ParameterAccessMode.Persistent;
myArg.DataType = "wobjdata";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Create a new InstructionPrameterGroup.
myIPG = new RsInstructionParameterGroup();
myArg = new RsInstructionParameter("Corr");
myArg.AccessMode = ParameterAccessMode.In;
myArg.DataType = "switch";
myArg.Optional = true;
myIPG.InstructionParameters.Add(myArg);
myMoveInstrDesc.InstructionParameterGroups.Add(myIPG);
// Add the InstructionDescription to the ActiveTask.
station.ActiveTask.InstructionDescriptions.Add(myMoveInstrDesc);
// Open the "Instruction Templates Manager" on the
// "Create" menu to verify that the description has been added.
}
catch
{
Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
throw;
}
finally
{
Project.UndoContext.EndUndoStep();
}