primary_event.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-04-11
 * Last modified: 2015-12-04
 *
 * License:
 * Copyright 2007-2015 F. Mauger
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   Primary event from the GENBB generator.
 *
 *
 * History:
 *
 * 2012-06-21 FM :
 *  - support 'weighted' MC event in case
 *    of user energy range for DBD events
 *  - serialization version 2 supports new 'weight' attributes
 *
 */

#ifndef GENBB_HELP_PRIMARY_EVENT_H
#define GENBB_HELP_PRIMARY_EVENT_H 1

// Standard library:
#include <string>
#include <list>

// Third party:
// - Bayeux/datatools:
#include <datatools/i_serializable.h>
#include <datatools/units.h>
#include <datatools/properties.h>
#include <datatools/i_tree_dump.h>
// - Bayeux/geomtools:
#include <geomtools/utils.h>

// This project:
#include <genbb_help/primary_particle.h>

namespace genbb {

  class primary_event
    : public datatools::i_serializable,
      public datatools::i_tree_dumpable
  {

  public:

    typedef std::list<primary_particle> particles_col_type;

  public:

    bool is_valid() const;

    void reset();

    bool has_time() const;

    void set_time(double);

    double get_time() const;

    bool has_vertex() const;

    void set_vertex(const geomtools::vector_3d &);

    const geomtools::vector_3d & get_vertex() const;

    void set_genbb_weight(double genbb_weight_);

    double get_genbb_weight() const;

    bool is_genbb_weighted() const;

    const particles_col_type & get_particles() const;

    particles_col_type & grab_particles();

    void add_particle(const primary_particle &);

    primary_particle & add_particle();

    unsigned int get_number_of_particles() const;

    const primary_particle & get_particle(int) const;

    primary_particle & grab_particle(int);

    const primary_particle * get_particle_of_type(int type_, int occurence_ = 0) const;

    void remove_particle(int type_, int occurence_ = 0);

    bool has_label() const;

    const std::string & get_label() const;

    void set_label(const std::string & l_);

    void reset_label();

    bool has_classification() const;

    const std::string & get_classification() const;

    void set_classification(const std::string & c_);

    void reset_classification();

    void compute_classification();

    void rotate(double a_phi, double a_theta, double a_delta);

    double get_total_kinetic_energy() const;

    const datatools::properties & get_auxiliaries() const;

    datatools::properties & grab_auxiliaries();

    void set_auxiliaries(const datatools::properties &);

    void shift_particles_time(double delta_time_, int from_ = 0);

    primary_event();

    virtual ~primary_event();

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

    void dump(std::ostream & a_out = std::clog,
              const std::string & a_indent = "") const;

    void dump(std::ostream & a_out,
               const std::string & a_title,
               const std::string & a_indent) const;

    void assign_generation_ids();

    void remove_generation_ids();

  protected:

    void _set_defaults();

  private:

    double                _time_;           
    geomtools::vector_3d  _vertex_;         
    particles_col_type    _particles_;      
    std::string           _label_;          
    std::string           _classification_; 
    double                _genbb_weight_;   
    datatools::properties _auxiliaries_;    

    DATATOOLS_SERIALIZATION_DECLARATION_ADVANCED(primary_event)

    
    DATATOOLS_SERIALIZATION_BACKWARD_SERIAL_TAG_SUPPORT()

    
    DR_CLASS_RTTI()

  };

} // end of namespace genbb

#include <boost/serialization/export.hpp>
BOOST_CLASS_EXPORT_KEY2(genbb::primary_event, "genbb::primary_event")

DATATOOLS_SERIALIZATION_EXT_BACKWARD_SERIAL_TAG_DECLARATION(::genbb::primary_event)

// Activate reflection layer for the genbb::primary_event class :
DR_CLASS_INIT(::genbb::primary_event)

// Explicit class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(genbb::primary_event, 5)

#endif // GENBB_HELP_PRIMARY_EVENT_H

// Local Variables: --
// mode: c++ --
// End: --