Files
geant4/examples/extended/analysis/A01/include/AIDA/ITupleFactory.h
T
2016-06-08 16:57:27 +02:00

149 lines
6.2 KiB
C++

//
// ********************************************************************
// * DISCLAIMER *
// * *
// * The following disclaimer summarizes all the specific disclaimers *
// * of contributors to this software. The specific disclaimers,which *
// * govern, are listed with their locations in: *
// * http://cern.ch/geant4/license *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. *
// * *
// * This code implementation is the intellectual property of the *
// * GEANT4 collaboration. *
// * By copying, distributing or modifying the Program (or any work *
// * based on the Program) you indicate your acceptance of this *
// * statement, and all its terms. *
// ********************************************************************
//
// -*- C++ -*-
// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
// =========================================================================
#ifndef AIDA_ITUPLEFACTORY_H
#define AIDA_ITUPLEFACTORY_H 1
// This file is part of the AIDA library
// Copyright (C) 2002 by the AIDA team. All rights reserved.
// This library is free software and under the terms of the
// GNU Library General Public License described in the LGPL.txt
#include <string>
#include <vector>
namespace AIDA {
class IEvaluator;
class IFilter;
class ITuple;
/**
* A factory for creating ITuples.
*
* @author The AIDA team (http://aida.freehep.org/)
*/
class ITupleFactory {
public:
/// Destructor.
virtual ~ITupleFactory() { /* nop */; }
/**
* Creates an NTuple
* @param name The persistency name of the n-tuple
* @param title The title of the n-tuple
* @param columnNames The names of the columns
* @param columnType The types of the columns
* @param options NTuple options (currently undefined)
*
*/
virtual ITuple * create(const std::string & name, const std::string & title, const std::vector<std::string> & columnNames, const std::vector<std::string> & columnType, const std::string & options = "") = 0;
/**
* Creates an NTuple
* @param name The persistency name of the n-tuple
* @param title The title of the n-tuple
* @param columns The names and types of the columns e.g. "float px, py, pz, float energy, int charge"
* @param options NTuple options (currently undefined)
*
*/
virtual ITuple * create(const std::string & name, const std::string & title, const std::string & columns, const std::string & options = "") = 0;
/**
* Creates a logical chain of ITuples. All ITuples in the set must
* have the same structure. Chained ITuple can not be filled.
* Original n-tuple data is not copied.
* @param name The persistency name of the new n-tuple
* @param title The title of the new n-tuple
* @param set The array of ITuples to chain
*
*/
virtual ITuple * createChained(const std::string & name, const std::string & title, const std::vector<ITuple *> & set) = 0;
/**
* Creates a logical chain of ITuples. All ITuples in the set must
* have the same structure. Chained ITuple can not be filled.
* Original n-tuple data is not copied.
* @param name The persistency name of the new n-tuple
* @param title The title of the new n-tuple
* @param set The array of the names of the ITuples to chain
*
*/
virtual ITuple * createChained(const std::string & name, const std::string & title, const std::vector<std::string> & set) = 0;
/**
* Creates a new reduced tuple (less rows) from an existing one
* by applying a filter. Data is explicitly copied to a new n-tuple.
* @param name The persistency name of the new n-tuple
* @param tuple Original n-tuple
* @param filter IFilter to be used
*
*/
virtual ITuple * createFiltered(const std::string & name, ITuple & tuple, IFilter & filter) = 0;
/**
* Creates a new reduced tuple (less rows) from an existing one
* by applying a filter. Only subset of the variables (columns) is copied.
* Data is explicitly copied to a new n-tuple.
* @param name The persistency name of the new n-tuple
* @param tuple Original n-tuple
* @param filter IFilter to be used
* @param columns Names of columns to for a new n-tuple
*
*/
virtual ITuple * createFiltered(const std::string & name, ITuple & tuple, IFilter & filter, const std::vector<std::string> & columns) = 0;
/**
* Creates IFilter object given a string defining of the "cut" expression.
* @param expression String defining of the "cut" expression.
*
*/
virtual IFilter * createFilter(const std::string & expression) = 0;
/**
* Creates a filter object given a string defining the "cut" expression.
* Filter processes only subset of data.
* @param expression String defining of the "cut" expression.
* @param rowsToProcess How many rows to process
* @param startingRow Row number where to start
*
*/
virtual IFilter * createFilter(const std::string & expression, int rowsToProcess, int startingRow = 0) = 0;
/**
* Create IEvaluator object given its expression.
* @param expression String defining of the evaluator expression.
*
*/
virtual IEvaluator * createEvaluator(const std::string & expression) = 0;
}; // class
}; // namespace AIDA
#endif /* ifndef AIDA_ITUPLEFACTORY_H */