Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
genbb::i_lorentz_boost_generator Class Referenceabstract

Abstract mother class to fetch Lorentz Boost data. More...

#include <bayeux/genbb_help/lorentz_boost_wrapper.h>

Public Member Functions

 i_lorentz_boost_generator ()
 Default constructor. More...
 
virtual ~i_lorentz_boost_generator ()
 Destructor. More...
 
virtual bool has_next ()=0
 Check if the generator can provide more Lorentz Boost information. More...
 
virtual void add_metadata (primary_event &pe_)
 Add metadata. More...
 
virtual bool is_initialized () const =0
 Check initialization status. More...
 
virtual void initialize (const datatools::properties &)=0
 Main initialization. More...
 
virtual void reset ()=0
 Reset. More...
 
void initialize_simple ()
 Simple initialization. More...
 
void generate (geomtools::vector_3d &speed_, geomtools::vector_3d &vtx_)
 Generate Lorentz Boost information. More...
 
void generate (geomtools::vector_3d &speed_, geomtools::vector_3d &vtx_, double &time_)
 Generate Lorentz Boost information. More...
 

Static Public Member Functions

static i_lorentz_boost_generatorcreate (const std::string &class_id_, const datatools::properties &config_)
 Factory method. More...
 

Protected Member Functions

virtual void _generate (geomtools::vector_3d &speed_, geomtools::vector_3d &vtx_, double &time_)=0
 Generate Lorentz Boost information. More...
 

Detailed Description

Abstract mother class to fetch Lorentz Boost data.

Constructor & Destructor Documentation

◆ i_lorentz_boost_generator()

genbb::i_lorentz_boost_generator::i_lorentz_boost_generator ( )

Default constructor.

◆ ~i_lorentz_boost_generator()

virtual genbb::i_lorentz_boost_generator::~i_lorentz_boost_generator ( )
virtual

Destructor.

Member Function Documentation

◆ _generate()

virtual void genbb::i_lorentz_boost_generator::_generate ( geomtools::vector_3d speed_,
geomtools::vector_3d vtx_,
double &  time_ 
)
protectedpure virtual

Generate Lorentz Boost information.

◆ add_metadata()

virtual void genbb::i_lorentz_boost_generator::add_metadata ( primary_event pe_)
virtual

Add metadata.

◆ create()

static i_lorentz_boost_generator* genbb::i_lorentz_boost_generator::create ( const std::string &  class_id_,
const datatools::properties config_ 
)
static

Factory method.

◆ generate() [1/2]

void genbb::i_lorentz_boost_generator::generate ( geomtools::vector_3d speed_,
geomtools::vector_3d vtx_ 
)

Generate Lorentz Boost information.

◆ generate() [2/2]

void genbb::i_lorentz_boost_generator::generate ( geomtools::vector_3d speed_,
geomtools::vector_3d vtx_,
double &  time_ 
)

Generate Lorentz Boost information.

◆ has_next()

virtual bool genbb::i_lorentz_boost_generator::has_next ( )
pure virtual

Check if the generator can provide more Lorentz Boost information.

◆ initialize()

virtual void genbb::i_lorentz_boost_generator::initialize ( const datatools::properties )
pure virtual

Main initialization.

◆ initialize_simple()

void genbb::i_lorentz_boost_generator::initialize_simple ( )

Simple initialization.

◆ is_initialized()

virtual bool genbb::i_lorentz_boost_generator::is_initialized ( ) const
pure virtual

Check initialization status.

◆ reset()

virtual void genbb::i_lorentz_boost_generator::reset ( )
pure virtual

Reset.


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