CSE User's Manual

California Simulation Engine

4.56 EXPORTFILE

EXPORTFILE allows optional specification of different or additional files to receive CSE EXPORTs.

EXPORTs contain the same information as reports, but formatted for reading by other programs rather than by people. By default, CSE generates no exports. Exports are specified via the EXPORT object, described in Section 5.28 (next). As for REPORTs, CSE automatically supplies a primary export file; it has the same name and path as the input file, and extension .csv.

Input for EXPORTFILEs and EXPORTs is similar to that for REPORTFILEs and REPORTs, except that there is no page formatting. Refer to their preceding descriptions (Sections 5.24 and 5.25) for more additional discussion.

xfName

Name of EXPORTFILE object.

UnitsLegal RangeDefaultRequiredVariability
63 charactersnoneNoconstant

xfFileName=string

path name of file to be written. If no path is specified, the file is written in the current directory. If no extension is specified, .csv is used.

UnitsLegal RangeDefaultRequiredVariability
file name, path and extension optionalnoneYesconstant

xfFileStat=choice

What CSE should do if file xfFileName already exists:

OVERWRITEOverwrite pre-existing file.
NEWIssue error message if file exists.
APPENDAppend new output to present contents of existing file.

If the specified file does not exist, it is created and xfFileStat has no effect.

UnitsLegal RangeDefaultRequiredVariability
OVERWRITE, NEW, APPENDOVERWRITENoconstant

endExportFile

Optionally indicates the end of the export file definition. Alternatively, the end of the Export file definition can be indicated by END or by beginning another object.

UnitsLegal RangeDefaultRequiredVariability
noneNoconstant

Related Probes: