BCDataSet.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008, Daniel Kollar and Kevin Kroeninger. 
 * All rights reserved. 
 * 
 * For the licensing terms see doc/COPYING. 
 */ 

// ---------------------------------------------------------

#ifndef __BCDATASET__H
#define __BCDATASET__H

#include <vector>

#include "BCDataPoint.h" 

// --------------------------------------------------------- 

typedef std::vector<BCDataPoint*> BCDataVector; 

// --------------------------------------------------------- 

class BCDataSet
{

 public: 

   /* @{ */ 

   /* 
    * Default constructor 
    */ 
   BCDataSet(); 

   /* 
    * Default destructor 
    */ 
   virtual ~BCDataSet(); 

   /* @} */ 

   /* @{ */ 

   /* 
    * @param The vector of data points. 
    */ 
   BCDataVector * GetDataVector(); 

   /* 
    * @return The number of data points. 
    */
   int GetNDataPoints(); 

   /* 
    * @param index The index of the data point to be returned. 
    * @return The data point at the index. 
    */ 
   BCDataPoint* GetDataPoint(int index); 

   /* @} */ 

   /* @{ */

   int ReadDataFromFile(const char * filename, const char * treename, const char * branchnames)
   { return this ->  ReadDataFromFileTree(filename, treename, branchnames); }; 
   int ReadDataFromFile(const char * filename, int nvariables)
   { return this -> ReadDataFromFileTxt(filename, nvariables); }; 
   int ReadDataFromFile(const char * filename, std::vector<int> options_int, std::vector<double> options_double, const char * options_char)
   { return this -> ReadDataFromFileUser(filename, options_int, options_double, options_char); }; 

   int ReadDataFromFileTree(const char * filename, const char * treename, const char * branchnames); 

   int ReadDataFromFileTxt(const char * filename, int nvariables);

   virtual int ReadDataFromFileUser(const char * filename, std::vector<int> options_int, std::vector<double> options_double, const char * options_char);

   void AddDataPoint(BCDataPoint* datapoint); 

   void Reset(); 

   /* @} */ 

 private: 

   /* 
    * A vector containing the data points 
    */ 
   BCDataVector* fBCDataVector; 

}; 

// --------------------------------------------------------- 

#endif 

---