parameter_store.h

Go to the documentation of this file.

//
// Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of Bayeux.
//
// Bayeux 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.
//
// Bayeux 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 Bayeux. If not, see <http://www.gnu.org/licenses/>.

#ifndef MYGSL_PARAMETER_STORE_H
#define MYGSL_PARAMETER_STORE_H

// Standard library:
#include <string>
#include <map>
#include <vector>
#include <list>

// Third party:
// - Boost :
#include <boost/variant.hpp>
// - Bayeux/datatools :
#include <datatools/i_tree_dump.h>
#include <datatools/types.h>

namespace mygsl {

  class parameter_store : public datatools::i_tree_dumpable
  {
  public:

    static const int INVALID_INDEX = -1;

    typedef boost::variant<bool, int, double, std::string> param_type;

    struct parameter_record {
    public:

      parameter_record();

      parameter_record(parameter_store &);

      void set_parent(parameter_store &);

      void set_index(int index_);

      int get_index() const;

      void set_name(const std::string & name_);

      const std::string & get_name() const;

      void set_type(datatools::basic_type);

      datatools::basic_type get_type() const;

      bool is_boolean() const;

      bool is_integer() const;

      bool is_real() const;

      bool is_string() const;

      void set_description(const std::string & description_);

      const std::string & get_description() const;

      void reset();

      bool is_value_set() const;

      void set_boolean_value(bool, bool update_ = true);

      void set_integer_value(int, bool update_ = true);

      void set_real_value(double, bool update_ = true);

      void set_string_value(const std::string &, bool update_ = true);

      void unset_value(bool update_ = true);

      bool to_boolean() const;

      int to_integer() const;

      double to_real() const;

      const std::string & to_string() const;

    private:

      parameter_store * _parent_; 
      std::string _name_;        
      datatools::basic_type _type_; 
      std::string _description_; 
      int         _index_;       
      bool        _value_set_;   
      param_type  _value_;       

      friend class parameter_store;

    };

    struct i_subscriber {
      virtual void update_parameters() = 0;
    };

    typedef std::map<std::string, parameter_record> parameter_dict_type;

    typedef std::vector<parameter_record *> indexed_parameter_col_type;

    parameter_store();

    virtual ~parameter_store();

    void reset();

    int add(const std::string & name_,
            datatools::basic_type type_,
            const std::string & description_);

    void remove(const std::string & name_);

    bool has(const std::string & name_) const;

    const parameter_record & get(const std::string & name_) const;

    parameter_record & grab(const std::string & name_);

    bool index_is_valid(int index_) const;

    const parameter_record & get(int index_, bool do_check_ = true) const;

    parameter_record & grab(int index_, bool do_check_ = true);

    int get_parameter_index(const std::string & parameter_name_) const;

    void update();

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

    bool is_registered_subscriber(const i_subscriber & s_) const;

    void register_subscriber(i_subscriber &);

    void unregister_subscriber(i_subscriber &);

  protected:

    void _update_parameters();

  private:

    parameter_dict_type        _parameters_;         
    indexed_parameter_col_type _indexed_parameters_; 
    std::list<i_subscriber*>   _subscribers_;        

  };

} // end of namespace mygsl

#endif // MYGSL_PARAMETER_STORE_H

/* Local Variables: */
/* mode: c++        */
/* coding: utf-8    */
/* End:             */