tkproperty_list.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 tkproperty_list_H
#define tkproperty_list_H
 
#include "tkn_config.h"
#include "tkmeasure.h"
 
#include <map>
#include <memory>
 
#ifdef HAS_ROOT
#include "TClass.h"
#endif
 
using namespace  std;
 
namespace tkn {
 
 
class tkproperty_list
{
protected:
    struct property_string {
        tkstring value{};
        tkstring unit{};
        tkstring type{};
    };
 
    using properties = std::map<tkstring, property_string>;
 
    tkstring fname{};

    properties fProperties;
    map <tkstring, shared_ptr<tkmeasure>> fDataProperties;
 
public:
    tkproperty_list(tkstring _name) : fname(_name) {;}
    virtual ~tkproperty_list() = default;

    void list_properties(const tkstring &_opt="*") const;

    void list_data_properties(const tkstring &_opt="*") const;

    bool has_property(const tkstring &_property) const;

    tkstring get_property(const tkstring &_property) const;

    tkstring get_property_unit(const tkstring &_property) const;

    tkstring get_property_type(const tkstring &_property) const;

    shared_ptr<tkmeasure> get(const tkstring &_property) const;

    const auto& get_properties() const { return fProperties; }

    vector<shared_ptr<tkmeasure>> get_data_properties(const tkstring &_opt="*");
 
protected:
    virtual void add_property_str(const tkstring &_name, const tkstring &_val, const tkstring &_unit, const tkstring &_type = "TEXT");

    virtual void add_property(const tkstring &_name, const shared_ptr<tkmeasure> &_property, const tkstring &_value_str="", const tkstring &_unit_str="!");
 
#ifdef HAS_ROOT
    ClassDef(tkproperty_list,0);
#endif
 
};
}
 
#endif