These methods provide a general interface for managing objects in the RDE workspace.
Method |
Result |
Description / parameters |
||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
obj.start |
Boolean |
Starts object activities immediately. Returns logical outcome of operation. |
||||||||||||||
obj.stop |
Boolean |
Immediately stops the activities of the object. Returns logical operation outcome. |
||||||||||||||
obj.isrun |
Boolean |
Queries whether the object has activity in progress or not. |
||||||||||||||
obj.dirbase |
String |
Queries any base path of the object (if managed) -- DEPRECATED. |
||||||||||||||
obj.path |
String |
Queries path associated with object (optional). |
||||||||||||||
obj.setup |
Boolean |
Queries object settings/properties. Returns logical outcome of operation. |
||||||||||||||
obj.type.setup |
Boolean |
Query settings/properties by object type. -- DEPRECATED. Returns logical operation outcome. |
||||||||||||||
obj.class.setup |
Boolean |
Request settings/properties by object class. -- DEPRECATED Returns logical operation outcome. |
||||||||||||||
obj.rename |
Boolean |
Specific operation to rename object. -- DEPRECATED
Returns logical operation outcome. |
||||||||||||||
obj.set |
Boolean |
Value/property setting for object: parameters depend on the specific object (#2). |
||||||||||||||
obj.get |
* |
Query value/property for object: parameters depend on the specific object (#2). |
||||||||||||||
obj.init.create |
Boolean |
Initialization on object creation (#1). -- DEPRECATED. Returns logical result of operation. |
||||||||||||||
obj.init.import |
Boolean |
Initialization on object import (#1). -- DEPRECATED. Returns logical outcome of operation. |
||||||||||||||
obj.term.destroy |
Boolean |
Termination on object destruction. -- DEPRECATED. Returns logical outcome of operation. |
||||||||||||||
obj.prepare |
- |
Query object preparation (first initialization). |
||||||||||||||
obj.sub.list |
String list |
Query list of object-specific subobjects. Returns list of sub-object names. |
||||||||||||||
obj.sub.title |
String |
Query title for object-specific sub-object.
Returns the required title |
||||||||||||||
obj.sub.start |
Boolea |
Starts sub-object activities immediately.
Returns logical outcome of operation. |
||||||||||||||
obj.sub.stop |
Boolean |
Stops sub-object activities immediately.
Returns logical outcome of operation. |
||||||||||||||
obj.action.list |
String list |
Query a list of the object-specific quick actions, possibly related to a sub-ui.
Returns encoded string list to define actions. Action information is encoded using '|' (pipe) as a separator with the following pattern: "<name>|<enable>|<icon>|<title>|<tooltip>|<parameter>".
If a menu separator is to be inserted in the action list, use the string "--". To create sub-menus use "+" as the action name and pass the other coded information as above. To close an open sub-menu pass the string "-". |
(#1) Methods refer to an object that may not even be registered in the workspace yet (frequent condition).
(#2) Parameters and return type (obj.get) depend on the specific object: refer to the specific object's documentation for more information.
