variant_model.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2014-05-11
 * Last modified : 2014-08-10
 *
 * Copyright (C) 2014 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   The description of a configuration variant.
 *
 */

#ifndef DATATOOLS_CONFIGURATION_VARIANT_MODEL_H
#define DATATOOLS_CONFIGURATION_VARIANT_MODEL_H

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

// This project (Bayeux/datatools):
#include <datatools/i_tree_dump.h>
#include <datatools/enriched_base.h>
#include <datatools/handle.h>
#include <datatools/types.h>
#include <datatools/configuration/utils.h>
#include <datatools/object_configuration_description.h>
#include <datatools/configuration/parameter_physical.h>

namespace datatools {

  // Forward declaration:
  class multi_properties;

  namespace configuration {

    // Forward declaration:
    class parameter_model;
    class parameter_physical;

    class variant_model
      : public datatools::enriched_base
    {
    public:

      virtual bool is_name_valid(const std::string & name_) const;

      struct parameter_record {
        parameter_physical physical;
        std::string        description;
        // Overriden default value(s) with respect to the parameter model ?
        int                rank = -1;
      };

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

      variant_model();

      virtual ~variant_model();

      bool has_documentation() const;

      void set_documentation(const std::string & documentation_);

      const std::string & get_documentation() const;

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

      void add_parameter(const std::string &    parameter_name_,
                         const pm_handle_type & parameter_model_handle_,
                         const std::string &    description_ = "",
                         const std::string &    occurence_def_ = "",
                         int rank_ = -1);

      void remove_parameter(const std::string & parameter_name_);

      bool is_rank_used(int rank_) const;

      bool is_ranked_parameter(const std::string & parameter_name_) const;

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

      void set_parameter_rank(const std::string & parameter_name_, int rank_);

      void build_list_of_ranked_parameters(std::vector<std::string> &) const;

      const std::string & get_parameter_description(const std::string & parameter_name_) const;

      const parameter_model & get_parameter_model(const std::string & parameter_name_) const;

      pm_handle_type get_parameter_model_handle(const std::string & parameter_name_) const;

      bool has_parameter_occurrence(const std::string & parameter_name_) const;

      const i_occurrence & get_parameter_occurrence(const std::string & parameter_name_) const;

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

      enum rst_flags {
        PRINT_RST_NO_TITLE = datatools::bit_mask::bit00
      };

      void print_rst(std::ostream & out_,
                     const std::string & indent_ = "",
                     uint32_t flags_ = 0) const;

      bool is_initialized() const;

      void initialize(const properties & config_, model_item_dict_type & items_);

      void initialize_standalone(const properties & config_);

      void initialize_simple();

      void reset();

      const parameter_dict_type & get_parameters() const;

      static void init_ocd(datatools::object_configuration_description &);

    protected:

      void _set_default();

    private:

      bool                _initialized_;   
      std::string         _documentation_; 
      parameter_dict_type _parameters_;    

    };

  }  // end of namespace configuration

}  // end of namespace datatools

// OCD support:
#include <datatools/ocd_macros.h>

DOCD_CLASS_DECLARATION(datatools::configuration::variant_model)

#endif // DATATOOLS_CONFIGURATION_VARIANT_MODEL_H

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