RAIDA  1.9.0
ITuple.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_ITUPLE_H
8 #define AIDA_ITUPLE_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 IAnnotation;
21 class ICloud1D;
22 class ICloud2D;
23 class ICloud3D;
24 class IEvaluator;
25 class IFilter;
26 class IHistogram1D;
27 class IHistogram2D;
28 class IHistogram3D;
29 class IProfile1D;
30 class IProfile2D;
31 class ITupleEntry;
32 
40 class ITuple {
41 
42 public:
44  virtual ~ITuple() { /* nop */; }
45 
51  virtual std::string title() const = 0;
52 
59  virtual bool setTitle(const std::string & title) = 0;
60 
66 
69 
77  virtual bool fill(int column, double value) = 0;
78 
86  virtual bool fill(int column, float value) = 0;
87 
95  virtual bool fill(int column, int value) = 0;
96 
104  virtual bool fill(int column, short value) = 0;
105 
113  virtual bool fill(int column, long value) = 0;
114 
122  virtual bool fill(int column, char value) = 0;
123 
131  virtual bool fill(int column, bool value) = 0;
132 
140 
149 
158  virtual bool fill(const std::vector<double> & values) = 0;
159 
167  virtual bool fill(const std::vector<float> & values) = 0;
168 
176  virtual bool addRow() = 0;
177 
182  virtual void resetRow() = 0;
183 
189  virtual void reset() = 0;
190 
196  virtual int rows() const = 0;
197 
202  virtual void start() = 0;
203 
211  virtual bool skip(int rows) = 0;
212 
218  virtual bool next() = 0;
219 
227  virtual bool setRow(int rowIndex) = 0;
228 
235  virtual int findColumn(const std::string & name) const = 0;
236 
243  virtual double getDouble(int column) const = 0;
244 
251  virtual float getFloat(int column) const = 0;
252 
259  virtual int getInt(int column) const = 0;
260 
267  virtual short getShort(int column) const = 0;
268 
275  virtual long getLong(int column) const = 0;
276 
283  virtual char getChar(int column) const = 0;
284 
291  virtual bool getBoolean(int column) const = 0;
292 
299 
307 
316 
319 
325  virtual int columns() const = 0;
326 
333  virtual std::string columnName(int column) const = 0;
334 
340  virtual std::vector<std::string> columnNames() const = 0;
341 
348  virtual std::string columnType(int column) const = 0;
349 
355  virtual std::vector<std::string> columnTypes() const = 0;
356 
363  virtual double columnMin(int column) const = 0;
364 
371  virtual double columnMax(int column) const = 0;
372 
379  virtual double columnMean(int column) const = 0;
380 
387  virtual double columnRms(int column) const = 0;
388 
398  virtual bool project(IHistogram1D & histogram, IEvaluator & evaluatorX) = 0;
399 
411  virtual bool project(IHistogram1D & histogram, IEvaluator & evaluatorX, IFilter & filter) = 0;
412 
423  virtual bool project(IHistogram1D & histogram, IEvaluator & evaluatorX, IEvaluator & weight) = 0;
424 
437  virtual bool project(IHistogram1D & histogram, IEvaluator & evaluatorX, IFilter & filter, IEvaluator & weight) = 0;
438 
451  virtual bool project(IHistogram2D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY) = 0;
452 
467  virtual bool project(IHistogram2D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IFilter & filter) = 0;
468 
482  virtual bool project(IHistogram2D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & weight) = 0;
483 
499  virtual bool project(IHistogram2D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IFilter & filter, IEvaluator & weight) = 0;
500 
516  virtual bool project(IHistogram3D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ) = 0;
517 
535  virtual bool project(IHistogram3D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IFilter & filter) = 0;
536 
553  virtual bool project(IHistogram3D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IEvaluator & weight) = 0;
554 
573  virtual bool project(IHistogram3D & histogram, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IFilter & filter, IEvaluator & weight) = 0;
574 
584  virtual bool project(ICloud1D & cloud, IEvaluator & evaluatorX) = 0;
585 
597  virtual bool project(ICloud1D & cloud, IEvaluator & evaluatorX, IFilter & filter) = 0;
598 
609  virtual bool project(ICloud1D & cloud, IEvaluator & evaluatorX, IEvaluator & weight) = 0;
610 
623  virtual bool project(ICloud1D & cloud, IEvaluator & evaluatorX, IFilter & filter, IEvaluator & weight) = 0;
624 
637  virtual bool project(ICloud2D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY) = 0;
638 
653  virtual bool project(ICloud2D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IFilter & filter) = 0;
654 
668  virtual bool project(ICloud2D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & weight) = 0;
669 
685  virtual bool project(ICloud2D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IFilter & filter, IEvaluator & weight) = 0;
686 
702  virtual bool project(ICloud3D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ) = 0;
703 
721  virtual bool project(ICloud3D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IFilter & filter) = 0;
722 
739  virtual bool project(ICloud3D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IEvaluator & weight) = 0;
740 
759  virtual bool project(ICloud3D & cloud, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IFilter & filter, IEvaluator & weight) = 0;
760 
773  virtual bool project(IProfile1D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY) = 0;
774 
789  virtual bool project(IProfile1D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IFilter & filter) = 0;
790 
804  virtual bool project(IProfile1D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & weight) = 0;
805 
821  virtual bool project(IProfile1D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IFilter & filter, IEvaluator & weight) = 0;
822 
838  virtual bool project(IProfile2D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ) = 0;
839 
857  virtual bool project(IProfile2D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IFilter & filter) = 0;
858 
875  virtual bool project(IProfile2D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IEvaluator & weight) = 0;
876 
895  virtual bool project(IProfile2D & profile, IEvaluator & evaluatorX, IEvaluator & evaluatorY, IEvaluator & evaluatorZ, IFilter & filter, IEvaluator & weight) = 0;
896 
902 }; // class
904 } // namespace AIDA
905 #endif /* ifndef AIDA_ITUPLE_H */
AIDA::ITuple::next
virtual bool next()=0
Positions the cursor at the next row.
AIDA::ICloud1D
User level interface to a 1D Cloud.
Definition: ICloud1D.h:30
AIDA::ITuple::resetRow
virtual void resetRow()=0
Clear the current(not yet added) row.
AIDA::IProfile1D
User level interface to a 1-dimensional profile histogram.
Definition: IProfile1D.h:28
AIDA::IEvaluator
User&#39;s level interface of an IEvaluator.
Definition: IEvaluator.h:28
AIDA::ITuple
User level interface to a Tuple.
Definition: ITuple.h:40
AIDA::ITuple::getBoolean
virtual bool getBoolean(int column) const =0
Get the boolean stored in a given column at the current cursor&#39;s position.
AIDA::IHistogram1D
User level interface to 1D Histogram.
Definition: IHistogram1D.h:28
AIDA::ITuple::columns
virtual int columns() const =0
Get the string stored in a given column at the current cursor&#39;s position.
AIDA::ITuple::columnName
virtual std::string columnName(int column) const =0
Get the name of a column from its index.
AIDA::IHistogram3D
User level interface to 3D Histogram.
Definition: IHistogram3D.h:28
AIDA::ITuple::skip
virtual bool skip(int rows)=0
Skips a given number of rows.
AIDA::ITuple::getDouble
virtual double getDouble(int column) const =0
Get the double stored in a given column at the current cursor&#39;s position.
AIDA::ITuple::findColumn
virtual int findColumn(const std::string &name) const =0
Get the index within the ITuple of a given column.
AIDA::ITuple::~ITuple
virtual ~ITuple()
Destructor.
Definition: ITuple.h:44
AIDA::ITuple::columnType
virtual std::string columnType(int column) const =0
Get the type of a give column.
AIDA::ITuple::columnRms
virtual double columnRms(int column) const =0
Get the RMS of a given column (if it can be converted to a double).
AIDA::ITuple::title
virtual std::string title() const =0
Get the title of this ITuple.
AIDA::ITuple::addRow
virtual bool addRow()=0
Add the current row to the ITuple.
AIDA::ITuple::fill
virtual bool fill(int column, double value)=0
Get the IAnnotation corresponding to this ITuple.
AIDA::ICloud2D
User level interface to a 2D Cloud.
Definition: ICloud2D.h:30
AIDA::ITuple::rows
virtual int rows() const =0
Get the number of rows currently filled in the ITuple.
AIDA::ITuple::getChar
virtual char getChar(int column) const =0
Get the character stored in a given column at the current cursor&#39;s position.
AIDA::ITuple::columnTypes
virtual std::vector< std::string > columnTypes() const =0
Get the types of all the columns.
AIDA::ITuple::getFloat
virtual float getFloat(int column) const =0
Get the float stored in a given column at the current cursor&#39;s position.
AIDA::ITuple::getShort
virtual short getShort(int column) const =0
Get the short stored in a given column at the current cursor&#39;s position.
AIDA::IProfile2D
User level interface to a 2-dimensional profile histogram.
Definition: IProfile2D.h:28
AIDA::ITuple::start
virtual void start()=0
Positions the read cursor immediately before the first row.
AIDA::ITuple::getLong
virtual long getLong(int column) const =0
Get the long stored in a given column at the current cursor&#39;s position.
AIDA::IHistogram2D
User level interface to 2D Histogram.
Definition: IHistogram2D.h:28
AIDA::ITuple::columnNames
virtual std::vector< std::string > columnNames() const =0
Get the names of all the columns.
AIDA::ITuple::getInt
virtual int getInt(int column) const =0
Get the integer stored in a given column at the current cursor&#39;s position.
AIDA::ITuple::columnMax
virtual double columnMax(int column) const =0
Get the maximum value of a given column (if it can be converted to a double).
AIDA::ITuple::columnMin
virtual double columnMin(int column) const =0
Get the minimum value of a given column (if it can be converted to a double).
AIDA::ITuple::setTitle
virtual bool setTitle(const std::string &title)=0
Set the title of the ITuple.
AIDA::ITuple::reset
virtual void reset()=0
Reset the ITuple.
AIDA::ITuple::project
virtual bool project(IHistogram1D &histogram, IEvaluator &evaluatorX)=0
Fill an IHistogram1D from the tuple.
AIDA::IFilter
User&#39;s level interface of an IFilter.
Definition: IFilter.h:28
AIDA::ITuple::columnMean
virtual double columnMean(int column) const =0
Get the mean value of a given column (if it can be converted to a double).
AIDA::ITuple::setRow
virtual bool setRow(int rowIndex)=0
Position the cursor at a give row.
AIDA::ICloud3D
User level interface to a 3D Cloud.
Definition: ICloud3D.h:30
Generated by   doxygen 1.8.5