Buildings.Utilities.IO.Files

Reports package

Information

Package with models for writing data to files.

Extends from Modelica.Icons.Package (Icon for standard packages).

Package Content

Name	Description
CSVWriter	Model for writing results to a .csv file
CombiTimeTableWriter	Model for writing results to a format that is readable by the model CombiTimeTable
JSONWriter	Model for writing results to a json file
Printer	Model that prints values to a file
Examples	Examples package
BaseClasses	Package with base classes for Buildings.Utilities.IO.Files

Buildings.Utilities.IO.Files.CSVWriter

Model for writing results to a .csv file

Buildings.Utilities.IO.Files.CSVWriter

Information

This model samples the model inputs u and saves them to a .csv file, which can be read using e.g. Excel or Python.

Typical use and important parameters

The parameter nin defines the number of variables that are stored. In Dymola, this parameter is updated automatically when inputs are connected to the component.

The parameter fileName defines to what file name the results are saved. The file is in the current working directory, unless an absolute path is provided.

The parameter samplePeriod defines every how many seconds the inputs are saved to the file.

Options

The parameter delimiter can be used to choose a custom separator.

By default the first line of the csv file consists of the file header. The column names can be defined using parameter headerNames. The header can be removed by setting writeHeader=false

Dynamics

This model samples the outputs at an equidistant interval and hence disregards the simulation tool output interval settings.

Extends from Buildings.Utilities.IO.Files.BaseClasses.FileWriter (Partial model for writing results to a .csv file).

Parameters

Type	Name	Default	Description
String	fileName	getInstanceName() + ".csv"	File name, including extension
Time	samplePeriod		Sample period: equidistant interval for which the inputs are saved [s]
Advanced
String	delimiter	"\t"	Delimiter for csv file
Boolean	writeHeader	true	=true, to write header with variable names, otherwise no header will be written
String	headerNames[nin]	{"col" + String(i) for i in ...	Header names, indices by default
Integer	significantDigits	6	Number of significant digits that are used for converting inputs into string format

Connectors

Type	Name	Description
input RealVectorInput	u[nin]	Variables that are saved

Modelica definition

model CSVWriter "Model for writing results to a .csv file" extends Buildings.Utilities.IO.Files.BaseClasses.FileWriter( final isCombiTimeTable=false); initial algorithm if writeHeader then str := str + "time" + delimiter; for i in 1:nin-1 loop str := str + headerNames[i] + delimiter; end for; str := str + headerNames[nin] + "\n"; writeLine(filWri, str, 1); end if; end CSVWriter;

Buildings.Utilities.IO.Files.CombiTimeTableWriter

Model for writing results to a format that is readable by the model CombiTimeTable

Buildings.Utilities.IO.Files.CombiTimeTableWriter

Information

This model samples the model inputs u and saves them to a .csv file, which can be read by a Modelica.Blocks.Sources.CombiTimeTable. The Modelica.Blocks.Sources.CombiTimeTable must then have tableName="csv", as illustrated in the example Buildings.Utilities.IO.Files.Examples.CSVReader.

Typical use and important parameters

The parameter nin defines the number of variables that are stored. In Dymola, this parameter is updated automatically when inputs are connected to the component.

The parameter fileName defines to what file name the results are saved. The file is in the current working directory, unless an absolute path is provided.

The parameter samplePeriod defines every how many seconds the inputs are saved to the file.

Options

By default the first line of the csv file consists of the file header. The column names can be defined using parameter headerNames or the header can be removed by setting writeHeader=false

Dynamics

This model samples the outputs at an equidistant interval and hence disregards the simulation tool output interval settings.

Extends from Buildings.Utilities.IO.Files.BaseClasses.FileWriter (Partial model for writing results to a .csv file).

Parameters

Type	Name	Default	Description
String	fileName	getInstanceName() + ".csv"	File name, including extension
Time	samplePeriod		Sample period: equidistant interval for which the inputs are saved [s]
Advanced
String	delimiter	"\t"	Delimiter for csv file
Boolean	writeHeader	true	=true, to write header with variable names, otherwise no header will be written
String	headerNames[nin]	{"col" + String(i) for i in ...	Header names, indices by default
Integer	significantDigits	6	Number of significant digits that are used for converting inputs into string format

Connectors

Type	Name	Description
input RealVectorInput	u[nin]	Variables that are saved

Modelica definition

model CombiTimeTableWriter "Model for writing results to a format that is readable by the model CombiTimeTable" extends Buildings.Utilities.IO.Files.BaseClasses.FileWriter( final delimiter="\t", final isCombiTimeTable=true); initial algorithm if writeHeader then str :="# time" + delimiter; for i in 1:nin-1 loop str :=str + headerNames[i] + delimiter; end for; str :=str + headerNames[nin] + "\n"; writeLine(filWri, str, 1); end if; end CombiTimeTableWriter;

Buildings.Utilities.IO.Files.JSONWriter

Model for writing results to a json file

Buildings.Utilities.IO.Files.JSONWriter

Information

This model samples the model inputs u and saves them to a json file.

Typical use and important parameters

The parameter nin defines the number of variables that are stored. In Dymola, this parameter is updated automatically when inputs are connected to the component.

The parameter fileName defines to what file name the results are saved. The file is in the current working directory, unless an absolute path is provided.

The parameter keyNames defines the key names that are used to store the json values corresponding to the inputs u.

Dynamics

This model samples its inputs at the time defined by the parameter outputTime and writes them to the file fileName. The model has the following options:

If outputTime==OutputTime.Initial, results are saved at initialisation.
If outputTime==OutputTime.Custom, results are saved when the built-in variable time achieves customTime.
If outputTime==OutputTime.Terminal, results are saved when the simulation terminates.

Extends from Modelica.Blocks.Icons.DiscreteBlock (Graphical layout of discrete block component icon).

Parameters

Type	Name	Default	Description
String	fileName	getInstanceName() + ".json"	File name, including extension
String	varKeys[nin]	{"key" + String(i) for i in ...	Key names, indices by default
OutputTime	outputTime	Buildings.Utilities.IO.Files...	Time when results are written to file
Time	customTime	0	Custom time when results are stored, used if outputTime=Custom only [s]

Connectors

Type	Name	Description
input RealVectorInput	u[nin]	Variables that are saved

Modelica definition

model JSONWriter "Model for writing results to a json file" extends Modelica.Blocks.Icons.DiscreteBlock; parameter Integer nin "Number of inputs"; parameter String fileName = getInstanceName() + ".json" "File name, including extension"; parameter String[nin] varKeys = {"key" + String(i) for i in 1:nin} "Key names, indices by default"; parameter Buildings.Utilities.IO.Files.BaseClasses.OutputTime outputTime= Buildings.Utilities.IO.Files.BaseClasses.OutputTime.Terminal "Time when results are written to file"; parameter Modelica.SIunits.Time customTime = 0 "Custom time when results are stored, used if outputTime=Custom only"; Modelica.Blocks.Interfaces.RealVectorInput[nin] u "Variables that are saved"; protected parameter String insNam = getInstanceName() "Instance name"; Buildings.Utilities.IO.Files.BaseClasses.JSONWriterObject jsonWri= Buildings.Utilities.IO.Files.BaseClasses.JSONWriterObject( insNam, fileName, outputTime==Buildings.Utilities.IO.Files.BaseClasses.OutputTime.Terminal, varKeys) "File writer object"; equation if outputTime==Buildings.Utilities.IO.Files.BaseClasses.OutputTime.Terminal then Buildings.Utilities.IO.Files.BaseClasses.cacheVals(jsonWri, u); end if; if outputTime==Buildings.Utilities.IO.Files.BaseClasses.OutputTime.Initial then when initial() then Buildings.Utilities.IO.Files.BaseClasses.writeJSON(jsonWri, u); end when; end if; if outputTime==Buildings.Utilities.IO.Files.BaseClasses.OutputTime.Custom then when time>=customTime then Buildings.Utilities.IO.Files.BaseClasses.writeJSON(jsonWri, u); end when; end if; end JSONWriter;

Buildings.Utilities.IO.Files.Printer

Model that prints values to a file

Buildings.Utilities.IO.Files.Printer

Information

This model prints to a file or the terminal at a fixed sample interval.

The parameter configuration controls the printing as follows:

`configuration`	configuration
`1`	print at sample times only
`2`	print at sample times and at end of simulation
`3`	print at end of simulation only

Extends from Modelica.Blocks.Interfaces.DiscreteBlock (Base class of discrete control blocks).

Parameters

Type	Name	Default	Description
Time	samplePeriod		Sample period of component [s]
Time	startTime	0	First sample time instant [s]
String	header	""	Header to be printed
String	fileName	""	File name (empty string is the terminal)
Integer	nin	1	Number of inputs
Integer	configuration	1	Index for treating final report (see documentation)
Integer	minimumLength	1	Minimum length of result string
Integer	significantDigits	16	Number of significant digits

Connectors

Type	Name	Description
input RealInput	x[nin]	Value to be printed

Modelica definition

model Printer "Model that prints values to a file" extends Modelica.Blocks.Interfaces.DiscreteBlock( firstTrigger( start=false, fixed=true)); parameter String header="" "Header to be printed"; parameter String fileName="" "File name (empty string is the terminal)"; parameter Integer nin=1 "Number of inputs"; parameter Integer configuration = 1 "Index for treating final report (see documentation)"; parameter Integer minimumLength = 1 "Minimum length of result string"; parameter Integer significantDigits = 16 "Number of significant digits"; Modelica.Blocks.Interfaces.RealInput x[nin] "Value to be printed"; initial algorithm if (fileName <> "") then Modelica.Utilities.Files.removeFile(fileName); end if; Modelica.Utilities.Streams.print(fileName=fileName, string=header); equation if configuration < 3 then when {sampleTrigger, initial()} then Buildings.Utilities.IO.Files.BaseClasses.printRealArray( x=x, fileName=fileName, minimumLength=minimumLength, significantDigits=significantDigits); end when; end if; when terminal() then if configuration >= 2 then Buildings.Utilities.IO.Files.BaseClasses.printRealArray( x=x, fileName=fileName, minimumLength=minimumLength, significantDigits=significantDigits); end if; end when; end Printer;