Click or drag to resize
RsTask Class
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 RsTask : ProjectObject

The RsTask type exposes the following members.

Properties
  NameDescription
Public propertyActivePathProcedure
Gets or sets the active RsPathProcedure.
Public propertyActiveProcessDefinition
Gets or sets the active RsProcessDefinition, which is used when creating new instructions.
Public propertyActiveTool
Gets or sets the active RsToolData.
Public propertyActiveWorkObject
Gets or sets the active RsWorkObject.
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 propertyCode exampleDataDeclarations
Gets the collection of RsDataDeclaration objects.
Public propertyDisplayName (Overrides ProjectObjectDisplayName.)
Public propertyEntryPoint
Gets or sets the entry point for this task in the active SimulationConfiguration.
Public propertyFrame
Gets the task frame in global coordinates.
Public propertyCode exampleInstructionDescriptions
Gets the collection of RsInstructionDescription objects in this task.
Public propertyIsMotionTask
Returns true if this is a motion task.
Public propertyMechanism
Gets the Mechanism that corresponds to this task.
Public propertyMechanismMovingTaskFrame
ABB internal use
Public propertyCode exampleName
Gets or sets the name of the Task.
(Overrides ProjectObjectName.)
Public propertyCode exampleParent
The Parent property returns a reference to the parent RsIrc5Controller object.
(Overrides ProjectObjectParent.)
Public propertyCode examplePathProcedures
Gets the collection of RsPathProcedure objects in this task.
Public propertyProcessDefinitions
Gets the collection of RsProcessDefinition objects in this task.
Public propertySimulate Obsolete.
Public propertyTargets
Gets the collection of RsTarget objects in this task.
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.)
Public propertyVisible
Gets or sets if the graphical objects in ths task (paths and frames) are visible in the graphics.
Top
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Public methodFindDataDeclarationFromModuleScope
Find the RsDataDeclaration from the specified module scope.
Public methodFindDataDeclarationsByType(String)
Finds the RsDataDeclarations matching the supplied RAPID data type.
Public methodCode exampleFindDataDeclarationsByType(Type)
Finds the RsDataDeclarations matching the supplied object type.
Public methodCode exampleFindFirstDataDeclarationByType
Finds the first RsDataDeclaration methcing the supplied Type.
Public methodFindFirstTargetByWorkObject(String) Obsolete.
Finds the first RsTarget for the supplied name of a RsWorkObject.
Public methodCode exampleFindFirstTargetByWorkObject(RsWorkObject)
Finds the first RsTarget for the supplied RsWorkObject.
Public methodFindObjects
Recursively finds object that satisfy a condition.
(Inherited from ProjectObject.)
Public methodFindPathProcedureFromModuleScope
Find the RsPathProcedure from the specified module scope.
Public methodFindTargets(String, String) Obsolete.
Finds the RsTargets for the supplied name of a RsWorkObject and the name of a RsRobTarget.
Public methodCode exampleFindTargets(RsWorkObject, RsRobTarget)
Finds the RsTargets for the supplied RsWorkObject and RsRobTarget.
Public methodFindTargetsByRobTarget(String) Obsolete.
Finds the RsTarget for the supplied name of a RsRobTarget.
Public methodCode exampleFindTargetsByRobTarget(RsRobTarget)
Finds the RsTargets for the supplied RsRobTarget.
Public methodFindTargetsByWorkObject(String) Obsolete.
Finds the RsTargets for the supplied name of a RsWorkObject.
Public methodCode exampleFindTargetsByWorkObject(RsWorkObject)
Finds the RsTargets for the supplied RsWorkObject.
Public methodCode exampleGetExternalAxisJointTypes
Gets the JointTypes of the external axis joints in the Task.
Public methodCode exampleGetExternalAxisJointValues
Gets the joint values of the external axis joints in the Task.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodCode exampleGetValidRapidName
Gets a RAPID name that is valid within the scope of the Task.
Public methodCode exampleImportProcessDefinitions(String)
Imports Process Definitions from the supplied xml file.
Public methodCode exampleImportProcessDefinitions(XmlReader)
Imports Process Definitions from the supplied XmlReader.
Public methodImportProcessDefinitions(String, CollectionConflictPolicy)
Imports Process Definitions from the supplied xml file.
Public methodImportProcessDefinitions(XmlReader, CollectionConflictPolicy)
Imports Process Definitions from the supplied XmlReader.
Public methodStatic memberCode exampleIsValidRapidCharacter
Checks if the specified character is valid in a RAPID name, according to RAPID syntax.
Public methodStatic memberCode exampleIsValidRapidName
Checks if the specified string is a valid RAPID name, according to RAPID syntax.
Public methodCode exampleIsValidRapidNameInModuleScope
Checks if the specified string is a valid RAPID name in the specified module scope.
Public methodIsValidRapidNameInTaskScope(String)
Checks if the specified string is a valid RAPID name in the RsTask scope.
Public methodIsValidRapidNameInTaskScope(String, String)
Checks if the specified string is a valid RAPID name in the RsTask scope.
Public methodCode exampleJumpHome
Sets all axes of all mechanisms in the task to their corresponding home position.
Public methodRemoveUnusedDataDeclarations
Removes data declarations not belonging to any instruction.
Public methodCode exampleSetExternalAxisJointValues(Double)
Sets the joint values of the external axis joints in the Task.
Public methodCode exampleSetExternalAxisJointValues(Double, Boolean)
Sets the joint values of the external axis joints in the Task.
Public methodSyncData Obsolete.
Public methodCode exampleSyncDataAsync
Synchronizes the specified DataDeclaration to or from the controller/file.
Public methodSynchronizeAsync
Synchronizes multiple paths and data as a single operation.
Public methodSynchronizeModuleFileAsync
ABB Internal use only. Synchronizes all or specified Procedures belonging to a module (specified in the file) to or from the station.
Public methodSyncPathProcedure(String, SyncDirection, ArrayList) Obsolete.
Public methodSyncPathProcedure(String, SyncDirection, ListSyncLogMessage) Obsolete.
Public methodSyncPathProcedure(String, SyncDirection, ArrayList, ProgressNotification, Double, Double) Obsolete.
Public methodSyncPathProcedure(String, SyncDirection, ListSyncLogMessage, ProgressNotification, Double, Double) Obsolete.
Public methodCode exampleSyncPathProcedureAsync(String, SyncDirection, ListSyncLogMessage)
Synchronizes a RsPathProcedure in the station with a RAPID procedure in the controller. The controller or the station is the master.
Public methodCode exampleSyncPathProcedureAsync(String, SyncDirection, ListSyncLogMessage, ProgressNotification, Double, Double)
Synchronizes a RsPathProcedure in the station with a RAPID procedure in the controller. The controller or the station is the master.
Public methodSyncToController(ArrayList) Obsolete.
Public methodSyncToController(ListSyncLogMessage) Obsolete.
Public methodSyncToController(ArrayList, ProgressNotification) Obsolete.
Public methodSyncToController(ListSyncLogMessage, ProgressNotification) Obsolete.
Public methodCode exampleSyncToControllerAsync
Synchronizes all PathProcedures and DataDeclarations that have the Synchronize flag set.
Public methodToString (Inherited from ProjectObject.)
Top
Events
Version Information

Supported in: 1.0.0.0
See Also