variant_registry_manager.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2014-05-11
 * Last modified : 2014-10-27
 *
 * 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 configuration variant registry manager/factory.
 *
 */

#ifndef DATATOOLS_CONFIGURATION_VARIANT_REGISTRY_MANAGER_H
#define DATATOOLS_CONFIGURATION_VARIANT_REGISTRY_MANAGER_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/multi_properties.h>
#include <datatools/configuration/utils.h>
#include <datatools/logger.h>
#include <datatools/object_configuration_description.h>

namespace datatools {

  namespace configuration {

    class variant_registry_manager : public datatools::enriched_base
    {
    public:

      variant_registry_manager();

      virtual ~variant_registry_manager();

      bool is_initialized() const;

      void initialize(const properties & config_);

      void initialize_simple();

      void reset();

      void set_top_variant_name(const std::string &);

      const std::string & get_top_variant_name() const;

      void add_property_prefix(const std::string & prefix_);

      const std::set<std::string> & get_property_prefixes() const;

      void load_configuration_items_list(const std::string & item_list_file_);

      void load(const std::string & items_config_file_);

      const model_item_dict_type & get_configuration_items() const;

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

      static void init_ocd(datatools::object_configuration_description &);

    protected:

      void _set_default();

    private:

      void _construct_();

    private:

      bool                   _initialized_;         
      multi_properties       _mp_;                  
      std::set<std::string>  _property_prefixes_;   
      std::string            _top_variant_name_;    
      model_item_dict_type   _configuration_items_; 

    };

  }  // end of namespace configuration

}  // end of namespace datatools

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

DOCD_CLASS_DECLARATION(datatools::configuration::variant_registry_manager)

#endif // DATATOOLS_CONFIGURATION_VARIANT_REGISTRY_MANAGER_H

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