Class Module

This class represents a Module Rapid object.

Inheritance

System.Object

NamedObject

SDKBase

SDKControllerBoundBase

Module

Implements

System.IComparable

System.IDisposable

IRapidSymbol

INamedObject

Inherited Members

SDKControllerBoundBase.Controller

SDKBase.Dispose()

SDKBase.Dispose(Boolean)

NamedObject.Equals(String)

NamedObject.Equals(NamedObject)

NamedObject.Equals(Object)

NamedObject.CompareTo(String)

NamedObject.CompareTo(NamedObject)

NamedObject.CompareTo(Object)

NamedObject.GetHashCode()

NamedObject.ToString()

NamedObject.Name

Namespace: ABB.Robotics.Controllers.RapidDomain

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public sealed class Module : SDKControllerBoundBase, IComparable, IDisposable, IRapidSymbol, INamedObject

Properties

Attributes

Gets the attributes for this module.

Declaration

public ModuleAttributes Attributes { get; }

Property Value

Type	Description
ModuleAttributes

IsEncoded

Gets a flag indicating encode state of the module.

Declaration

public bool IsEncoded { get; }

Property Value

Type	Description
System.Boolean

IsNoStepIn

Gets a flag indicating if the module can be stepped into.

Declaration

public bool IsNoStepIn { get; }

Property Value

Type	Description
System.Boolean

IsNoView

Gets a flag indicating if the module is a NoView module.

Declaration

public bool IsNoView { get; }

Property Value

Type	Description
System.Boolean

IsReadOnly

Gets a flag indicating if the module is a ReadOnly module.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

IsSystem

Gets a flag indicating if the module is a system module.

Declaration

public bool IsSystem { get; }

Property Value

Type	Description
System.Boolean

IsViewOnly

Gets a flag indicating if the module is a view only module.

Declaration

public bool IsViewOnly { get; }

Property Value

Type	Description
System.Boolean

Type

Gets the kind of symbol

Declaration

public SymbolTypes Type { get; }

Property Value

Type	Description
SymbolTypes

Methods

Delete()

Deletes the module from the memory of the controller.

Declaration

public void Delete()

Remarks

Requires mastership of Rapid domain. Requires the LoadRapidProgram grant.

GetRapidData(RapidSymbol)

Gets the data for specified symbol.

Declaration

public RapidData GetRapidData(RapidSymbol symbol)

Parameters

Type	Name	Description
RapidSymbol	symbol	Symbol to get data for.

Returns

Type	Description
RapidData	RapidData object.

GetRapidData(String[])

Gets a RapidData object that reference a Rapid data instance in the robot controller.

Declaration

public RapidData GetRapidData(params string[] rapidData)

Parameters

Type	Name	Description
System.String[]	rapidData

Returns

Type	Description
RapidData	RapidData object.

GetRoutine(String)

Gets a Routine object to a specific routine.

Declaration

public Routine GetRoutine(string name)

Parameters

Type	Name	Description
System.String	name	Name of the routine.

Returns

Type	Description
Routine	A Routine object to access the routine. If the routine does not exist, the return value is null.

GetRoutines()

Returns all routines in the current Module.

Declaration

public Routine[] GetRoutines()

Returns

Type	Description
Routine[]	All routines in the current module.

SaveToFile(String)

Save the Rapid module, to which the Module object refers, to a specified directory on the controller.

Declaration

public void SaveToFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	Path to the directory where the Rapid module should be saved.

Remarks

For real controllers, only paths on the controller are supported.
To also move a module file locally to the PC, FileSystem can be used.
For virtual controllers, absolute paths on the PC are also supported such as "c:\temp".
Controller paths containing environment variables are supported such as "(HOME$)/myFolder".

The file will be named after the module name with the extension ".mod" or ".sys".
For RobotWare >= 7.1 the extension will be ".modx" or ".sysx" and the file content will be UTF-8 encoded.

Requires the BackupController grant.

SearchRapidSymbol(RapidSymbolSearchProperties)

Searches the current symbol for symbols.

Declaration

public RapidSymbol[] SearchRapidSymbol(RapidSymbolSearchProperties searchProperties)

Parameters

Type	Name	Description
RapidSymbolSearchProperties	searchProperties	Properties for search.

Returns

Type	Description
RapidSymbol[]	All matching symbols.

SearchRapidSymbol(RapidSymbolSearchProperties, RapidDataType)

Searches the current symbols of the specified data type.

Declaration

public RapidSymbol[] SearchRapidSymbol(RapidSymbolSearchProperties searchProperties, RapidDataType type)

Parameters

Type	Name	Description
RapidSymbolSearchProperties	searchProperties	Search properties.
RapidDataType	type	Type of data to search for.

Returns

Type	Description
RapidSymbol[]	All matching symbols.

SearchRapidSymbol(RapidSymbolSearchProperties, RapidDataType, String)

Searches the current symbols of the specified data type.

Declaration

public RapidSymbol[] SearchRapidSymbol(RapidSymbolSearchProperties searchProperties, RapidDataType type, string searchExpression)

Parameters

Type	Name	Description
RapidSymbolSearchProperties	searchProperties	Search properties.
RapidDataType	type	Type of data to search for.
System.String	searchExpression	Expression used to match search, regular expression.

Returns

Type	Description
RapidSymbol[]	All matching symbols.

SearchRapidSymbol(RapidSymbolSearchProperties, String)

Searches the current symbol for other symbols.

Declaration

public RapidSymbol[] SearchRapidSymbol(RapidSymbolSearchProperties searchProperties, string searchExpression)

Parameters

Type	Name	Description
RapidSymbolSearchProperties	searchProperties	Properties to search for.
System.String	searchExpression	Expression used to match search, regular expression.

Returns

Type	Description
RapidSymbol[]	All matching symbols.

SearchRapidSymbol(RapidSymbolSearchProperties, String, String)

Searches the current symbol for other symbols.

Declaration

public RapidSymbol[] SearchRapidSymbol(RapidSymbolSearchProperties searchProperties, string dataType, string searchExpression)

Parameters

Type	Name	Description
RapidSymbolSearchProperties	searchProperties	Properties to search for.
System.String	dataType	Type to search after.
System.String	searchExpression	Expression used to match search, regular expression.

Returns

Type	Description
RapidSymbol[]	All matching symbols.

Implements

System.IComparable

System.IDisposable

IRapidSymbol

INamedObject