IPlot Class Reference

Interface for constructing generic plots from quantities stored in storage. More...

#include <Plot.h>

Inheritance diagram for IPlot:

Public Member Functions
Interval	rangeX () const
	Returns the plotted range in x-coordinate. More...
Interval	rangeY () const
	Returns the plotted range in y-coordinate. More...
virtual std::string	getCaption () const =0
	Returns the caption of the plot. More...
virtual void	onTimeStep (const Storage &storage, const Statistics &stats)=0
	Updates the plot with new data. More...
virtual void	clear ()=0
	Clears all cached data, prepares for next run. More...
virtual void	plot (IDrawingContext &dc) const =0
	Draws the plot into the drawing context. More...
Public Member Functions inherited from Polymorphic
virtual	~Polymorphic ()

Protected Attributes
struct {
Interval   x
Interval   y
}	ranges

Detailed Description

Interface for constructing generic plots from quantities stored in storage.

The plot can currently be only 2D, typically showing a quantity dependence on time or on some spatial coordinate.

Definition at line 75 of file Plot.h.

Member Function Documentation

clear()

virtual void IPlot::clear ( )

pure virtual

Clears all cached data, prepares for next run.

Implemented in SelectedParticlePlot, MultiPlot, DataPlot, SfdPlot, AngularHistogramPlot, HistogramPlot, TemporalPlot, SpatialPlot< TDerived >, SpatialPlot< RadialDistributionPlot >, and SpatialPlot< AxialDistributionPlot >.

getCaption()

virtual std::string IPlot::getCaption ( ) const

pure virtual

Returns the caption of the plot.

Implemented in SelectedParticlePlot, MultiPlot, DataPlot, SfdPlot, AngularHistogramPlot, HistogramPlot, TemporalPlot, SpatialPlot< TDerived >, SpatialPlot< RadialDistributionPlot >, and SpatialPlot< AxialDistributionPlot >.

onTimeStep()

virtual void IPlot::onTimeStep ( const Storage &  storage, const Statistics &  stats  )

pure virtual

Updates the plot with new data.

Called every time step.

Implemented in SelectedParticlePlot, MultiPlot, DataPlot, SfdPlot, AngularHistogramPlot, HistogramPlot, and TemporalPlot.

plot()

virtual void IPlot::plot ( IDrawingContext &  dc ) const

pure virtual

Draws the plot into the drawing context.

Implemented in SelectedParticlePlot, MultiPlot, DataPlot, SfdPlot, AngularHistogramPlot, HistogramPlot, TemporalPlot, SpatialPlot< TDerived >, SpatialPlot< RadialDistributionPlot >, and SpatialPlot< AxialDistributionPlot >.

rangeX()

Interval IPlot::rangeX ( ) const

inline

Returns the plotted range in x-coordinate.

Definition at line 84 of file Plot.h.

rangeY()

Interval IPlot::rangeY ( ) const

inline

Returns the plotted range in y-coordinate.

Definition at line 89 of file Plot.h.

Member Data Documentation

struct { ... } IPlot::ranges

x

Interval IPlot::x

Definition at line 78 of file Plot.h.

y

Interval IPlot::y

Definition at line 79 of file Plot.h.

---

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

• /home/pavel/projects/astro/sph/src/core/post/Plot.h