Class RsInstructionParameterGroupCollection

A collection of RsInstructionParameterGroup objects. This collection defines all possible parameters of an RsInstruction. Each RsInstructionParameterGroup object defines either a single parameter, or a group of mutually exclusive parameters.

Inheritance

object

RsInstructionParameterGroupCollection

Namespace: ABB.Robotics.RobotStudio.Stations

Assembly: ABB.Robotics.RobotStudio.Stations.dll

Syntax

public class RsInstructionParameterGroupCollection

Properties

View Source

Count

Declaration

public virtual int Count { get; }

Property Value

Type	Description
int

View Source

IsSynchronized

Declaration

public virtual bool IsSynchronized { get; }

Property Value

Type	Description
bool

View Source

this[int]

Declaration

public RsInstructionParameterGroup this[int index] { get; }

Parameters

Type	Name	Description
int	index

Property Value

Type	Description
RsInstructionParameterGroup

View Source

Parent

Declaration

public ProjectObject Parent { get; }

Property Value

Type	Description
ProjectObject

View Source

SyncRoot

Declaration

public virtual object SyncRoot { get; }

Property Value

Type	Description
object

Methods

View Source

Add(RsInstructionParameterGroup)

Add a RsInstructionParameterGroup object to the collection.

Declaration

public void Add(RsInstructionParameterGroup instructionParameterGroup)

Parameters

Type	Name	Description
RsInstructionParameterGroup	instructionParameterGroup	The RsInstructionParameterGroup to add.

Examples

Add RsInstructionParameterGroup.

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();
        }</code></pre>

View Source

Contains(RsInstructionParameterGroup)

Declaration

public bool Contains(RsInstructionParameterGroup obj)

Parameters

Type	Name	Description
RsInstructionParameterGroup	obj

Returns

Type	Description
bool

View Source

CopyTo(RsInstructionParameterGroup[], int)

Declaration

public void CopyTo(RsInstructionParameterGroup[] array, int index)

Parameters

Type	Name	Description
RsInstructionParameterGroup[]	array
int	index

View Source

CopyTo(Array, int)

Declaration

public virtual void CopyTo(Array array, int index)

Parameters

Type	Name	Description
Array	array
int	index

View Source

GetEnumerator()

Declaration

public virtual IEnumerator GetEnumerator()

Returns

Type	Description
IEnumerator

View Source

Remove(RsInstructionParameterGroup)

Removes a RsInstructionParameterGroup object from the collection.

Declaration

public void Remove(RsInstructionParameterGroup instructionParameterGroup)

Parameters

Type	Name	Description
RsInstructionParameterGroup	instructionParameterGroup	The RsInstructionParameterGroup to remove.

Examples

Remove RsInstructionParameterGroup.

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();
        }</code></pre>

View Source

ToArray()

Declaration

public RsInstructionParameterGroup[] ToArray()

Returns

Type	Description
RsInstructionParameterGroup[]