Buildings.Utilities.Plotters
Package with blocks to create plots
Information
Package with blocks that allow generating time series and scatter plots, and writing these plots to one or several html files. The plots can be deactivated based on an input signal and a time delay, for example, to plot data only while the HVAC system operates for at least 30 minutes.
See Buildings.Utilities.Plotters.UsersGuide for instructions.
Extends from Modelica.Icons.Package (Icon for standard packages).
Package Content
Name | Description |
---|---|
UsersGuide | User's Guide |
Configuration | Configuration for plotters |
Scatter | Block that plots one or multiple scatter plots |
TimeSeries | Block that plots one or multiple time series |
Types | Package with type definitions |
Examples | Collection of models that illustrate model use and test models |
Validation | Collection of validation models |
BaseClasses | Package with base classes for Buildings.Utilities.Plotters |
Buildings.Utilities.Plotters.Configuration
Configuration for plotters
Information
This block can be used to globally configure the parameters for the blocks from the package Buildings.Utilities.Plotters. Use this block for example to set the same plot file name and sampling time.
To use this block, simply drag it at the top-most level, or higher, where your plotters are.
Extends from Modelica.Blocks.Icons.Block (Basic graphical layout of input/output block).
Parameters
Type | Name | Default | Description |
---|---|---|---|
Time | samplePeriod | Sample period of component [s] | |
String | fileName | Modelica.Utilities.Files.ful... | Name of html file |
Labels | |||
TimeUnit | timeUnit | Types.TimeUnit.hours | Time unit for plot |
Activation | |||
GlobalActivation | activation | Buildings.Utilities.Plotters... | Set to true to enable an input that allows activating and deactivating the plotting |
Time | activationDelay | 0 | Time that needs to elapse to enable plotting after activate becomes true [s] |
Connectors
Type | Name | Description |
---|---|---|
input BooleanInput | activate | Set to true to enable plotting of time series after activationDelay elapsed |
Modelica definition
Buildings.Utilities.Plotters.Scatter
Block that plots one or multiple scatter plots
Information
Block that plots n
time series that are connected
at the input port y
against the independent data
that are connected at the input port x
.
To use this block, set the parameter n
to the
number of time series y
that you like to plot
against x
.
Then, connect the signals for the independent data
to x
and the signals for the dependent data to
y
.
There can be multiple instances of this block.
If they share the same value for fileName
,
then they will add their plot to the same output file.
For convenience, we recommend to drag an instance of
Buildings.Utilities.Plotters.Configuration
at the top-level of your model. This instance can then
be used to globally set the fileName
and
the samplePeriod
for all plotters.
Extends from Buildings.Utilities.Plotters.BaseClasses.PartialPlotter (Partial block for plotters).
Parameters
Type | Name | Default | Description |
---|---|---|---|
String | fileName | plotConfiguration.fileName | Name of html file |
String | introduction | "" | Introduction text written below title and above the plot |
Activation | |||
Time | samplePeriod | plotConfiguration.samplePeriod | Sample period of component [s] |
LocalActivation | activation | Buildings.Utilities.Plotters... | Set to true to enable an input that allows activating and deactivating the plotting |
Time | activationDelay | plotConfiguration.activation... | Time that needs to elapse to enable plotting after activate becomes true [s] |
Labels | |||
String | title | getInstanceName() | Title of the plot |
String | legend[n] | String array for legend, such as {"x1", "x2"} | |
String | xlabel | "" | x-label |
Connectors
Type | Name | Description |
---|---|---|
input RealVectorInput | y[n] | y-data |
input BooleanInput | activate | Set to true to enable plotting of time series after activationDelay elapsed |
input RealInput | x | x-data |
Modelica definition
Buildings.Utilities.Plotters.TimeSeries
Block that plots one or multiple time series
Information
Block that plots n
time series.
To use this block, set the parameter n
to the
number of time series that you like to plot.
Then, connect the signals for these time series to the input
port y
.
There can be multiple instances of this block.
If they share the same value for fileName
,
then they will add their plot to the same output file.
For convenience, we recommend to drag an instance of
Buildings.Utilities.Plotters.Configuration
at the top-level of your model. This instance can then
be used to globally set the fileName
and
the samplePeriod
for all plotters.
Extends from Buildings.Utilities.Plotters.BaseClasses.PartialPlotter (Partial block for plotters).
Parameters
Type | Name | Default | Description |
---|---|---|---|
String | fileName | plotConfiguration.fileName | Name of html file |
String | introduction | "" | Introduction text written below title and above the plot |
Activation | |||
Time | samplePeriod | plotConfiguration.samplePeriod | Sample period of component [s] |
LocalActivation | activation | Buildings.Utilities.Plotters... | Set to true to enable an input that allows activating and deactivating the plotting |
Time | activationDelay | plotConfiguration.activation... | Time that needs to elapse to enable plotting after activate becomes true [s] |
Labels | |||
String | title | getInstanceName() | Title of the plot |
String | legend[n] | String array for legend, such as {"x1", "x2"} | |
TimeUnit | timeUnit | plotConfiguration.timeUnit | Time unit for plot |
Connectors
Type | Name | Description |
---|---|---|
input RealVectorInput | y[n] | y-data |
input BooleanInput | activate | Set to true to enable plotting of time series after activationDelay elapsed |