XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


param (param-2.18) [xmmsas_20211130_0941-20.0.0]


Parameter types

The following parameter types are supported:

bool
type that can have two values: true or false
int
a member of the set of whole numbers
real
a member of the set of rational and irrational numbers
string
sequence of characters
directory
name of the location of a list of files on a storage device
file
name of any file
dataset
name of a SAS data file
block
general type for a section of data within a dataset
table
a block in a dataset, interpreted as a table
array
a block in a dataset, interpreted as an array
column
a column of data within a table of a dataset
angle
type that allows different formats of angle specification
time
type that allows different formats of time specification


Each parameter may be specified to contain either a scalar (single) value or a list of values:

list$<$bool$>$
list$<$int$>$
list$<$real$>$
list$<$string$>$
list$<$directory$>$
list$<$file$>$
list$<$dataset$>$
list$<$block$>$
list$<$table$>$
list$<$array$>$
list$<$column$>$
list$<$angle$>$
list$<$time$>$

The use of different types allows the parameter interface to check that the value is syntactically correct and, where appropriate, within an allowable range. It also allows the GUI to provide appropriate widgets for entering the values.

For example, a file-name is simply a string, as far as the task is concerned. However, using a separate type allows the GUI to present the user with a file dialog, instead of a simple string-edit field.



Subsections
XMM-Newton SOC -- 2021-11-30