CERN Accelerating science

• Sign in
• Directory

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

               

---

AIDA::IBaseStyle Class Reference

#include <IBaseStyle.h>

Inheritance diagram for AIDA::IBaseStyle::

List of all members.

Public Methods
virtual	~IBaseStyle ()
	Destructor. More...
virtual void	reset ()=0
virtual bool	setParameter (const std::string &paramName, const std::string &options="")=0
virtual std::string	parameterValue (const std::string &parameter) const=0
virtual std::vector<std::string>	availableParameters () const=0
virtual std::vector<std::string>	availableParameterOptions (const std::string &paramName) const=0

---

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

Definition at line 38 of file IBaseStyle.h.

---

Constructor & Destructor Documentation

AIDA::IBaseStyle::~IBaseStyle ( ) [inline, virtual]

Definition at line 42 of file IBaseStyle.h.

---

Member Function Documentation

std::vector< std::string > AIDA::IBaseStyle::availableParameterOptions ( const std::string & paramName ) const [pure virtual]

Get list of the available options for a given parameter (implementation-dependent).

std::vector< std::string > AIDA::IBaseStyle::availableParameters ( ) const [pure virtual]

Get list of the available parameters (implementation-dependent)

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

Get value of a parameter. Parameters: paramName   Name of the parameter. Returns: the value.

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

Return to original (construction time) state. Explicitly set parameters will be set to defaults and may be overridden

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

Set a parameter. Parameters: paramName   Name of the parameter. options   String of options. Returns: false if parameter (or its options) unknown or invalid.

---

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

• IBaseStyle.h

---