Macro $PARDCL
| GSI | Biophysics | SATAN long write-up |

$PARDCL( name ) type(3) init(0) comment()

Purpose

Declaration of global parameters

Parameters

name

Name of the global parameter to be defined. A global parameter may be defined as an array of up to 15 dimensions. In this case a comma-separated list of upper bounds, enclosed in parantheses () must follow the global parameter name. The lower bounds are always assumed to be 1.

type(t)

't' specifies the global parameter data type: Default type is 3

init(val)

Initialization constant(s) for the global parameter. To initialize arrays, constants may be preceded by a repetition factor enclosed in parentheses. By default, parameters are initialized as zero (numerical variables), false (booleans) or null strings (characters), respectively.

comment(c)

Comment text 'c' is kept with the global parameter.

Function

Remarks

Variables declared by $PARDCL may be modified interactively using the command IPAR. In analysis programs. $PARDCL must precede the first reference of a global parameter.

Examples

$PARDCL(X);                                                  
$PARDCL(Y);                                                  
$PARDCL(Z);                                                  
X, Y, Z are declared to be global parameters.
                                                                                
$PARDCL(X) init(1) COMMENT(run#5 29.2.84);         
$PARDCL(Y) init(2) COMMENT(run#5 29.2.84);         
$PARDCL(Z) COMMENT(run#5 29.2.84);         
X, Y, Z are declared to be global parameters of float datatype. X and Y are initialized with the corresponding values. The specified comment is assigned to all variables.
                                                                                
$PARDCL(X(5)) INIT(0,-1.,2E3,3.14,4.5E-6) TYPE(4);                         
$PARDCL(Y(10,10)) INIT((100)1.) TYPE(4);                                  
$PARDCL(Z) INIT(0.456)  TYPE(4);                                 
Two arrays, X(5) and Y(10,10), and a single variable Z are declared as double global parameters and initialized accordingly.
                                                                                
$PARDCL(I1) TYPE(1);                                         
$PARDCL(J) TYPE(1);                                         
$PARDCL(K) TYPE(1);                                         
$PARDCL(B(10))  TYPE(0) COMMENT(*);
$PARDCL(CTEXT)  TYPE(80);
                                        
The respective global parameters are declared.
| GSI | Biophysics | SATAN long write-up |
Last updated: M.Kraemer@gsi.de, 4-Aug-1999