RsInstructionParameter Class

Describes the data type and other properties of an RsInstructionArgument.

Inheritance Hierarchy

SystemObject
ABB.Robotics.RobotStudioProjectObject
ABB.Robotics.RobotStudio.StationsRsInstructionParameter

Namespace: ABB.Robotics.RobotStudio.Stations
Assembly: ABB.Robotics.RobotStudio.Stations (in ABB.Robotics.RobotStudio.Stations.dll) Version: 7.0.8747.636

Syntax

Copy

public sealed class RsInstructionParameter : ProjectObject

The RsInstructionParameter type exposes the following members.

Constructors

	Name	Description
	RsInstructionParameter(String)	Obsolete. Creates and initializes a new RsInstructionParameter object.
	RsInstructionParameter(String, String)	Creates and initializes a new RsInstructionParameter object.

Top

Properties

	Name	Description
	AccessMode	Get or sets the access mode of the parameter.
	Attributes	Returns a collection of dynamic attributes attached to the object (Inherited from ProjectObject.)
	Children	Enumerates all child objects. (Inherited from ProjectObject.)
	ContainingProject	Returns the Project that this object is a part of, or null if it is not part of a Project. (Inherited from ProjectObject.)
	DataType	Get or sets the RAPID data type of the parameter.
	Dimensions	Get or sets the dimension of the parameter.
	DisplayName	Gets the name of the the object that should be displayed in the GUI. (Inherited from ProjectObject.)
	Name	Gets or sets the name of the object (Inherited from ProjectObject.)
	Optional	Get or sets whether the parameter is an optional argument or not.
	Parent	Returns the objects parent, if it has one. (Inherited from ProjectObject.)
	PointType	Get or sets the RsPointType of the parameter.
	ReadOnly	Obsolete.
	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.
	TypeDisplayName	Gets a localized name for the type of this object. (Inherited from ProjectObject.)
	UIVisible	Gets or sets a value that indicates if this object should be displayed in GUI such as an object browser. (Inherited from ProjectObject.)
	UniqueId	Gets a persisted, globally unique identifier for this object, that can be used to find the object using the GetObjectFromUniqueId(String) method. (Inherited from ProjectObject.)

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	FindObjects	Recursively finds object that satisfy a condition. (Inherited from ProjectObject.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from ProjectObject.)

Top

Examples

RsInstructionParameter example.

RsMoveInstructionDescription Properties Example

Copy

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

Version Information

Supported in: 1.0.0.0

Reference

ABB.Robotics.RobotStudio.Stations Namespace