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

Model of a calibrated calorimeter hit. More...

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

Inheritance diagram for snemo::datamodel::calibrated_calorimeter_hit:
geomtools::base_hit datatools::i_serializable datatools::i_tree_dumpable datatools::i_clear

Public Types

typedef datatools::handle< calibrated_calorimeter_hithandle_type
 Handle of calibrated calorimeter hit. More...
 
typedef std::vector< handle_typecollection_type
 Collection of handles of calibrated calorimeter hit. More...
 
- Public Types inherited from geomtools::base_hit
enum  store_mask_type
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 

Public Member Functions

double get_time () const
 Return the time associated to the hit. More...
 
void set_time (double)
 Set the time associated to the hit. More...
 
double get_sigma_time () const
 Return the error on the time associated to the hit. More...
 
void set_sigma_time (double)
 Set the error on the time associated to the hit. More...
 
double get_energy () const
 Return the energy associated to the hit. More...
 
void set_energy (double)
 Set the energy associated to the hit. More...
 
double get_sigma_energy () const
 Return the error on the energy associated to the hit. More...
 
void set_sigma_energy (double)
 Set the error on the energy associated to the hit. More...
 
 calibrated_calorimeter_hit ()
 Constructor. More...
 
virtual ~calibrated_calorimeter_hit ()
 Destructor. More...
 
bool is_valid () const
 Check if the internal data of the hit are valid. More...
 
void invalidate ()
 Invalidate the internal data of hit. 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...
 
void dump () const
 Basic print. More...
 
- Public Member Functions inherited from geomtools::base_hit
bool has_hit_id () const
 
int32_t get_hit_id () const
 
void set_hit_id (int32_t)
 
void invalidate_hit_id ()
 
bool has_geom_id () const
 
const geomtools::geom_idget_geom_id () const
 
geomtools::geom_idgrab_geom_id ()
 
void set_geom_id (const geomtools::geom_id &)
 
void invalidate_geom_id ()
 
bool has_auxiliaries () const
 
const datatools::propertiesget_auxiliaries () const
 
datatools::propertiesgrab_auxiliaries ()
 
void set_auxiliaries (const datatools::properties &)
 
void invalidate_auxiliaries ()
 
 base_hit ()
 
virtual ~base_hit ()
 
void reset ()
 
virtual void clear ()
 
base_hitmeasure (i_measurement &)
 
void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=datatools::i_tree_dumpable::empty_options()) const override
 
void dump () const
 
- 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 ()
 
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 geomtools::base_hit
 STORE_NOTHING
 
 STORE_HIT_ID
 
 STORE_GEOM_ID
 
 STORE_AUXILIARIES
 
 STORE_RESERVED30
 
 STORE_RESERVED31
 
- Public Attributes inherited from datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 
- Static Public Attributes inherited from geomtools::base_hit
static const int32_t INVALID_HIT_ID
 
- Protected Member Functions inherited from geomtools::base_hit
void _store_set (uint32_t bit_mask_)
 
void _store_unset (uint32_t bit_mask_)
 
bool _store_check (uint32_t bit_mask_) const
 
- Protected Attributes inherited from geomtools::base_hit
uint32_t _store
 

Detailed Description

Model of a calibrated calorimeter hit.

Member Typedef Documentation

◆ collection_type

Collection of handles of calibrated calorimeter hit.

◆ handle_type

Handle of calibrated calorimeter hit.

Constructor & Destructor Documentation

◆ calibrated_calorimeter_hit()

snemo::datamodel::calibrated_calorimeter_hit::calibrated_calorimeter_hit ( )

Constructor.

◆ ~calibrated_calorimeter_hit()

virtual snemo::datamodel::calibrated_calorimeter_hit::~calibrated_calorimeter_hit ( )
virtual

Destructor.

Member Function Documentation

◆ dump()

void snemo::datamodel::calibrated_calorimeter_hit::dump ( ) const

Basic print.

◆ get_energy()

double snemo::datamodel::calibrated_calorimeter_hit::get_energy ( ) const

Return the energy associated to the hit.

◆ get_sigma_energy()

double snemo::datamodel::calibrated_calorimeter_hit::get_sigma_energy ( ) const

Return the error on the energy associated to the hit.

◆ get_sigma_time()

double snemo::datamodel::calibrated_calorimeter_hit::get_sigma_time ( ) const

Return the error on the time associated to the hit.

◆ get_time()

double snemo::datamodel::calibrated_calorimeter_hit::get_time ( ) const

Return the time associated to the hit.

◆ invalidate()

void snemo::datamodel::calibrated_calorimeter_hit::invalidate ( )
virtual

Invalidate the internal data of hit.

Reimplemented from geomtools::base_hit.

◆ is_valid()

bool snemo::datamodel::calibrated_calorimeter_hit::is_valid ( ) const
virtual

Check if the internal data of the hit are valid.

Reimplemented from geomtools::base_hit.

◆ set_energy()

void snemo::datamodel::calibrated_calorimeter_hit::set_energy ( double  )

Set the energy associated to the hit.

◆ set_sigma_energy()

void snemo::datamodel::calibrated_calorimeter_hit::set_sigma_energy ( double  )

Set the error on the energy associated to the hit.

◆ set_sigma_time()

void snemo::datamodel::calibrated_calorimeter_hit::set_sigma_time ( double  )

Set the error on the time associated to the hit.

◆ set_time()

void snemo::datamodel::calibrated_calorimeter_hit::set_time ( double  )

Set the time associated to the hit.

◆ tree_dump()

virtual void snemo::datamodel::calibrated_calorimeter_hit::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 geomtools::base_hit.


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