get* and Selection Access Methods

get* and Selection Access Methods

Use these methods to access properties of the different parts of the model object.

The following syntax is used for all of these access methods (exemplified there with the getStringArray method for returning the value of the a string array with the name <name> for the something object.

something.getStringArray(<name>);

Note that throughout this manual, the access methods are collectively referred to as get*(<name>), where * can be any of the basic data types used below. Use these methods to read property values. The names of the access methods indicate the data type for the data that they return.

something.getString(<name>)

returns the value as a string.

something.getStringArray(<name>)

returns the value as a string array.

something.getStringMatrix(<name>)

returns the value as a string matrix.

something.getInt(<name>)

returns the value as an integer.

something.getIntArray(<name>)

returns the value as an integer array.

something.getIntMatrix(<name>)

returns the value as an integer matrix.

something.getDouble(<name>)

returns the value as a double.

something.getDoubleArray(<name>)

returns the value as a double array.

something.getDoubleMatrix(<name>)

returns the value as a double matrix.

something.getBooleanArray(<name>)

returns the value as a Boolean array.

something.getBooleanMatrix(<name>)

returns the value as a Boolean matrix.

something.selection(<name>)

returns the value as a selection object, which can be edited. This is not simply an access function. It is used to obtain a selection object both for editing and for accessing data from.

something.getEntryKeyIndex(<name>,<key>)

returns the index of a given key in a property, and

something.getEntryKeys(<name>)

returns the possible entry keys for a given property.

All arrays that are returned contain copies of the data; writing to the array does not change the data in the model object. This observation applies to all access methods of the model object that return arrays of basic data types.