quantities.h

Go to the documentation of this file.

//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *  //
//                                                                                   //
//                       / /   / /    __    \ \  / /                                 //
//                      / /__ / /   / _ \    \ \/ /                                  //
//                     /  ___  /   | |/_/    / /\ \                                  //
//                    / /   / /    \_\      / /  \ \                                 //
//                                                                                   //
//                                                                                   //
//  Copyright (c) 2016, Jakub Benda, Charles University in Prague                    //
//                                                                                   //
// MIT License:                                                                      //
//                                                                                   //
//  Permission is hereby granted, free of charge, to any person obtaining a          //
// copy of this software and associated documentation files (the "Software"),        //
// to deal in the Software without restriction, including without limitation         //
// the rights to use, copy, modify, merge, publish, distribute, sublicense,          //
// and/or sell copies of the Software, and to permit persons to whom the             //
// Software is furnished to do so, subject to the following conditions:              //
//                                                                                   //
//  The above copyright notice and this permission notice shall be included          //
// in all copies or substantial portions of the Software.                            //
//                                                                                   //
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS          //
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       //
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE       //
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, //
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF         //
// OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  //
//                                                                                   //
//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *  //

#ifndef HEX_DB_QUANTITIES_H
#define HEX_DB_QUANTITIES_H

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

#include <iostream>
#include <string>
#include <map>
#include <vector>

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

#include "hex-rts.h"

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

#include <sqlitepp/sqlitepp.hpp>

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

class ScatteringQuantity
{
    protected:
        
        sqlitepp::session * db;
    
    public:
        
        // run-time selection mechanism
        
            baseClassRunTimeSelectionDefinitions(ScatteringQuantity, ())
        
        // properties
            
            
            virtual std::string description ()
            {
                return "";
            }
            
            virtual std::vector<std::pair<std::string,std::string>> params ()
            {
                return std::vector<std::pair<std::string,std::string>>();
            }
            
            virtual std::vector<std::string> vparams ()
            {
                return std::vector<std::string>();
            }
            
            virtual std::vector<std::string> dependencies ()
            {
                return std::vector<std::string>();
            }
            
        // database interface
            
            sqlitepp::session & session ()
            {
                return *db;
            }
            
            virtual bool initialize (sqlitepp::session & db)
            {
                this->db = &db;
                return true;
            }
            
            virtual bool createTable ()
            {
                return true;
            }
            
            virtual bool updateTable ()
            {
                return true;
            }
            
            virtual bool run (std::map<std::string,std::string> const & params)
            {
                return true;
            }
};

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

ScatteringQuantity * get_quantity (std::string name);

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

// define new scattering quantity
#define createNewScatteringQuantity(Q, NAME) \
class Q : public ScatteringQuantity \
{ \
    public: \
        derivedClassRunTimeSelectionDefinitions(ScatteringQuantity, (), Q, (), NAME) \
        std::string description (); \
        std::vector<std::pair<std::string,std::string>> params (); \
        std::vector<std::string> vparams (); \
        std::vector<std::string> dependencies (); \
        bool initialize (sqlitepp::session & db); \
        bool createTable (); \
        bool updateTable (); \
        bool run (std::map<std::string,std::string> const & params); \
}; \
addClassToParentRunTimeSelectionTable(ScatteringQuantity, Q)

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

#endif