Bernese GPS Software Version 5.0 - Bernese GNSS Software

19.6.2 Variables in User Scripts
19.6 User Scripts
All information required by the user scripts is available in form of system variables. This
means that, e.g., old scripts written in Bourne shell can directly use the system variable $U
and the Perl scripts could use the corresponding syntax $ENV{U}. However, new Perl scripts
that inherit the run method from the RUNBPE object should refer to the environment variables
through the object reference “$bpe” (see the example in the previous section). There
are two possibilities: $$bpe{variable name} or $bpe->{variable name}. Both syntaxes
are equivalent. The getKeys method from RUNBPE provides a general mechanism to get
variables, see Section 19.6.5.1.
All the variables available in user scripts may be divided into three categories:
1) Environment Variables
The first category contains variables defined in LOADGPS.setvar file (on UNIX platforms –
see Section 19.3.3) or listed in the special variable BERNESE VARIABLES (under Windows).
The user may arbitrarily expand the list of these variables, however at least the following
variables should always be included: ${BPE}, ${C}, ${T}, ${U}, ${X}, ${XG}, ${XQ}
(remember, however, that in the BPE the variable ${U} has been re-defined, its original
value is accessible by $$bpe{U OLD}).
In general environment variables should be accessed in Perl user scripts using the methods
$$bpe{variable name} or $bpe->{variable name} and not with $ENV{U}. It may, e.g.,
be that the client has started on a host where the Bernese environment variables are not
available. On UNIX systems the client gets the name of the LOADGPS.setvar file from the
server, extracts the variable names from there and inserts them into the client’s namespace
without defining them as system environment variables.
2) Client Variables
The BPE server sends a list of variables and their values to each client when it commands
the client to start the user script. Table 19.9 gives a list of the variables together with their
values stemming from a run of script ORBGEN in the example BPE RNX2SNX.PCF. Note, that
the script was neither master nor a slave and therefore the variables $CONTROL FILE and
$CONTROL FILE LINE are not defined.
Additional variables are defined and available as client variables. An interesting variable is
$$bpe{SYSOUT} which contains the name of the program output file of the last program
executed in a Perl user script using the run method. The script may then, e.g., append the
file to a protocol file.
In addition to the variables listed in Table 19.9 the plus-minus time variables listed on page
380f of the documentation of Version 4.2 [Hugentobler et al., 2001] such as DAYMP1 are still
available for backward compatibility. It is, however, not recommended to use these variables.
Use the method RUNBPE::getKeys instead (see Section 19.6.5.1).
Bernese GPS Software Version 5.0 Page 397