i_model.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-02-20
 * Last modified: 2015-07-07
 *
 * License:
 *
 * Description:
 *
 *   Interface/base class for all geometry models
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_I_MODEL_H
#define GEOMTOOLS_I_MODEL_H 1

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

// Third party:
// - Boost
#include <boost/scoped_ptr.hpp>

// Bayeux:
#include <datatools/i_tree_dump.h>
#include <datatools/properties.h>
#include <datatools/logger.h>
#include <datatools/factory_macros.h>
#include <datatools/ocd_macros.h>

// This library:
#include <geomtools/logical_volume.h>
#include <geomtools/detail/model_tools.h>
#include <geomtools/model_with_internal_mesh_tools.h>

namespace geomtools {

  // Forward declaration:
  class shape_factory;

  class i_model
    : public datatools::i_tree_dumpable
  {
  public:

    // Constants parameters used by geometry models:
    static const std::string & solid_suffix();
    static const std::string & logical_suffix();
    static const std::string & physical_suffix();
    static const std::string & phantom_solid_flag();
    static const std::string & exported_properties_prefixes_key();

    typedef geomtools::models_col_type models_col_type;

    model_with_internal_mesh_data & grab_meshes();

    const model_with_internal_mesh_data & get_meshes() const;

    bool is_constructed() const;

    bool is_phantom_solid() const;

    bool has_name() const;

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

    const std::string & get_name() const;

    const datatools::properties & parameters() const;

    datatools::properties & parameters();

    i_model(const std::string & dummy_ = "");

    virtual ~i_model();

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

    const geomtools::logical_volume & get_logical() const;

    geomtools::logical_volume & grab_logical();

    virtual void construct(const std::string & name_,
                           const datatools::properties & setup_,
                           models_col_type * models_ = 0);

    virtual void construct(const std::string & name_,
                           const datatools::properties & setup_,
                           const std::vector<std::string> & properties_prefixes_,
                           models_col_type * models_);

    virtual std::string get_model_id() const = 0;

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

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

    bool is_debug() const;

    void set_debug(bool);

    static void init_ocd(datatools::object_configuration_description & ocd_);

    bool has_shape_factory() const;

    void set_shape_factory(shape_factory &);

    shape_factory & grab_shape_factory();

    const shape_factory & get_shape_factory() const;

  protected:

    void _set_phantom_solid(bool);

    void _mandatory_pre_construct(datatools::properties & setup_, models_col_type * models_);

    virtual void _pre_construct(datatools::properties & setup_, models_col_type * models_);

    virtual void _at_construct(const std::string & name_,
                               const datatools::properties & setup_,
                               models_col_type * models_ = 0) = 0;

    virtual void _post_construct(datatools::properties & setup_, models_col_type * models_);

    void _mandatory_post_construct(datatools::properties & setup_, models_col_type * models_);

  protected:

    datatools::logger::priority _logging_priority; 
    bool                        _phantom_solid;    
    geomtools::logical_volume   _logical;          

  private:

    bool                  _constructed_; 
    datatools::properties _parameters_;  
    std::string           _name_;        
    model_with_internal_mesh_data _meshes_; 

    // Work:
    shape_factory *       _shape_factory_; 


  public:

    static std::string make_solid_name(const std::string & basename_);

    static std::string make_logical_volume_name(const std::string & basename_);

    static std::string make_physical_volume_name(const std::string & basename_);

    static std::string make_physical_volume_name_per_item(const std::string & basename_,
                                                          int i_);

    static std::string make_physical_volume_name_per_item(const std::string & basename_,
                                                          int i_, int j_);

    static std::string make_physical_volume_name(const std::string & basename_,
                                                 int nitems_);

    static std::string make_physical_volume_name(const std::string & basename_,
                                                 int ncols_,
                                                 int nrows_);

    static std::string extract_label_from_physical_volume_name(const std::string & physical_volume_name_);

    // Factory stuff :
    DATATOOLS_FACTORY_SYSTEM_REGISTER_INTERFACE(i_model)

  }; // class i_model

} // end of namespace geomtools

#include <geomtools/model_macros.h>

#endif // GEOMTOOLS_I_MODEL_H

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