Falaise  4.0.1
SuperNEMO Software Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
snemo::cut::simulated_data_cut Class Reference

#include <falaise/snemo/cuts/simulated_data_cut.h>

Inheritance diagram for snemo::cut::simulated_data_cut:
cuts::i_cut datatools::i_tree_dumpable

Public Types

enum  mode_type {
  MODE_UNDEFINED = 0, MODE_FLAG = datatools::bit_mask::bit00, MODE_HAS_HIT_CATEGORY = datatools::bit_mask::bit01, MODE_RANGE_HIT_CATEGORY,
  MODE_HAS_HIT_PROPERTY = datatools::bit_mask::bit03
}
 The cut mode. More...
 
- Public Types inherited from cuts::i_cut
enum  export_config_flags
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 

Public Member Functions

void set_SD_label (const std::string &SD_label_)
 Set the SD bank key. More...
 
const std::string & get_SD_label () const
 Return the SD bank key. More...
 
uint32_t get_mode () const
 Return the cut mode. More...
 
bool is_mode_flag () const
 Check mode MODE_FLAG: More...
 
bool is_mode_has_hit_category () const
 Check mode MODE_HAS_HIT_CATEGORY: More...
 
bool is_mode_range_hit_category () const
 Check mode MODE_RANGE_HIT_CATEGORY: More...
 
bool is_mode_has_hit_property () const
 Check mode MODE_HAS_HIT_PROPERTY: More...
 
void set_flag_name (const std::string &flag_name_)
 Set the name of cut mode MODE_FLAG. More...
 
const std::string & get_flag_name () const
 Return the name of cut mode MODE_FLAG. More...
 
 simulated_data_cut (datatools::logger::priority logging_priority_=datatools::logger::PRIO_FATAL)
 Constructor. More...
 
virtual ~simulated_data_cut ()
 Destructor. More...
 
virtual void initialize (const datatools::properties &configuration_, datatools::service_manager &service_manager_, cuts::cut_handle_dict_type &cut_dict_)
 Initilization. More...
 
virtual void reset ()
 Reset. More...
 
- Public Member Functions inherited from cuts::i_cut
bool is_debug () const
 
bool has_name () const
 
void set_name (const std::string &a_name)
 
const std::string & get_name () const
 
bool has_description () const
 
const std::string & get_description () const
 
void set_description (const std::string &a_description)
 
bool has_version () const
 
const std::string & get_version () const
 
void set_version (const std::string &a_version)
 
bool is_initialized () const
 
bool has_user_data () const
 
void set_user_data (const T &obj_)
 
bool is_user_data () const
 
const T & get_user_data () const
 
void register_supported_user_data_type ()
 
void unregister_supported_user_data_type ()
 
bool is_user_data_type_supported () const
 
bool is_user_data_type_supported (const std::type_info &tinfo_) const
 
void reset_user_data ()
 
virtual void initialize_simple ()
 
virtual void initialize_standalone (const datatools::properties &a_config)
 
virtual void initialize_with_service_only (const datatools::properties &a_config, datatools::service_manager &a_service_manager)
 
virtual void initialize_without_service (const datatools::properties &a_config, cut_handle_dict_type &a_cut_dictionary)
 
virtual void export_to_config (datatools::properties &config_, uint32_t flags_=EXPORT_CONFIG_DEFAULT, const std::string &prefix_="") const
 
virtual int process ()
 
int operator() ()
 
 i_cut (datatools::logger::priority p=datatools::logger::PRIO_FATAL)
 
virtual ~i_cut ()
 
virtual void tree_dump (std::ostream &a_out=std::clog, const std::string &a_title="", const std::string &a_indent="", bool a_inherit=false) const
 
void print (std::ostream &a_out=std::clog) const
 
void set_logging_priority (datatools::logger::priority p)
 
datatools::logger::priority get_logging_priority () const
 
size_t get_number_of_accepted_entries () const
 
size_t get_number_of_rejected_entries () const
 
size_t get_number_of_processed_entries () const
 
void reset_counters ()
 
bool is_activated_counters () const
 
void set_activated_counters (bool)
 
virtual std::string get_type_id () const=0
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 
virtual ~i_tree_dumpable ()
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 
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
 

Protected Member Functions

void _set_defaults ()
 Default values. More...
 
virtual int _accept ()
 Selection. More...
 
- Protected Member Functions inherited from cuts::i_cut
void _set_user_data (const boost::shared_ptr< i_referenced_data > &hd_)
 
void _common_initialize (const datatools::properties &a_config)
 
void _import_user_data_from (const i_cut &)
 
void _export_user_data_to (i_cut &) const
 
void _set_name (const std::string &a_name)
 
void _set_initialized (bool a_initialized)
 
virtual void _prepare_cut ()
 
virtual int _finish_cut (int a_selection_status)
 
virtual void _increment_counters (int a_selection_status)
 
virtual void _at_set_user_data ()
 
virtual void _at_reset_user_data ()
 
void _reset ()
 
void _set_defaults ()
 

Additional Inherited Members

- Static Public Member Functions inherited from cuts::i_cut
static void common_ocd (datatools::object_configuration_description &ocd_)
 
- 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_)
 
- Public Attributes inherited from cuts::i_cut
 EXPORT_CONFIG_CLEAR
 
 EXPORT_CONFIG_NAME
 
 EXPORT_CONFIG_DESCRIPTION
 
 EXPORT_CONFIG_VERSION
 
 EXPORT_CONFIG_LOGGING_PRIORITY
 
 EXPORT_CONFIG_DEFAULT
 
 EXPORT_CONFIG_LAST
 
- Public Attributes inherited from datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 
- Protected Attributes inherited from cuts::i_cut
datatools::logger::priority _logging
 
std::string _name
 
std::string _description
 
std::string _version
 
std::set< const std::type_info * > _supported_types_
 

Member Enumeration Documentation

◆ mode_type

The cut mode.

Enumerator
MODE_UNDEFINED 
MODE_FLAG 
MODE_HAS_HIT_CATEGORY 
MODE_RANGE_HIT_CATEGORY 
MODE_HAS_HIT_PROPERTY 

Constructor & Destructor Documentation

◆ simulated_data_cut()

snemo::cut::simulated_data_cut::simulated_data_cut ( datatools::logger::priority  logging_priority_ = datatools::logger::PRIO_FATAL)

Constructor.

◆ ~simulated_data_cut()

virtual snemo::cut::simulated_data_cut::~simulated_data_cut ( )
virtual

Destructor.

Member Function Documentation

◆ _accept()

virtual int snemo::cut::simulated_data_cut::_accept ( )
protectedvirtual

Selection.

Implements cuts::i_cut.

◆ _set_defaults()

void snemo::cut::simulated_data_cut::_set_defaults ( )
protected

Default values.

◆ get_flag_name()

const std::string& snemo::cut::simulated_data_cut::get_flag_name ( ) const

Return the name of cut mode MODE_FLAG.

◆ get_mode()

uint32_t snemo::cut::simulated_data_cut::get_mode ( ) const

Return the cut mode.

◆ get_SD_label()

const std::string& snemo::cut::simulated_data_cut::get_SD_label ( ) const

Return the SD bank key.

◆ initialize()

virtual void snemo::cut::simulated_data_cut::initialize ( const datatools::properties configuration_,
datatools::service_manager service_manager_,
cuts::cut_handle_dict_type cut_dict_ 
)
virtual

Initilization.

Implements cuts::i_cut.

◆ is_mode_flag()

bool snemo::cut::simulated_data_cut::is_mode_flag ( ) const

Check mode MODE_FLAG:

◆ is_mode_has_hit_category()

bool snemo::cut::simulated_data_cut::is_mode_has_hit_category ( ) const

Check mode MODE_HAS_HIT_CATEGORY:

◆ is_mode_has_hit_property()

bool snemo::cut::simulated_data_cut::is_mode_has_hit_property ( ) const

Check mode MODE_HAS_HIT_PROPERTY:

◆ is_mode_range_hit_category()

bool snemo::cut::simulated_data_cut::is_mode_range_hit_category ( ) const

Check mode MODE_RANGE_HIT_CATEGORY:

◆ reset()

virtual void snemo::cut::simulated_data_cut::reset ( )
virtual

Reset.

Implements cuts::i_cut.

◆ set_flag_name()

void snemo::cut::simulated_data_cut::set_flag_name ( const std::string &  flag_name_)

Set the name of cut mode MODE_FLAG.

◆ set_SD_label()

void snemo::cut::simulated_data_cut::set_SD_label ( const std::string &  SD_label_)

Set the SD bank key.


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