AIDA::IPlotterROOT Class Reference

User level interface to plotter. More...

#include <IPlotterROOT.h>

Inheritance diagram for AIDA::IPlotterROOT:

Public Member Functions
virtual	~IPlotterROOT ()
	Destructor.
virtual IPlotterRegion *	createRegion (double x=0, double y=0, double w=1.0, double h=1.0)
	Region management methods. More...
virtual bool	createRegions (int columns=1, int rows=1, int index=0)
	Create a grid of regions. More...
virtual IPlotterRegion &	currentRegion () const
virtual int	currentRegionNumber () const
virtual int	numberOfRegions () const
virtual bool	setCurrentRegionNumber (int index)
	Set current region by giving its index [0,n-1].
virtual IPlotterRegion &	next ()
	Set current region to be the "next" one. More...
virtual IPlotterRegion *	region (int index) const
virtual void	destroyRegions ()
	Destroy regions.
virtual void	clearRegions ()
	Clear all regions. More...
virtual bool	setParameter (const std::string &parameter, const std::string &options="")
virtual std::string	parameterValue (const std::string &parameter) const
	Get value of a parameter. More...
virtual std::vector< std::string >	availableParameterOptions (const std::string &parameter) const
virtual std::vector< std::string >	availableParameters () const
virtual bool	show ()
	Map the plotter on the screen.
virtual bool	refresh ()
	Refresh the screen window(s). More...
virtual bool	hide ()
	Unmap the plotter on the screen.
virtual bool	interact ()
	Give control to the plotter GUI. More...
virtual bool	writeToFile (const std::string &filename, const std::string &type="")
	Produce an output file. More...
virtual void	setTitle (const std::string &title)
	Set the global title of the plotter (page).
virtual ITitleStyle &	titleStyle ()
	Get/set title style.
virtual void	setTitleStyle (const ITitleStyle &style)
Public Member Functions inherited from AIDA::IPlotter
virtual	~IPlotter ()
	Destructor.

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

T. Kraemer, DESY

Version

Id:

IPlotterROOT.h,v 1.1 2006-12-18 09:49:56 tkraemer Exp

Member Function Documentation

void IPlotterROOT::clearRegions ( )

virtual

Clear all regions.

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

Implements AIDA::IPlotter.

IPlotterRegion * IPlotterROOT::createRegion ( double  x = 0, double  y = 0, double  w = 1.0, double  h = 1.0  )

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.

Implements AIDA::IPlotter.

bool IPlotterROOT::createRegions ( int  columns = 1, int  rows = 1, int  index = 0  )

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.

Implements AIDA::IPlotter.

IPlotterRegion & IPlotterROOT::currentRegion ( ) const

virtual

Returns

The current region.

Implements AIDA::IPlotter.

int IPlotterROOT::currentRegionNumber ( ) const

virtual

Returns

The current region index.

Implements AIDA::IPlotter.

bool IPlotterROOT::interact ( )

virtual

Give control to the plotter GUI.

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

Implements AIDA::IPlotter.

IPlotterRegion & IPlotterROOT::next ( )

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.

Implements AIDA::IPlotter.

int IPlotterROOT::numberOfRegions ( ) const

virtual

Returns

The number of regions.

Implements AIDA::IPlotter.

std::string IPlotterROOT::parameterValue ( const std::string &  parameter ) const

virtual

Get value of a parameter.

Parameters

paramName

Name of the parameter.

Returns

the value.

Implements AIDA::IPlotter.

bool IPlotterROOT::refresh ( )

virtual

Refresh the screen window(s).

Used when a plotted data analysis object received new data.

Implements AIDA::IPlotter.

IPlotterRegion * IPlotterROOT::region ( int  index ) const

virtual

Returns

A region, knowing its index.

Implements AIDA::IPlotter.

bool IPlotterROOT::writeToFile ( const std::string &  filename, const std::string &  type = ""  )

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...).

Implements AIDA::IPlotter.

---

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

• IPlotterROOT.h
• IPlotterROOT.cc