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]                          *
 *                                                                              *
 *   Licensed under the MIT License <http://opensource.org/licenses/MIT>.       *   
 *   SPDX-License-Identifier: MIT                                               *
 ********************************************************************************/
 
#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