blockTimeSeries
Block that plots one or multiple time series
Extends from Buildings.Utilities.Plotters.BaseClasses.PartialPlotter (Partial block for plotters).
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.
Parameters
| Type | Name | Default | Description |
|---|---|---|---|
| String | fileName (from PartialPlotter) | plotConfiguration.fileName | Name of html file |
| String | introduction (from PartialPlotter) | "" | Introduction text written below title and above the plot |
| Integer | n (from PartialPlotter) | 0 | Number of independent data series (dimension of y) |
| Activation | |||
| Modelica.Units.SI.Time | samplePeriod (from PartialPlotter) | plotConfiguration.samplePeriod | Sample period of component |
| Buildings.Utilities.Plotters.Types.LocalActivation | activation (from PartialPlotter) | Buildings.Utilities.Plotters.Types.LocalActivation.use_activation | Set to true to enable an input that allows activating and deactivating the plotting |
| Modelica.Units.SI.Time | activationDelay (from PartialPlotter) | plotConfiguration.activationDelay | Time that needs to elapse to enable plotting after activate becomes true |
| Labels | |||
| String | title (from PartialPlotter) | getInstanceName() | Title of the plot |
| String | legend (from PartialPlotter) | String array for legend, such as {"x1", "x2"} | |
| Buildings.Utilities.Plotters.Types.TimeUnit | timeUnit | plotConfiguration.timeUnit | Time unit for plot |
Connectors
| Type | Name | Default | Description |
|---|---|---|---|
| Modelica.Blocks.Interfaces.RealVectorInput[n] | y (from PartialPlotter) | y-data | |
| Modelica.Blocks.Interfaces.BooleanInput | activate (from PartialPlotter) | Set to true to enable plotting of time series after activationDelay elapsed |
Components
| Type | Name | Default | Description |
|---|---|---|---|
| Buildings.Utilities.Plotters.Configuration | plotConfiguration (from PartialPlotter) | Default plot configuration | |
| Boolean | active (from PartialPlotter) | Flag, true if plots record data |
Revisions
-
March 23, 2018, by Michael Wetter:
First implementation.