RAIDA  1.9.0
Public Member Functions | List of all members
AIDA::IBaseStyle Class Referenceabstract

Superclass for all styles in AIDA Plotting package. More...

#include <IBaseStyle.h>

Inheritance diagram for AIDA::IBaseStyle:
AIDA::IAxisStyle AIDA::IBaseStyleROOT AIDA::IBrushStyle AIDA::IDataStyle AIDA::IInfoStyle AIDA::IPlotterStyle AIDA::ITitleStyle AIDA::IAxisStyleROOT AIDA::IAxisStyleROOT AIDA::IBrushStyleROOT AIDA::IDataStyleROOT AIDA::IInfoStyleROOT AIDA::IPlotterStyleROOT AIDA::ITitleStyleROOT AIDA::IBrushStyleROOT AIDA::IFillStyle AIDA::ILineStyle AIDA::IMarkerStyle AIDA::ITextStyle AIDA::IDataStyleROOT AIDA::IInfoStyleROOT AIDA::IPlotterStyleROOT AIDA::ITitleStyleROOT

Public Member Functions

virtual ~IBaseStyle ()
 Destructor.
 
virtual void reset ()=0
 Return to original (construction time) state. More...
 
virtual bool setParameter (const std::string &paramName, const std::string &options="")=0
 Set a parameter. More...
 
virtual std::string parameterValue (const std::string &parameter) const =0
 Get value of a parameter. More...
 
virtual std::vector< std::string > availableParameters () const =0
 Get list of the available parameters (implementation-dependent)
 
virtual std::vector< std::string > availableParameterOptions (const std::string &paramName) const =0
 Get list of the available options for a given parameter (implementation-dependent).
 

Detailed Description

Superclass for all styles in AIDA Plotting package.

All styles can be reset to their original values at construction time. In the case of styles which 'contain' other styles (like IStyle or IAxisStyle), reset() calls reset() on the aggregated styles too. All styles are hierarchical, so the plotter's current style is overridden by the region's current style, which is overridden by any 'associated' style which is overwritten by any style passed in explicitly at plotting time. Parameters and options which have been explicitly set to non-default (or default!) values are 'sticky'. For example, if a style has the default 'red' and this has been set explicitly to 'blue' at the Plotter level, then it will override the default 'red' at the Region level. IF the user explicitly sets the region to 'green' (or 'red'!) then it will not be overridden by the 'parent' style.

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

Member Function Documentation

virtual std::string AIDA::IBaseStyle::parameterValue ( const std::string &  parameter) const
pure virtual

Get value of a parameter.

Parameters
paramNameName of the parameter.
Returns
the value.

Implemented in AIDA::IBaseStyleROOT.

virtual void AIDA::IBaseStyle::reset ( )
pure virtual

Return to original (construction time) state.

Explicitly set parameters will be set to defaults and may be overridden

Implemented in AIDA::IBaseStyleROOT.

virtual bool AIDA::IBaseStyle::setParameter ( const std::string &  paramName,
const std::string &  options = "" 
)
pure virtual

Set a parameter.

Parameters
paramNameName of the parameter.
optionsString of options.
Returns
false if parameter (or its options) unknown or invalid.

Implemented in AIDA::IBaseStyleROOT.


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