RsActionInstructionDescription Class |
Namespace: ABB.Robotics.RobotStudio.Stations
public sealed class RsActionInstructionDescription : RsInstructionDescription
The RsActionInstructionDescription type exposes the following members.
Name | Description | |
---|---|---|
RsActionInstructionDescription |
Initializes a new instance of the RsActionInstructionDescription class.
|
Name | Description | |
---|---|---|
ActiveTemplate |
Gets or sets the active instruction template.
| |
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.) | |
DisplayName |
Gets the name of the the object that should be displayed in the GUI.
(Inherited from ProjectObject.) | |
InformationText |
Gets or sets an informational text for the instruction description.
(Inherited from RsInstructionDescription.) | |
InstructionParameterGroups |
Gets the RsInstructionParameterGroupCollection that defines all possible parameters of the instruction.
(Inherited from RsInstructionDescription.) | |
InstructionTemplates |
Gets the collection of instruction templates contained within this Action Instruction Description.
| |
Name |
Gets or sets the name of the object
(Inherited from ProjectObject.) | |
Parent |
Returns the objects parent, if it has one.
(Inherited from ProjectObject.) | |
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.) |
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
FindInstructionParameter |
Tries to find the RsInstructionParameter with the supplied name.
(Inherited from RsInstructionDescription.) | |
FindObjects |
Recursively finds object that satisfy a condition.
(Inherited from ProjectObject.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
ToString | (Inherited from ProjectObject.) |
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(); }