User level interface to plotter. More...

#include <IPlotter.h>

Inheritance diagram for AIDA::IPlotter:

Public Member Functions
virtual	~IPlotter ()
	Destructor.

virtual IPlotterRegion *	createRegion (double x=0, double y=0, double w=1.0, double h=1.0)=0
	Region management methods. More...

virtual bool	createRegions (int columns=1, int rows=1, int index=0)=0
	Create a grid of regions. More...

virtual IPlotterRegion &	currentRegion () const =0

virtual int	currentRegionNumber () const =0

virtual int	numberOfRegions () const =0

virtual bool	setCurrentRegionNumber (int index)=0
	Set current region by giving its index [0,n-1].

virtual IPlotterRegion &	next ()=0
	Set current region to be the "next" one. More...

virtual IPlotterRegion *	region (int index) const =0

virtual void	destroyRegions ()=0
	Destroy regions.

virtual void	clearRegions ()=0
	Clear all regions. More...

virtual bool	setParameter (const std::string &parameter, const std::string &options="")=0

virtual std::string	parameterValue (const std::string &parameter) const =0
	Get value of a parameter. More...

virtual std::vector< std::string >	availableParameterOptions (const std::string &parameter) const =0

virtual std::vector< std::string >	availableParameters () const =0

virtual bool	show ()=0
	Map the plotter on the screen.

virtual bool	refresh ()=0
	Refresh the screen window(s). More...

virtual bool	hide ()=0
	Unmap the plotter on the screen.

virtual bool	interact ()=0
	Give control to the plotter GUI. More...

virtual bool	writeToFile (const std::string &filename, const std::string &type="")=0
	Produce an output file. More...

virtual void	setTitle (const std::string &title)=0
	Set the global title of the plotter (page).

virtual ITitleStyle &	titleStyle ()=0
	Get/set title style.

virtual void	setTitleStyle (const ITitleStyle &style)=0

Detailed Description

User level interface to plotter.

This IPlotter interface assumes the handling of multiple plotting regions. Then the IPlotter should be seen as a "page" managing multiple drawing region. It assumes that a "current" region mechanism is used.

The keyword "region" is borrowed from the OpenInventor terminology (viewing region).

See also the IPlotterRegion for more comments.

Author: The AIDA team (http://aida.freehep.org/)

Member Function Documentation

virtual void AIDA::IPlotter::clearRegions ( )

pure virtual

Clear all regions.

It does not reset the number and position of regions. This can be done through a destroyRegions.

Implemented in AIDA::IPlotterROOT.

virtual IPlotterRegion* AIDA::IPlotter::createRegion	(	double	x = `0`,
		double	y = `0`,
		double	w = `1.0`,
		double	h = `1.0`
	)

pure virtual

Region management methods.

Create a new region.

Parameters

x,y,w,h Position and size in normal coordinates that is to say between 0 and 1. Then a region with (x=0,y=0,w=1,h=1) maps the full page. "x" goes left to right. "y" bottom to top.

Returns: The newly created region. Return null in case not failure. Note that the plotter manages the regions ; user does not have to delete a region object directly.

Implemented in AIDA::IPlotterROOT.

virtual bool AIDA::IPlotter::createRegions	(	int	columns = `1`,
		int	rows = `1`,
		int	index = `0`
	)

pure virtual

Create a grid of regions.

By default the current region is the top left one (with index 0). Region are indexed from zero, with increasing order left to right, top to bottom.

Parameters

index Set the current region.

Implemented in AIDA::IPlotterROOT.

virtual IPlotterRegion& AIDA::IPlotter::currentRegion ( ) const

pure virtual

Returns: The current region.

Implemented in AIDA::IPlotterROOT.

virtual int AIDA::IPlotter::currentRegionNumber ( ) const

pure virtual

Returns: The current region index.

Implemented in AIDA::IPlotterROOT.

virtual bool AIDA::IPlotter::interact ( )

pure virtual

Give control to the plotter GUI.

The plotter must be able to return from this function from a user action in its GUI.

Implemented in AIDA::IPlotterROOT.

virtual IPlotterRegion& AIDA::IPlotter::next ( )

pure virtual

Set current region to be the "next" one.

If exceeding the number of regions, the current region index return to 0.

Returns: The new current region.

Implemented in AIDA::IPlotterROOT.

virtual int AIDA::IPlotter::numberOfRegions ( ) const

pure virtual

Returns: The number of regions.

Implemented in AIDA::IPlotterROOT.

virtual std::string AIDA::IPlotter::parameterValue ( const std::string & parameter ) const

pure virtual

Get value of a parameter.

Parameters

paramName Name of the parameter.

Returns: the value.

Implemented in AIDA::IPlotterROOT.

virtual bool AIDA::IPlotter::refresh ( )

pure virtual

Refresh the screen window(s).

Used when a plotted data analysis object received new data.

Implemented in AIDA::IPlotterROOT.

virtual IPlotterRegion* AIDA::IPlotter::region ( int index ) const

pure virtual

Returns: A region, knowing its index.

Implemented in AIDA::IPlotterROOT.

virtual bool AIDA::IPlotter::writeToFile	(	const std::string &	filename,
		const std::string &	type = `""`
	)

pure virtual

Produce an output file.

Parameters

type	A string to describe the type of the output : "PS" or "PostScript" for PostScript, "JPEG" for JPEG. If nothing is given, the type is guessed from the given file name suffix (.ps for PostScript, .jpg for JPEG, etc...).

Implemented in AIDA::IPlotterROOT.

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

IPlotter.h

Public Member Functions

Detailed Description

Member Function Documentation