RAIDA  1.9.0
IPlotterRegion.h
1 // -*- C++ -*-
2 // AID-GENERATED
3 // =========================================================================
4 // This class was generated by AID - Abstract Interface Definition
5 // DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
6 // =========================================================================
7 #ifndef AIDA_IPLOTTERREGION_H
8 #define AIDA_IPLOTTERREGION_H 1
9 
10 // This file is part of the AIDA library
11 // Copyright (C) 2002 by the AIDA team. All rights reserved.
12 // This library is free software and under the terms of the
13 // GNU Library General Public License described in the LGPL.txt
14 
15 #include <string>
16 #include <vector>
17 
18 namespace AIDA {
19 
20 class IBaseHistogram;
21 class IDataPointSet;
22 class IFunction;
23 class IInfo;
24 class IPlotterLayout;
25 class IPlotterStyle;
26 
63 
64 public:
66  virtual ~IPlotterRegion() { /* nop */; }
67 
76  virtual bool plot(const IBaseHistogram & histogram, const std::string & options = "") = 0;
77 
78  virtual bool plot(const IBaseHistogram & histogram, const IPlotterStyle & style, const std::string & options = "") = 0;
79 
80  virtual bool plot(const IFunction & function, const std::string & options = "") = 0;
81 
82  virtual bool plot(const IFunction & function, const IPlotterStyle & style, const std::string & options = "") = 0;
83 
84  virtual bool plot(const IDataPointSet & dataPointSet, const std::string & options = "") = 0;
85 
86  virtual bool plot(const IDataPointSet & dataPointSet, const IPlotterStyle & style, const std::string & options = "") = 0;
87 
92  virtual bool remove(const IBaseHistogram & histogram) = 0;
93 
94  virtual bool remove(const IFunction & function) = 0;
95 
96  virtual bool remove(const IDataPointSet & dataPointSet) = 0;
97 
102  virtual void clear() = 0;
103 
109  virtual bool setParameter(const std::string & parameter, const std::string & options = "") = 0;
110 
116  virtual std::string parameterValue(const std::string & parameter) const = 0;
117 
118  virtual std::vector<std::string> availableParameterOptions(const std::string & parameter) const = 0;
119 
120  virtual std::vector<std::string> availableParameters() const = 0;
121 
125  virtual IPlotterStyle & style() = 0;
126 
130  virtual bool setStyle(const IPlotterStyle & style) = 0;
131 
135  virtual bool applyStyle(const IPlotterStyle & style) = 0;
136 
140  virtual void setTitle(const std::string & title) = 0;
141 
145  virtual bool setXLimits(double min = 0, double max = 0) = 0;
146 
147  virtual bool setYLimits(double min = 0, double max = 0) = 0;
148 
149  virtual bool setZLimits(double min = 0, double max = 0) = 0;
150 
155  virtual IPlotterLayout & layout() = 0;
156 
157  virtual bool setLayout(const IPlotterLayout & layout) = 0;
158 
162  virtual IInfo & info() = 0;
163 }; // class
164 } // namespace AIDA
165 #endif /* ifndef AIDA_IPLOTTERREGION_H */
virtual bool applyStyle(const IPlotterStyle &style)=0
Set the style of a region and apply it to scene objects.
virtual bool setParameter(const std::string &parameter, const std::string &options="")=0
Set various plotting paramters for the region.
Principal user-level function interface.
Definition: IFunction.h:35
User level interface to a plotter region.
Definition: IPlotterRegion.h:62
User level interface to plotter style.
Definition: IPlotterStyle.h:34
virtual std::string parameterValue(const std::string &parameter) const =0
Get value of a parameter.
Interface to permit customization of the layout of scene objects.
Definition: IPlotterLayout.h:28
The info class permits to access the info area of a region.
Definition: IInfo.h:32
virtual bool setXLimits(double min=0, double max=0)=0
Set limit of an axis representation the region area.
Basic user-level interface class for holding and managing a single set of &quot;data points&quot;.
Definition: IDataPointSet.h:31
virtual void setTitle(const std::string &title)=0
Set the title of a region.
class IAnnotation;
Definition: IBaseHistogram.h:29
virtual bool setStyle(const IPlotterStyle &style)=0
Set the style of a region.
virtual IInfo & info()=0
Return an IInfo object describing the info area.
virtual IPlotterStyle & style()=0
Get the style of the region.
virtual ~IPlotterRegion()
Destructor.
Definition: IPlotterRegion.h:66
virtual void clear()=0
Clear the list of things to plot in the region.
virtual IPlotterLayout & layout()=0
To customize axis position,etc...
virtual bool plot(const IBaseHistogram &histogram, const std::string &options="")=0
Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the regi...