Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mctools::fluence_step_hit_processor Class Reference

#include <bayeux/mctools/fluence_step_hit_processor.h>

Inheritance diagram for mctools::fluence_step_hit_processor:
mctools::base_step_hit_processor datatools::i_tree_dumpable

Public Member Functions

virtual bool locate_fluence_volume (const geomtools::vector_3d &position_, geomtools::geom_id &gid_) const
 Find the Gid of the fluence volume at a given position. More...
 
const std::string & get_mapping_category () const
 Return the geometry mapping category. More...
 
void set_mapping_category (const std::string &sc_)
 Set the geometry mapping category. More...
 
const std::vector< int > & get_mapping_category_any_addresses () const
 
 fluence_step_hit_processor ()
 Constructor. More...
 
virtual ~fluence_step_hit_processor ()
 Destructor. More...
 
virtual void initialize (const ::datatools::properties &config_, ::datatools::service_manager &service_mgr_)
 Main setup routine. More...
 
virtual void process (const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type &base_step_hits_, ::mctools::simulated_data::hit_handle_collection_type &handle_hits_)
 Main processing routine : More...
 
virtual void process (const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type &base_step_hits_, ::mctools::simulated_data::hit_collection_type &plain_hits_)
 Main processing routine : More...
 
void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. More...
 
- Public Member Functions inherited from mctools::base_step_hit_processor
bool is_debug () const
 Check the debug flag. More...
 
void set_debug (bool)
 Set the debug flag. More...
 
void set_pool (pool_type &)
 Set the pool of hits. More...
 
bool has_pool () const
 Check for a pool of hits. More...
 
pool_typeget_pool () const
 Return a reference to a mutable pool of hits. More...
 
bool using_private_pool () const
 
void setup_private_pool (size_t capacity_=DEFAULT_POOL_CAPACITY)
 
void add_new_hit (simulated_data::hit_handle_collection_type &hits_)
 
const std::string & get_name () const
 
void set_name (const std::string &)
 
 base_step_hit_processor ()
 Default constructor. More...
 
virtual ~base_step_hit_processor ()
 Destructor. More...
 
const std::string & get_hit_category () const
 
void set_hit_category (const std::string &hc_)
 
const std::string & get_sensitive_category () const
 
void set_sensitive_category (const std::string &sc_)
 
bool has_geom_manager () const
 
void set_geom_manager (const geomtools::manager &gmgr_)
 
const geomtools::managerget_geom_manager () const
 
const datatools::propertiesget_auxiliaries () const
 
datatools::propertiesgrab_auxiliaries ()
 
virtual bool accept_external_rng () const
 
virtual void set_external_rng (mygsl::rng &rng_)
 
void initialize (const datatools::properties &config_)
 Initialization from a set of configuration properties. More...
 
virtual void initialize (const datatools::properties &config_, datatools::service_manager &service_mgr_)
 Main setup routine: More...
 
void process (const step_hit_ptr_collection_type &base_step_hits_, simulated_data &sim_data_)
 
virtual void process (const step_hit_ptr_collection_type &base_step_hits_, simulated_data::hit_handle_collection_type &hits_)=0
 
virtual void process (const step_hit_ptr_collection_type &base_step_hit_s, simulated_data::hit_collection_type &plain_hits_)
 
datatools::logger::priority get_logging_priority () const
 Return the logging priority threshold. More...
 
void set_logging_priority (datatools::logger::priority)
 Set the logging priority threshold. More...
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 Constructor. More...
 
virtual ~i_tree_dumpable ()
 Destructor. More...
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 Main new interface method for printing. More...
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 Printing with jsonized options. More...
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 Printing with jsonized options. More...
 
void tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
 
void tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
 
void smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const
 

Static Public Member Functions

static void init_ocd (datatools::object_configuration_description &)
 OCD support. More...
 
- Static Public Member Functions inherited from mctools::base_step_hit_processor
static void init_ocd (datatools::object_configuration_description &)
 OCD support. More...
 
- Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree & empty_options ()
 
static boost::property_tree::ptree make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
 
static std::ostream & last_skip_tag (std::ostream &out_)
 
static std::ostream & skip_tag (std::ostream &out_)
 
static std::ostream & last_tag (std::ostream &out_)
 
static std::ostream & tag (std::ostream &out_)
 

Protected Member Functions

void _init (const ::datatools::properties &config_, ::datatools::service_manager &service_mgr_)
 
void _process (const base_step_hit_processor::step_hit_ptr_collection_type &base_step_hits_, simulated_data::hit_handle_collection_type *fluence_hits_, simulated_data::hit_collection_type *plain_fluence_hits_)
 Main non-public algorithm. More...
 
- Protected Member Functions inherited from mctools::base_step_hit_processor
void _initialize (const datatools::properties &config_, datatools::service_manager &service_mgr_)
 

Additional Inherited Members

- Public Types inherited from mctools::base_step_hit_processor
typedef std::vector< base_step_hit * > step_hit_ptr_collection_type
 
typedef datatools::handle_pool< base_step_hitpool_type
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
 Enumeration for standard output streams. More...
 
- Static Public Attributes inherited from mctools::base_step_hit_processor
static const size_t DEFAULT_POOL_CAPACITY = 100
 
- Protected Attributes inherited from mctools::base_step_hit_processor
datatools::logger::priority _logging_priority
 Logging priority threshold. More...
 
std::string _name
 Name of the step hit processor. More...
 
std::string _hit_category
 
std::string _sensitive_category
 
const geomtools::manager_geom_manager = nullptr
 The geometry manager. More...
 
datatools::properties _auxiliaries
 Some auxiliary properties. More...
 
pool_type_private_pool = nullptr
 A private embedded pool of hits. More...
 
bool _pool_owner
 Pool of hits ownership flag. More...
 
pool_type_pool = nullptr
 Reference to an external pool of hits. More...
 

Constructor & Destructor Documentation

◆ fluence_step_hit_processor()

mctools::fluence_step_hit_processor::fluence_step_hit_processor ( )

Constructor.

◆ ~fluence_step_hit_processor()

virtual mctools::fluence_step_hit_processor::~fluence_step_hit_processor ( )
virtual

Destructor.

Member Function Documentation

◆ _init()

void mctools::fluence_step_hit_processor::_init ( const ::datatools::properties config_,
::datatools::service_manager service_mgr_ 
)
protected

◆ _process()

void mctools::fluence_step_hit_processor::_process ( const base_step_hit_processor::step_hit_ptr_collection_type base_step_hits_,
simulated_data::hit_handle_collection_type fluence_hits_,
simulated_data::hit_collection_type plain_fluence_hits_ 
)
protected

Main non-public algorithm.

◆ get_mapping_category()

const std::string& mctools::fluence_step_hit_processor::get_mapping_category ( ) const

Return the geometry mapping category.

◆ get_mapping_category_any_addresses()

const std::vector<int>& mctools::fluence_step_hit_processor::get_mapping_category_any_addresses ( ) const

◆ init_ocd()

static void mctools::fluence_step_hit_processor::init_ocd ( datatools::object_configuration_description )
static

OCD support.

◆ initialize()

virtual void mctools::fluence_step_hit_processor::initialize ( const ::datatools::properties config_,
::datatools::service_manager service_mgr_ 
)
virtual

Main setup routine.

◆ locate_fluence_volume()

virtual bool mctools::fluence_step_hit_processor::locate_fluence_volume ( const geomtools::vector_3d position_,
geomtools::geom_id gid_ 
) const
virtual

Find the Gid of the fluence volume at a given position.

◆ process() [1/2]

virtual void mctools::fluence_step_hit_processor::process ( const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type base_step_hits_,
::mctools::simulated_data::hit_handle_collection_type handle_hits_ 
)
virtual

Main processing routine :

◆ process() [2/2]

virtual void mctools::fluence_step_hit_processor::process ( const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type base_step_hits_,
::mctools::simulated_data::hit_collection_type plain_hits_ 
)
virtual

Main processing routine :

◆ set_mapping_category()

void mctools::fluence_step_hit_processor::set_mapping_category ( const std::string &  sc_)

Set the geometry mapping category.

◆ tree_dump()

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

Smart print.

Reimplemented from mctools::base_step_hit_processor.


The documentation for this class was generated from the following file: