unit_support.h

Go to the documentation of this file.

//
// Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of datatools.
//
// datatools is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// datatools is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with datatools. If not, see <http://www.gnu.org/licenses/>.

#ifndef DATATOOLS_INTROSPECTION_UNIT_SUPPORT_H
#define DATATOOLS_INTROSPECTION_UNIT_SUPPORT_H

// Third party:
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/i_tree_dump.h>
#ifndef Q_MOC_RUN
#include <datatools/reflection_interface.h>
#endif // Q_MOC_RUN

namespace datatools {

  namespace introspection {

    enum unit_support_type {
      UNIT_SUPPORT_INVALID            = -1, 
      UNIT_SUPPORT_NONE               =  0, 
      UNIT_SUPPORT_IMPLICIT_UNIT      =  1, 
      UNIT_SUPPORT_EXPLICIT_DIMENSION =  2  
    };

    const std::string & to_string(unit_support_type);

    bool from_string(const std::string & label_, unit_support_type & us_);

    unit_support_type from_label_to_unit_support(const std::string & label_);

    bool is_valid(unit_support_type);

    bool is_no_unit_support(unit_support_type);

    bool is_implicit_unit(unit_support_type);

    bool is_explicit_unit_dimension(unit_support_type);

    class unit_info : public datatools::i_tree_dumpable
    {
    public:

      unit_info();

      unit_info(unit_support_type, const std::string & unit_token_, const std::string & unit_token2_ = "");

      virtual ~unit_info();

      bool is_valid() const;

      bool has_implicit_unit() const;

      bool has_explicit_unit_dimension() const;

      void set_unit_support(unit_support_type);

      unit_support_type get_unit_support() const;

      void set_implicit_unit_symbol(const std::string &);

      const std::string & get_implicit_unit_symbol() const;

      void set_explicit_unit_dimension_label(const std::string &);

      const std::string & get_explicit_unit_dimension_label() const;

      bool has_preferred_unit_symbol() const;

      void set_preferred_unit_symbol(const std::string &);

      const std::string & get_preferred_unit_symbol() const;

      void make_none();

      void make_implicit_unit(const std::string & unit_symbol_,
                              const std::string & preferred_unit_symbol_ = "");


      void make_explicit_unit_dimension(const std::string & unit_dimension_label_,
                                        const std::string & preferred_unit_symbol_ = "");

      void initialize(const datatools::properties &);

      void reset();

      enum unit_info_xc_flags {
        UI_XC_CLEAR              = bit_mask::bit00,
        UI_XC_UNIT_SUPPORT       = bit_mask::bit01,
        UI_XC_PREFERRED_UNIT     = bit_mask::bit02,
        UI_XC_DEFAULT = (UI_XC_CLEAR
                         | UI_XC_UNIT_SUPPORT
                         | UI_XC_PREFERRED_UNIT),
        DD_XC_LAST    = UI_XC_PREFERRED_UNIT
      };

      void export_to_config(datatools::properties & config_,
                            uint32_t flags_ = UI_XC_DEFAULT,
                            const std::string & prefix_ = "") const;

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_  = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const;

      bool operator==(const unit_info & ui_) const;

    private:

      unit_support_type _us_;                      
      std::string _implicit_unit_symbol_;          
      std::string _explicit_unit_dimension_label_; 
      std::string _preferred_unit_symbol_;         

    };

  } // end of namespace introspection

} // end of namespace datatools

#ifndef Q_MOC_RUN
// Activate reflection layer:
DR_TYPE_INIT(::datatools::introspection::unit_support_type)
#endif // Q_MOC_RUN

#endif // DATATOOLS_INTROSPECTION_UNIT_SUPPORT_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --