listProperties Command

Description

Lists the properties (variables) of the specified object. Along with the variable name, this command displays the type and access permissions of the variable. If a variable is an input value, the Analysis Server will return sg (for set and get) as the access value. If the variable is an output value, the Analysis Server will return g (for get) as the access value.

Command Syntax

listProperties [object>.<property>.<subprop>...]

"l", "ls", and "list" can all be used as short-hand for "listProperties"

The property structure for a component is hierarchical. To access the sub-properties of a property, issue the list command for the full name of the property. When used without arguments, the listProperties command provides a listing of all currently started objects.

Example

The following sample sessions show how to list the properties of a simple object and an object with subproperties. If the listProperties command is used without arguments, the Analysis Server will produce a list of currently started components:

>start Block b 
>start 
Circle c 
>l
b
c

If a Block object called myblock has been started, the following command lists its properties:

>l
myblock 
>l myblock
6 properties found: 
volume (type=double) (access=g) 
class (type=java.lang.Class) (access=g) 
depth (type=double) (access=sg) 
height (type=double) (access=sg) 
surfaceArea (type=double) (access=g) 
volume (type=double) (access=g) 
width (type=double) (access=sg)

The block has 6 properties. The class property is common to all Java classes in the Analysis Server, and does not affect the analysis of the object. The other five properties are double precision real numbers; of these, the surfaceArea and volume properties are outputs, as shown by their get only (=g) access type.