SPH
Classes | Public Member Functions | List of all members
TemporalPlot Class Reference

Plot of temporal dependence of a scalar quantity. More...

#include <Plot.h>

Inheritance diagram for TemporalPlot:
IPlot Polymorphic

Classes

struct  Params
 Parameters of the plot. More...
 

Public Member Functions

 TemporalPlot (const IntegralWrapper &integral, const Params &params)
 Creates a plot showing the whole history of given integral. More...
 
virtual std::string getCaption () const override
 Returns the caption of the plot. More...
 
virtual void onTimeStep (const Storage &storage, const Statistics &stats) override
 Updates the plot with new data. More...
 
virtual void clear () override
 Clears all cached data, prepares for next run. More...
 
virtual void plot (IDrawingContext &dc) const override
 Draws the plot into the drawing context. More...
 
- Public Member Functions inherited from IPlot
Interval rangeX () const
 Returns the plotted range in x-coordinate. More...
 
Interval rangeY () const
 Returns the plotted range in y-coordinate. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Additional Inherited Members

- Protected Attributes inherited from IPlot
struct {
   Interval   x
 
   Interval   y
 
ranges
 

Detailed Description

Plot of temporal dependence of a scalar quantity.

Plot shows a given segment of history of a quantity. This segment moves as time goes. Alternatively, the segment can be (formally) infinite, meaning the plot shows the whole history of a quantity; the x-range is rescaled as time goes.

Definition at line 173 of file Plot.h.

Constructor & Destructor Documentation

◆ TemporalPlot()

TemporalPlot::TemporalPlot ( const IntegralWrapper integral,
const Params params 
)
inline

Creates a plot showing the whole history of given integral.

Definition at line 216 of file Plot.h.

Member Function Documentation

◆ clear()

void TemporalPlot::clear ( )
overridevirtual

Clears all cached data, prepares for next run.

Implements IPlot.

Definition at line 142 of file Plot.cpp.

◆ getCaption()

virtual std::string TemporalPlot::getCaption ( ) const
inlineoverridevirtual

Returns the caption of the plot.

Implements IPlot.

Definition at line 223 of file Plot.h.

◆ onTimeStep()

void TemporalPlot::onTimeStep ( const Storage storage,
const Statistics stats 
)
overridevirtual

Updates the plot with new data.

Called every time step.

Implements IPlot.

Definition at line 85 of file Plot.cpp.

◆ plot()

void TemporalPlot::plot ( IDrawingContext dc) const
overridevirtual

Draws the plot into the drawing context.

Implements IPlot.

Definition at line 149 of file Plot.cpp.


The documentation for this class was generated from the following files: