Falaise  4.0.1
SuperNEMO Software Toolkit
Public Types | Public Member Functions | List of all members
snemo::datamodel::calibrated_data Class Reference

The data structure that hosts information about calibrated hits. More...

#include <falaise/snemo/datamodels/calibrated_data.h>

Inheritance diagram for snemo::datamodel::calibrated_data:
datatools::i_serializable datatools::i_tree_dumpable datatools::i_clear

Public Types

typedef datatools::handle< calibrated_tracker_hittracker_hit_handle_type
 Handle to a calibrated tracker hit. More...
 
typedef datatools::handle< calibrated_calorimeter_hitcalorimeter_hit_handle_type
 Handle to a calibrated calorimeter hit. More...
 
typedef std::vector< tracker_hit_handle_typetracker_hit_collection_type
 Collection of handles on calibrated tracker hits. More...
 
typedef std::vector< calorimeter_hit_handle_typecalorimeter_hit_collection_type
 Collection of handles on calibrated calorimeter hits. More...
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 

Public Member Functions

bool has_data () const
 Check if there are some hits. More...
 
bool has_calibrated_calorimeter_hits () const
 Check if there are some calibrated calorimeter hits. More...
 
void reset_calibrated_calorimeter_hits ()
 Reset the collection of calorimeter hits. More...
 
const calorimeter_hit_collection_typecalibrated_calorimeter_hits () const
 Return the const collection of calorimeter hits. More...
 
calorimeter_hit_collection_typecalibrated_calorimeter_hits ()
 Return the mutable collection of calorimeter hits. More...
 
bool has_calibrated_tracker_hits () const
 Check if there are some calibrated tracker hits. More...
 
void reset_calibrated_tracker_hits ()
 Reset the collection of tracker hits. More...
 
const tracker_hit_collection_typecalibrated_tracker_hits () const
 Return the const collection of tracker hits. More...
 
tracker_hit_collection_typecalibrated_tracker_hits ()
 Return the mutable collection of tracker hits. More...
 
const datatools::propertiesget_properties () const
 Return the const container of properties. More...
 
datatools::propertiesgrab_properties ()
 Return the mutable container of properties. More...
 
void reset ()
 Reset. More...
 
 calibrated_data ()
 Constructor. More...
 
virtual ~calibrated_data ()
 Destructor. More...
 
virtual void clear ()
 Clear attributes. More...
 
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
 Smart print. More...
 
- Public Member Functions inherited from datatools::i_serializable
 i_serializable ()
 
virtual ~i_serializable ()
 
virtual const std::string & get_serial_tag () 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
 
- Public Member Functions inherited from datatools::i_clear
virtual ~i_clear ()
 

Additional Inherited Members

- 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 datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 

Detailed Description

The data structure that hosts information about calibrated hits.

Member Typedef Documentation

◆ calorimeter_hit_collection_type

Collection of handles on calibrated calorimeter hits.

◆ calorimeter_hit_handle_type

Handle to a calibrated calorimeter hit.

◆ tracker_hit_collection_type

Collection of handles on calibrated tracker hits.

◆ tracker_hit_handle_type

Handle to a calibrated tracker hit.

Constructor & Destructor Documentation

◆ calibrated_data()

snemo::datamodel::calibrated_data::calibrated_data ( )

Constructor.

◆ ~calibrated_data()

virtual snemo::datamodel::calibrated_data::~calibrated_data ( )
virtual

Destructor.

Member Function Documentation

◆ calibrated_calorimeter_hits() [1/2]

const calorimeter_hit_collection_type& snemo::datamodel::calibrated_data::calibrated_calorimeter_hits ( ) const

Return the const collection of calorimeter hits.

◆ calibrated_calorimeter_hits() [2/2]

calorimeter_hit_collection_type& snemo::datamodel::calibrated_data::calibrated_calorimeter_hits ( )

Return the mutable collection of calorimeter hits.

◆ calibrated_tracker_hits() [1/2]

const tracker_hit_collection_type& snemo::datamodel::calibrated_data::calibrated_tracker_hits ( ) const

Return the const collection of tracker hits.

◆ calibrated_tracker_hits() [2/2]

tracker_hit_collection_type& snemo::datamodel::calibrated_data::calibrated_tracker_hits ( )

Return the mutable collection of tracker hits.

◆ clear()

virtual void snemo::datamodel::calibrated_data::clear ( )
virtual

Clear attributes.

Implements datatools::i_clear.

◆ get_properties()

const datatools::properties& snemo::datamodel::calibrated_data::get_properties ( ) const

Return the const container of properties.

◆ grab_properties()

datatools::properties& snemo::datamodel::calibrated_data::grab_properties ( )

Return the mutable container of properties.

◆ has_calibrated_calorimeter_hits()

bool snemo::datamodel::calibrated_data::has_calibrated_calorimeter_hits ( ) const

Check if there are some calibrated calorimeter hits.

◆ has_calibrated_tracker_hits()

bool snemo::datamodel::calibrated_data::has_calibrated_tracker_hits ( ) const

Check if there are some calibrated tracker hits.

◆ has_data()

bool snemo::datamodel::calibrated_data::has_data ( ) const

Check if there are some hits.

◆ reset()

void snemo::datamodel::calibrated_data::reset ( )

Reset.

◆ reset_calibrated_calorimeter_hits()

void snemo::datamodel::calibrated_data::reset_calibrated_calorimeter_hits ( )

Reset the collection of calorimeter hits.

◆ reset_calibrated_tracker_hits()

void snemo::datamodel::calibrated_data::reset_calibrated_tracker_hits ( )

Reset the collection of tracker hits.

◆ tree_dump()

virtual void snemo::datamodel::calibrated_data::tree_dump ( std::ostream &  a_out = std::clog,
const std::string &  a_title = "",
const std::string &  a_indent = "",
bool  a_inherit = false 
) const
virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.


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