tkproperty.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_H
#define tkproperty_H
 
#include "tkn_config.h"
 
#ifdef HAS_ROOT
#include "TClass.h"
#endif
 
#include "tkstring.h"
 
namespace tkn {
 
class tkproperty
{
public:
 
    enum data_info { kKnown, kUnknown, kTentative, kTheo, kAbout, kSystematic, kLimit, kUncertain} ;
 
protected:
    data_info fInfo = kUnknown;     // set a flag to a given data
    bool fconverted_value = false;  // set to true if the value has been converted in TkN
    tkstring  fReference = "";      // reference of the given data
 
public:
    tkproperty() {}
    explicit tkproperty(tkproperty::data_info _info) { set_info(_info); }
 
    virtual ~tkproperty() {}
 
    static data_info what_is(const tkstring &_st);
 
    void set_converted(bool _val=true) { fconverted_value = _val; }
 
    bool is_converted() const { return fconverted_value;}
 
    void set_info(tkproperty::data_info _info) { fInfo = _info; }
 
    data_info get_info() { return fInfo; }
    data_info get_info_const() const { return fInfo; }
 
    tkstring get_info_str(bool _showknown=true) const;
 
    bool is_info(data_info _info) const { return fInfo == _info ;}
 
    bool is_known() const { return (fInfo == kKnown) ;}
 
    void set_reference(const char *_st) { fReference = _st; }
 
    tkstring get_reference() { return fReference; }
 
    void clear() { fInfo = kUnknown; fconverted_value = false; fReference = "";}
 
#ifdef HAS_ROOT
    ClassDef(tkproperty,0);
#endif
 
};
}
 
#endif