event_id.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2008-02-15
 * Last modified: 2013-03-22
 *
 * Description:
 *  A generic event id with run number and event number
 *
 */

#ifndef DATATOOLS_EVENT_ID_H
#define DATATOOLS_EVENT_ID_H

// Standard Library:
#include <string>
#include <sstream>
#include <iostream>
#include <stdexcept>

// Third Party:
// - Boost:
#include <boost/cstdint.hpp>

// Datatools:
#include <datatools/i_serializable.h>
#include <datatools/i_tree_dump.h>
#include <datatools/i_clear.h>
#ifndef Q_MOC_RUN
#include <datatools/reflection_interface.h>
#endif // Q_MOC_RUN

namespace datatools {

  class event_id
    : public datatools::i_serializable
    , public datatools::i_tree_dumpable
    , public datatools::i_clear
  {
  public:
    static const int INVALID_RUN_NUMBER = -1;
    static const int ANY_RUN_NUMBER = -2;

    static const int INVALID_EVENT_NUMBER = -1;
    static const int ANY_EVENT_NUMBER = -2;

    static const char IO_FORMAT_SEP = '_';
    static const char IO_FORMAT_ANY = '*';
    static const char IO_FORMAT_INVALID = '!';


    event_id();

    explicit event_id(int e_);


    event_id(int r_, int e_);

    virtual ~event_id();

    virtual void clear();

    void reset();


    int get_run_number() const;


    int get_event_number() const;


    void set_run_number(int r_);


    void set_event_number(int e_);


    void set(int r_, int e_);

    bool is_valid() const;

    bool is_complete() const;


    bool has(int r_, int e_) const;


    bool match(int r_, int e_) const;

    bool operator==(const event_id & id_) const;

    bool operator<(const event_id & id_) const;

    bool operator>(const event_id & id_) const;

    std::string to_string() const;

    void from_string(const std::string & s_);

    friend std::ostream & operator<<(std::ostream & s_, const event_id & id_);

    friend std::istream & operator>>(std::istream & s_, event_id & id_);


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

    void smart_print(std::ostream & out_,
                     const std::string & title_,
                     const std::string & indent_) const;

    std::string to_smart_string(const std::string & title_,
                                const std::string & indent_) const;

    void dump() const;

  private:

    int32_t _run_number_;   
    int32_t _event_number_; 

    DATATOOLS_SERIALIZATION_DECLARATION_ADVANCED(event_id)

    
    DATATOOLS_SERIALIZATION_BACKWARD_SERIAL_TAG_SUPPORT()

    DR_CLASS_RTTI()

  };



  class event_id_equal_predicate
    : public std::unary_function<event_id, bool>
  {
  public:


    event_id_equal_predicate(const event_id & id_)
      : _id_(id_)
    {
      return;
    }


    bool operator() (const event_id & id_) const
    {
      return _id_ == id_;
    }

  private:

    event_id _id_; 

  };

} // end of namespace datatools

DATATOOLS_SERIALIZATION_EXT_BACKWARD_SERIAL_TAG_DECLARATION(::datatools::event_id)

#ifndef Q_MOC_RUN
// Activate reflection layer for the 'datatools::event_id' class:
DR_CLASS_INIT(::datatools::event_id)
#endif // Q_MOC_RUN

// Explicit class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(datatools::event_id, 1)

#endif // DATATOOLS_EVENT_ID_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --