fileToGenerate Statement

Added: build 1

Purpose

Specifies a name for the input file that is created by an input file section.

Applicability

The fileToGenerate statement can be used within RawInputFile and RowFieldInputFile sections.

Additional Information

The file will be generated when a corresponding generate action is specified in a runCommands section.

Syntax

fileToGenerate: <fileName>

Arguments

NameDescription

fileName

The name of the file that is to be generated. 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 file.

Example

The following RowFieldInputFile section has been created to manipulate three input variables. The input file section describes three variables, volume, length, and height, which are located in the specified rows and fields of an input file associated with some analysis. The inFile section specifies xyz.in as the input file to generate. When the FileWrapper component executes it will read in the xyz.template file, replace the variables in the template file with values provided by the user, and write xyz.in based upon the new data.

RowFieldInputFile inFile 
{ 
   templateFile: xyz.template 
   fileToGenerate: xyz.in 
   #          name    type    row  field 
   variable:  volume  double  1    2 
   variable:  length  double  1    3 
   variable:  height  double  2    3 
}