tkdb_table.h

/********************************************************************************
 *   Copyright (c) : Université de Lyon 1, CNRS/IN2P3, UMR5822,                 *
 *                   IP2I, F-69622 Villeurbanne Cedex, France                   *
 *                   Normandie Université, ENSICAEN, UNICAEN, CNRS/IN2P3,       *
 *                   LPC Caen, F-14000 Caen, France                             *
 *   Contibutor(s) :                                                            *
 *      Jérémie Dudouet jeremie.dudouet@cnrs.fr [2020]                          *
 *      Diego Gruyer    diego.gruyer@cnrs.fr    [2020]                          *
 *                                                                              *
 *    This software is governed by the CeCILL-B license under French law and    *
 *    abiding by the  rules of distribution of free  software.  You can use,    *
 *    modify  and/ or  redistribute  the  software under  the  terms of  the    *
 *    CeCILL-B license as circulated by CEA, CNRS and INRIA at the following    *
 *    URL \"http://www.cecill.info\".                                           *
 *                                                                              *
 *    As a counterpart to the access  to the source code and rights to copy,    *
 *    modify  and redistribute granted  by the  license, users  are provided    *
 *    only with a limited warranty  and the software's author, the holder of    *
 *    the economic  rights, and the  successive licensors have  only limited    *
 *    liability.                                                                *
 *                                                                              *
 *    In this respect, the user's attention is drawn to the risks associated    *
 *    with loading,  using, modifying  and/or developing or  reproducing the    *
 *    software by the user in light of its specific status of free software,    *
 *    that  may mean that  it is  complicated to  manipulate, and  that also    *
 *    therefore  means that it  is reserved  for developers  and experienced    *
 *    professionals having in-depth  computer knowledge. Users are therefore    *
 *    encouraged  to load  and test  the software's  suitability  as regards    *
 *    their  requirements  in  conditions  enabling the  security  of  their    *
 *    systems  and/or data to  be ensured  and, more  generally, to  use and    *
 *    operate it in the same conditions as regards security.                    *
 *                                                                              *
 *    The fact that  you are presently reading this means  that you have had    *
 *    knowledge of the CeCILL-B license and that you accept its terms.          *
 ********************************************************************************/
 
#ifndef tkdb_table_H
#define tkdb_table_H
 
#include <map>
#include <iostream>
 
#include "sqlite3.h"
#include "tkstring.h"
#include "tkdb_column.h"
 
namespace tkn {
 
typedef std::map<tkstring,tkdb_column> row;
 
class tkdb_table
{
 
    /* data types in sqlite3
#define SQLITE_INTEGER  1
#define SQLITE_FLOAT    2
#define SQLITE_BLOB     4
#define SQLITE_NULL     5
#ifdef SQLITE_TEXT
# undef SQLITE_TEXT
#else
# define SQLITE_TEXT     3
#endif
#define SQLITE3_TEXT     3
    */
 
public:
 
    struct measure_data_struct {
        // never ever ever change the order of the fields
        double value    = 0.;
        double err      = 0.;
        double err_low  = 0.;
        double err_high = 0.;
        tkstring unit   = "";
        tkstring info   = "";
        bool filled     = false;
 
        void clear() {
            value    = 0.;
            err      = 0.;
            err_low  = 0.;
            err_high = 0.;
            unit     = "";
            info     = "";
            filled   = false;
        }
 
        void print() {
            std::cout<<"value   : "<<value<<std::endl;
            std::cout<<"unit    : "<<unit<<std::endl;
            std::cout<<"err     : "<<err<<std::endl;
            std::cout<<"err_low : "<<err_low<<std::endl;
            std::cout<<"err_high: "<<err_high<<std::endl;
            std::cout<<"info    : "<<info<<std::endl;
        }
    };
 
protected:
    tkstring fName;
    sqlite3* fDataBase{}; // pointer to the sql database owning the table
    row fColumns;       // map of db_columns ('name', column)
    std::vector<tkstring> fOrderedColumnNames; // column name in insertion order
    sqlite3_stmt* fSQL_stmt{}; // sql statement to select rows and loop over them (begin() next() end())
    bool fReading = false;
    tkstring fConstraint;
 
   public:
   tkdb_table(const char* _name, sqlite3 *_db);
   tkdb_table(){}
   virtual ~tkdb_table();
 
   tkstring get_name(){return fName;}
 
   tkdb_column &operator[](const char* _column) {
            return fColumns[_column];
         }
 
   void print(const tkstring &_opt="");
   void print_columns(const tkstring &_opt="");
   void print_rows(const char* _selection, const char *_properties="*");
 
   void begin(tkstring _condition, tkstring _selection="*"); 
   bool next(); 
   void end(); 
 
   void load();
   void add_column(const char *_colname, const char *_coltype);
   void add_constraint(const char *_constraint);
   bool has_column(const tkstring &_col_name);
   void reset_column_values();
   void push_row();
   void update_row(const tkstring &_where);
   void write_to_database();
   void push_dummy_row();
   row & get_columns(){return fColumns;}
 
   void read_measure(measure_data_struct &_struct, const tkstring &_col_base_name);
 
private:
   int exec_sql(const char *_cmd);
 
#ifdef HAS_ROOT
   ClassDef(tkdb_table,0);
#endif
 
};
}
#endif