tkunit.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 tkunit_H
#define tkunit_H
 
#include "tkn_config.h"
 
#include <map>
#include <cmath>
 
#ifdef HAS_ROOT
#include "TClass.h"
#endif
 
#include "tkstring.h"
#include "tklog.h"
 
namespace tkn {
 
class tkunit_manager
{
    friend class tkunit;
 
public:
 
    enum units_type { kUndef_type,
                      kEnergy,
                      kTime,
                      kLenght,
                      kNoConvUnits
    };
 
    enum units_keys { Undef_unit,
                      eV, keV, MeV, GeV, TeV,                    // energy
                      as, fs, ps, ns, us, ms, s, min, h, d, y,   // time
                      am, fm, pm, nm, um, mm, cm, m,             // lenght
    };
 
    static std::vector< std::tuple<tkstring, units_type, double>> funits_properties;
 
protected:
 
    static tkunit_manager *g_unit_manager;
 
    static std::vector<tkstring>   funits_name;
    static std::vector<units_type> funits_type;
    static std::vector<double>     fcoeffs;
 
    std::map<units_keys, tkstring>  funits_map_id_to_string;
    std::map<tkstring,units_keys>   funits_map_string_to_id;
    std::map<tkstring,units_keys>   funits_map_string_to_id_low;
    std::map<units_keys,double>     funits_map_conv_coeffs;
    std::map<units_keys,units_type> funits_map_types;
 
public:
    tkunit_manager();
    virtual ~tkunit_manager() = default;
 
    tkstring get_name(const units_keys &_key) {
        if(funits_map_id_to_string.count(_key)) return funits_map_id_to_string.at(_key);
        else glog << warning_o << "data_units_manager::get_name(" << _key << "): unkown key " << do_endl;
        return funits_map_id_to_string.at(Undef_unit);
    }
    units_keys get_key(const tkstring &_name) {
        tkstring tmp = _name.copy().to_lower();
        if(funits_map_string_to_id_low.count(tmp)) return funits_map_string_to_id_low.at(tmp);
        else { // add no conversion unit
            int i = funits_map_id_to_string.size();
            funits_map_id_to_string[(units_keys)i] = _name;
            funits_map_string_to_id[_name] = (units_keys)i;
            funits_map_string_to_id_low[tmp] = (units_keys)i;
            funits_map_conv_coeffs[(units_keys)i] = 1;
            funits_map_types[(units_keys)i] = kNoConvUnits;
            return funits_map_string_to_id_low.at(tmp);
        }
//        else glog << warning_o << "data_units_manager::get_key(" << _name << "): unkown unit name " << do_endl;
        return Undef_unit;
    }
    units_type get_type(const units_keys &_key) {
        if(funits_map_types.count(_key)) return funits_map_types.at(_key);
        else glog << warning_o << "data_units_manager::get_type(" << _key << "): unkown key " << do_endl;
        return funits_map_types.at(Undef_unit);
    }
 
    static tkunit_manager *the_unit_manager();
 
private:
    double get_factor(const units_keys &_key) {
        if(funits_map_conv_coeffs.count(_key)) return funits_map_conv_coeffs.at(_key);
        else glog << warning_o << "data_units_manager::get_factor(" << _key << "): unkown key " << do_endl;
        return funits_map_conv_coeffs.at(Undef_unit);
    }
 
#ifdef HAS_ROOT
    ClassDef(tkunit_manager,0);
#endif
};
 
#define gunits (tkn::tkunit_manager::the_unit_manager())
 
class tkunit
{
protected:
    tkunit_manager::units_keys fUnit_key = tkunit_manager::units_keys::Undef_unit;
    double fFactor = std::nan("0");
    double fValue  = -1.;
 
public:
    tkunit() {;}
    tkunit(double _value, const tkunit_manager::units_keys &_unit);
    tkunit(double _value, const tkstring &_unit) : tkunit(_value, gunits->get_key(_unit)) {}
 
    virtual ~tkunit() {}
 
    double get_value() const { return fValue/fFactor;}
 
    void set_value(const double &_val, const tkstring &_unit="");
    void set_value(const double &_val, const tkunit_manager::units_keys &_unit);
 
    bool set_unit(const tkstring &_unit);
    bool set_unit(const tkunit_manager::units_keys &_unit);
 
    tkstring get_unit_name() const { return gunits->get_name(fUnit_key);}
    tkunit_manager::units_keys get_unit_key() const { return fUnit_key;}
 
    void clear() { fValue  = 0.;}
 
#ifdef HAS_ROOT
    ClassDef(tkunit,0);
#endif
 
};
}
 
#endif