model_factory.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-02-24
 * Last modified: 2010-02-24
 *
 * License:
 *
 * Description:
 *   Factory for geometry models
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_MODEL_FACTORY_H
#define GEOMTOOLS_MODEL_FACTORY_H 1

// Standard library:
#include <iostream>
#include <string>
#include <vector>

// Third party:
// - Bayeux/datatools:
#include <datatools/multi_properties.h>
#include <datatools/i_tree_dump.h>
#include <datatools/factory.h>
#include <datatools/logger.h>

// This project:
#include <geomtools/logical_volume.h>
#include <geomtools/i_model.h>

namespace geomtools {

  // Forward declaration:
  class shape_factory;

  class model_factory : public datatools::i_tree_dumpable
  {
  public:

    static const std::string & default_world_label();

    static bool validate_name_for_gdml(const std::string & candidate_);

    bool is_locked() const;

    datatools::logger::priority get_logging_priority() const;

    void set_logging_priority(datatools::logger::priority);

    bool is_debug() const;

    bool is_trace() const;

    void set_debug(bool);

    const datatools::multi_properties & get_mp() const;

    datatools::multi_properties & grab_mp();

    const models_col_type & get_models() const;

    const logical_volume::dict_type & get_logicals() const;

    explicit model_factory(datatools::logger::priority lp_ = datatools::logger::PRIO_FATAL);

    model_factory(bool debug_, bool core_factory_verbose_ = false);

    virtual ~model_factory();

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

    void load_geom_list(const std::string & geom_list_file_);

    void lock();

    void unlock();

    void reset();

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

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

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

    bool has_shape_factory() const;

    void set_shape_factory(shape_factory &);

    shape_factory & grab_shape_factory();

    const shape_factory & get_shape_factory() const;

    static int print_list_of_models(const geomtools::model_factory & mf_,
                                    const std::string & command_,
                                    const std::string & argv_ = "",
                                    std::ostream & out_ = std::clog);

    static int print_list_of_logicals(const geomtools::model_factory & mf_,
                                      const std::string & command_,
                                      const std::string & argv_ = "",
                                      std::ostream & out_ = std::clog);

  private:

    void _basic_construct_();

    void _lock_();

    void _unlock_();

    void _construct_();

  private:

    shape_factory *                _shape_factory_;    
    i_model::factory_register_type _factory_register_; 
    bool                        _locked_;              
    datatools::logger::priority _logging_priority_;    
    datatools::multi_properties _mp_;                  
    models_col_type             _models_;              
    logical_volume::dict_type   _logicals_;            
    std::vector<std::string>    _property_prefixes_;   

  };

} // end of namespace geomtools

/***************
 * OCD support *
 ***************/
#include <datatools/ocd_macros.h>
DOCD_CLASS_DECLARATION(geomtools::model_factory)

#endif // GEOMTOOLS_MODEL_FACTORY_H

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