fileToParse Statement

Added: build 1

Purpose

Specifies the name of an output file that contains values for component output variables.

Applicability

The fileToParse statement can be used inside of RawOutputFile and RowFieldOutputFile sections.

Additional Information

The file will be parsed when a corresponding parse action is specified in a runCommands section.

Syntax

fileToParse: <fileName> [allowPartialRead=true|false]

Arguments

NameDescription

fileName

The name of the file that is to be parsed. The name, or parts of it, may be specified at run-time using userVariables. If the full path for the file is not specified, the file is assumed to be located in the same directory as the FileWrapper.

Options

NameDescription

allowPartialRead

If true, causes the FileWrapper to try an parse the contents of the file (if the file's timestamp has changed) each time a variable is accessed from it. The default is false. Use this option if you want to periodically access values from an output file that is being generated while a program is running in the background.

Example

In order to identify the outputs of the program, an output file section must exist. One such section might look like this:

RowFieldOutputFile outFile 
{ 
   fileToParse: xyz.out 
   #          name         type    row  field 
   variable:  totalHeight  double  5    7
   variable:  totalWeight  double  2    4 
}

The fileToParse statement identifies xyz.out as the output file of the analysis program. Once a parse statement is issued in the RunCommands section, the component parses xyz.out to retrieve the output values for the component's two properties, totalHeight and totalWeight.