STx 3.9 Documentation

Up

ADesc Member Functions

Previous

dumpValueVector

Next

setValueVector

getValueVector

Returns all the values of this parameter as a vector (i.e. one-dimensional table).

This function is probably is most useful for two-dimensional parameters (two axes, one independent, one dependent). In this case it directly returns the values of this parameter.

Note that there is no predefined order in which to arrange values. Derived classes may arrange values in their own fashion. You will need to call "getIndexForCoordinates" and "getCoordinatesForIndex" if you want to find out which particular index corresponds to which coordinate (and vice versa).

See Vector Format below for a description of the vector format in this class.

Usage:

inst getValueVector [ table ]

Parameters:

table

The target table (simple or parameter) for the values.

Result:

If table was specified, table is returned, otherwise a new parameter table is created and returned. One value is stored per entry.

Vector Format:

For parameters with more than one independent axis, this function returns the values with the index of the first dimension varying most slowly and the index of the last dimension varying fastest. In addition, if there is more than one dependent axis, for each coordinate <a1,...,am> (m being the number of independent axes), the values of the dependent axes at <a1,...,am> are added to the table one after the other.

© 2009 The Austrian Academy of Sciences Acoustics Research Institute