Click or drag to resize
RsActionInstructionDescription Class
Defines the parameters and other properties of an RsActionInstruction. Also contains templates for creating new RsActionInstruction instances.
Inheritance Hierarchy

Namespace:  ABB.Robotics.RobotStudio.Stations
Assembly:  ABB.Robotics.RobotStudio.Stations (in ABB.Robotics.RobotStudio.Stations.dll) Version: 7.0.8747.636
Syntax
C#
public sealed class RsActionInstructionDescription : RsInstructionDescription

The RsActionInstructionDescription type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleRsActionInstructionDescription
Initializes a new instance of the RsActionInstructionDescription class.
Top
Properties
  NameDescription
Public propertyCode exampleActiveTemplate
Gets or sets the active instruction template.
Public propertyAttributes
Returns a collection of dynamic attributes attached to the object
(Inherited from ProjectObject.)
Public propertyChildren
Enumerates all child objects.
(Inherited from ProjectObject.)
Public propertyContainingProject
Returns the Project that this object is a part of, or null if it is not part of a Project.
(Inherited from ProjectObject.)
Public propertyDisplayName
Gets the name of the the object that should be displayed in the GUI.
(Inherited from ProjectObject.)
Public propertyInformationText
Gets or sets an informational text for the instruction description.
(Inherited from RsInstructionDescription.)
Public propertyInstructionParameterGroups
Gets the RsInstructionParameterGroupCollection that defines all possible parameters of the instruction.
(Inherited from RsInstructionDescription.)
Public propertyCode exampleInstructionTemplates
Gets the collection of instruction templates contained within this Action Instruction Description.
Public propertyName
Gets or sets the name of the object
(Inherited from ProjectObject.)
Public propertyParent
Returns the objects parent, if it has one.
(Inherited from ProjectObject.)
Public propertyTypeDisplayName
Gets a localized name for the type of this object.
(Inherited from ProjectObject.)
Public propertyUIVisible
Gets or sets a value that indicates if this object should be displayed in GUI such as an object browser.
(Inherited from ProjectObject.)
Public propertyUniqueId
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
  NameDescription
Public methodEquals (Inherited from Object.)
Public methodFindInstructionParameter
Tries to find the RsInstructionParameter with the supplied name.
(Inherited from RsInstructionDescription.)
Public methodFindObjects
Recursively finds object that satisfy a condition.
(Inherited from ProjectObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from ProjectObject.)
Top
Remarks
The Name property corresponds to the name of the RAPID instruction.
Examples
RsActionInstructionDescription Example.
RsActionInstructionDescription Example
Project.UndoContext.BeginUndoStep("RsActionInstructionDescriptionExample");
try
{
    Station station = Station.ActiveStation;
    RsInstructionDescription myInstrDesc;
    if (station.ActiveTask.InstructionDescriptions.TryGetInstructionDescription("ConfL", out myInstrDesc))
    {
        // Cast myInstrDesc to a RsActionInstructionDescription.
        RsActionInstructionDescription myConfLDesc = (RsActionInstructionDescription)myInstrDesc;

        // Output to the logger.
        Logger.AddMessage(new LogMessage("The ActionInstructionDescription '" + myConfLDesc.Name + "' has the following property values:"));
        Logger.AddMessage(new LogMessage("InformationText: " + myConfLDesc.InformationText));
        if (myConfLDesc.ActiveTemplate != null)
        {
            Logger.AddMessage(new LogMessage("ActiveTemplate: " + myConfLDesc.ActiveTemplate.Name));
        }
        Logger.AddMessage(new LogMessage("The following instruction parameters:"));
        int i = 1;
        foreach (RsInstructionParameterGroup rspg in myConfLDesc.InstructionParameterGroups)
        {
            Logger.AddMessage(new LogMessage("In group " + i + ":"));
            i++;
            foreach (RsInstructionParameter rsip in rspg.InstructionParameters)
            {
                Logger.AddMessage(new LogMessage("Parameter Name: '" + rsip.Name
                        + "' Optional: '" + rsip.Optional.ToString()
                        + "' Pointtype: '" + rsip.PointType.ToString()
                        + "' SyncReferencedData: '" + rsip.SyncReferencedData.ToString() + "'"));
            }

        }
        Logger.AddMessage(new LogMessage("The following instruction templates:"));
        foreach (RsInstructionTemplate rsit in myConfLDesc.InstructionTemplates)
        {
            Logger.AddMessage(new LogMessage("Template '" + rsit.Name + "'"));
            Logger.AddMessage(new LogMessage("Has the following InstructionArguments:"));
            foreach (RsInstructionArgument rsia in rsit.InstructionArguments)
            {
                Logger.AddMessage(new LogMessage("Argument Name: '" + rsia.Name
                        + "' Enabled: '" + rsia.Enabled.ToString()
                        + "' Value: '" + rsia.Value + "'"));
            }
        }
    }
    else
    {
        Logger.AddMessage(new LogMessage("Failed to get the IstructionDescription for 'ConfL'"));
    }
}
catch
{
    Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
    throw;
}
finally
{
    Project.UndoContext.EndUndoStep();
}
Version Information

Supported in: 1.0.0.0
See Also