User's Guide

PUTPARM

Places a TAE parameter into a project parameter file

Function:

Places a TAE parameter into a project parameter file (ppf).

Parameters:

OUTPPF

Output project parameter file. An ASCII text file containing project parameters. Refer to the user notes for an example of the file.

KEY

Key. The parameter key field. This value is a unique identifier for each project parameter. If duplicate keys exist, the first occurrence of the key will be used.

DTYPE

Data type. The data type of the parameter. Valid values are:

  = STRING:   A TCL string value
  = INTEGER:  A TCL integer value
  = REAL:     A TCL real value

SVAL(--)

String value. String value of parameter; it is used only if DTYPE=STRING.

IVAL(--)

Integer value. Integer value of parameter; it is used only if DTYPE=INTEGER.

RVAL(--)

Real value. Real value of parameter; it is used only if DTYPE=REAL.

Example:

1. LAS> putparm outppf=myproject key=variable dtype=real rval=10.5

   The real value 10.5 is written to the project parameter file named "myproject.ppf". The key of this value is "VARIABLE." If "myproject.ppf" does not exist, it is created. If the file exists, the record defined by this example is added to the end of the file. The resulting record appears as: VARIABLE R 1 10.5

Description/Algorithm:

This module places TAE parameters or constants into a project parameter file (ppf). The project parameter file was designed to keep track of parameters for projects which spanned multiple procedure PDFs. As each PDF needs a parameter, the parameter is retrieved with the GETPARM module. Both PUTPARM and GETPARM are designed for use inside procedure PDFs and the user should have a good knowledge of TAE Command Language (TCL).

Nonfatal Error Messages:

None.

Fatal Error Message:

1. [putparm-fatal] Fatal error encountered

   The error message displayed immediately preceding this message is the specific error that was encountered. Processing is terminated.

2. [putparm-open] Error opening project parameter file

   An error occurred when attempting to open the project parameter file. Check the name of the file and file protection codes.

User Notes:

1. The project parameter file is a free-formatted ASCII text file. The file can be created with multiple calls to PUTPARM or with a text editor. The file may be modified with a text editor and printed to a printer like any other ASCII text file. Parameters are retrieved from the file with the GETPARM module.

2. An example of a project parameter file follows. The first value is the parameter key, the second is the data type (S for string, I for integer, R for real), the third is the count (a count of 0 signifies a null value), and the remaining records are data. The number of data records must be correspond to the count field. Data records are separated by spaces.

                PROJECT              S 1 test
                IN                   S 1 [my.dir.data]my.image
                INNL                 I 1 1500
                INNS                 I 1 1500
                OUTNL                I 0
                OUTNS                I 0
                TOLVAL               R 1 0.015626
                STATSIG              R 2 0.999000 0.999000