CurrentModule = ModiaResult
This chapter documents the functions that a user of this package typically utilizes.
The following functions are available when prefixed with ModiaResult.
!!! note
ModiaResult does not export any symbols.
(for example: import ModiaResult; ModiaResult.usePlotPackage("PyPlot")).
Some packages, such as [Modia](https://github.com/ModiaSim/Modia.jl), export all
the function names below and then the functions can be directly accessed.\
(for example: `using Modia; usePlotPackage("PyPlot")`).
| Functions | Description |
|---|---|
@usingModiaPlot |
Expands into using ModiaPlot_<PlotPackageName> |
usePlotPackage |
Define the plot package to be used. |
usePreviousPlotPackage |
Define the previously defined plot package to be used. |
currentPlotPackage |
Return name defined with usePlotPackage |
resultInfo |
Return info about the result as DataFrame table |
printResultInfo |
Print info of the result on stdout. |
rawSignal |
Return raw signal data given the signal name. |
getPlotSignal |
Return signal data prepared for a plot package. |
defaultHeading |
Return default heading of a result. |
signalNames |
Return all signal names. |
timeSignalName |
Return the name of the time signal. |
hasOneTimeSignal |
Return true if one time signal present. |
hasSignal |
Return true if a signal name is known. |
The following functions are available after @usingModiaPlot has been executed:
CurrentModule = ModiaPlot_PyPlot
| Functions | Description |
|---|---|
plot |
Plot simulation results in multiple diagrams/figures. |
saveFigure |
Save figure in different formats on file. |
closeFigure |
Close one figure |
closeAllFigures |
Close all figures |
showFigure |
Show figure in window (only GLMakie, WGLMakie) |
CurrentModule = ModiaResult
The following function is typically only used for testing
| Functions | Description |
|---|---|
ModiaResult.ResultDict |
Return a new instance of a ResultDict dictionary. |
The following functions are provided by package ModiaResult.
Other useful functions are available in the Abstract Interface.
@usingModiaPlot
usePlotPackage
usePreviousPlotPackage
currentPlotPackage
resultInfo
printResultInfo
getPlotSignal
The following functions are available after
ModiaResult.@usingModiaPlothas been executed. The documentation below was generated with ModiaPlot_PyPlot.
CurrentModule = ModiaPlot_PyPlot
plot
saveFigure
closeFigure
closeAllFigures
showFigure
CurrentModule = ModiaResult
ResultDict