Click or drag to resize

Module Class

This class represents a RAPID module.
Inheritance Hierarchy

Namespace:  ABB.Robotics.Controllers.RapidDomain
Assembly:  ABB.Robotics.Controllers (in ABB.Robotics.Controllers.dll) Version: 6.5.129.0
Syntax
C#
public sealed class Module : RapidSymbol, 
	IDisposable

The Module type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleAttributes
Gets the attributes of the module
Public propertyControllerType
Gets the ControllerType.
(Inherited from SDKBase.)
Public propertyDataDeclarationList
Gets the TextRange of the data declarations of the Module.
Public propertyCode exampleModuleType
Gets the type of the module
Public propertyName
Gets or sets the name of the module
Public propertyCode examplePersInSync
Checks if the persistent data of the Module object is in sync with the real values of the controller.
Public propertyRoutineDeclarationList
Gets the TextRange of the routine declarations of the Module.
Public propertyCode exampleRowCount
Gets the maximum number of rows available in the module
Public propertyCode exampleScope
Gets the scope of the RapidSymbol, i.e. TASK,MODULE,ROUTINE,...
(Inherited from RapidSymbol.)
Public propertyTextRange
Gets the TextRange of the Module.
Public propertyType
Get the type of the RapidSymbol.
(Inherited from RapidSymbol.)
Public propertyTypeDeclarationList
Gets the TextRange of the datatype declarations of the Module.
Top
Methods
  NameDescription
Public methodCode exampleCreateRapidData(String, String, Scope, StorageType, Int32)
Creates a new RAPID data in the module according to specified parameters.
Public methodCode exampleCreateRapidData(String, String, Boolean, StorageType, Int32)
Creates a new RAPID data in the module according to specified parameters.
Public methodCode exampleCreateRoutine(String, Boolean)
Creates an empty routine in the module.
Public methodCode exampleCreateRoutine(String, Boolean, RoutineType, String, ParameterData)
Creates an empty routine in the module in accordance with specified parameters.
Public methodCode exampleDelete
Deletes the RAPID module the Module object refers to from program memory.
Public methodCode exampleDeleteRapidData(String, String)
Removes a specified RAPID data instance from the module.
Public methodCode exampleDeleteRapidData(String, String, Boolean)
Removes a specified RAPID data instance from the module.
Public methodDispose
Disposes the managed resources of the instance.
(Inherited from SDKDisposeBase.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodCode exampleGetRapidData
Gets a RapidData object that references a RAPID data instance in the robot controller.
Public methodCode exampleGetRoutine
Gets a Routine object to a specific RAPID routine.
Public methodCode exampleGetRoutines
Gets the routines defined in the module.
Public methodGetText(TextRange)
Returns the module text within the specified range.
Public methodGetText(Location, Location)
Returns the text of the module within the specified locations.
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodCode exampleSaveToFile
Saves the RAPID module to the specified file path.
Public methodCode exampleSearchRapidSymbol
General RapidSymbol search method.
(Overrides RapidSymbolSearchRapidSymbol(RapidSymbolSearchProperties, String, String).)
Public methodCode exampleSyncPers
Updates the persistent data of the module with their real values. As this cannot be done while the task is executing any call in ExecutionState Started will be disregarded and false will be returned.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also