JDAQEvent.hh

Go to the documentation of this file.

#ifndef __JDAQEVENT__
#define __JDAQEVENT__

#include <ostream>
#include <iomanip>
#include <vector>

#include "JDAQ/JDAQRoot.hh"
#include "JDAQ/JDAQPreamble.hh"
#include "JDAQ/JDAQEventHeader.hh"
#include "JDAQ/JDAQHit.hh"
#include "JDAQ/JDAQKeyHit.hh"
#include "JDAQ/JDAQTriggeredHit.hh"
#include "JDAQ/JDAQPrint.hh"
#include "JIO/JSTDIO.hh"


/**
 * \author mdejong
 */

namespace KM3NETDAQ {

  using JIO::JReader;
  using JIO::JWriter;


  typedef  JDAQKeyHit             JDAQSnapshotHit;


  /**
   * DAQ Event.
   */
  class JDAQEvent :
    public JDAQPreamble,
    public JDAQEventHeader
  {
  public:

    using JDAQTriggerMask::getTriggerMask;


    /**
     * Default constructor.
     */
    JDAQEvent() :
      JDAQPreamble(JDAQType<JDAQEvent>()),
      JDAQEventHeader()
    {}


    /**
     * Constructor.
     *
     * \param  chronometer    DAQ chronometer
     * \param  mask           trigger mask
     */
    JDAQEvent(const JDAQChronometer& chronometer,
              const JDAQTriggerMask& mask = JDAQTriggerMask()) :
      JDAQPreamble(JDAQType<JDAQEvent>()),
      JDAQEventHeader(chronometer, mask)
    {}


    /**
     * Template const_iterator
     */
    template<class T> 
    class const_iterator : 
      public std::vector<T>::const_iterator
    {
    public:
      /**
       * Default constructor.
       */
      const_iterator() :
        std::vector<T>::const_iterator()
      {}

      
      /**
       * Copy constructor.
       *
       * \param  i              iterator
       */
      const_iterator(const typename std::vector<T>::const_iterator& i) :
        std::vector<T>::const_iterator(i)
      {}
    };


    /**
     * Template const_reverse_iterator
     */
    template<class T> 
    class const_reverse_iterator : 
      public std::vector<T>::const_reverse_iterator
    {
    public:
      /**
       * Default constructor.
       */
      const_reverse_iterator() :
        std::vector<T>::const_reverse_iterator()
      {}
      

      /**
       * Copy constructor.
       *
       * \param  i              iterator
       */
      const_reverse_iterator(const typename std::vector<T>::const_reverse_iterator& i) :
        std::vector<T>::const_reverse_iterator(i)
      {}
    };


    /**
     * Get container with hits.
     *
     * \return                container with hits
     */
    template<class T>
    const std::vector<T>& getHits() const;


    /**
     * Get container with hits.
     *
     * \return                container with hits
     */
    template<class T>
    std::vector<T>& getHits();


    /**
     * Get begin of data.
     *
     * \return                begin of data
     */
    template<class T>
    const_iterator<T> begin() const;


    /**
     * Get end of data.
     *
     * \return                end of data
     */
    template<class T>
    const_iterator<T> end() const;


    /**
     * Get reverse begin of data.
     *
     * \return                begin of data
     */
    template<class T>
    const_reverse_iterator<T> rbegin() const;


    /**
     * Get reverse end of data.
     *
     * \return                end of data
     */
    template<class T>
    const_reverse_iterator<T> rend() const;


    /**
     * Get number of hits.
     *
     * \return                number of hits
     */
    template<class T>
    unsigned int size() const;


    /**
     * Check emptyness of hit container.
     *
     * \return                true if empty; else false
     */
    template<class T>
    bool empty() const;


    /**
     * Clear event.
     */
    void clear()
    {
      snapshotHits .clear();
      triggeredHits.clear();
    }


    /**
     * Add hit.
     *
     * \param  hit            hit
     */
    void push_back(const JDAQKeyHit& hit)
    {
      snapshotHits.push_back(hit);
    }


    /**
     * Add hit.
     *
     * \param  hit            hit
     */
    void push_back(const JDAQTriggeredHit& hit)
    {
      triggeredHits.push_back(hit);
    }


    /**
     * Get trigger mask of given hit.
     *
     * \param  hit            hit
     * \return                trigger mask
     */
    static JTriggerMask_t getTriggerMask(const JDAQTriggeredHit& hit) 
    {
      return hit.getTriggerMask();
    }


    /**
     * Get trigger mask of given hit.
     *
     * \param  hit            hit
     * \return                trigger mask
     */
    JTriggerMask_t getTriggerMask(const JDAQSnapshotHit& hit) const
    {
      for (std::vector<JDAQTriggeredHit>::const_iterator i = triggeredHits.begin(); i != triggeredHits.end(); ++i) {
        if (*i == hit) {
          return i->getTriggerMask();
        }
      }

      return JTriggerMask_t(0);
    }


    /**
     * Read DAQ event from input.
     *
     * \param  in             JReader
     * \param  event          JDAQEvent
     * \return                JReader
     */
    friend inline JReader& operator>>(JReader& in, JDAQEvent& event)
    {
      in >> static_cast<JDAQPreamble&>   (event);
      in >> static_cast<JDAQEventHeader&>(event);
      in >> event.triggeredHits;
      in >> event.snapshotHits;
       
      return in;
    }


    /**
     * Write DAQ event to output.
     *
     * \param  out           JWriter
     * \param  event         JDAQEvent
     * \return               JWriter
     */
    friend inline JWriter& operator<<(JWriter& out, const JDAQEvent& event)
    {
      out << static_cast<const JDAQPreamble&>   (event);
      out << static_cast<const JDAQEventHeader&>(event);
      out << event.triggeredHits;
      out << event.snapshotHits;

      return out;
    }


    /**
     * Print DAQ Event.
     *
     * \param  out         output stream
     * \param  lpr         long print
     * \return             output stream
     */
    std::ostream& print(std::ostream& out, const bool lpr = false) const;


    /**
     * Get size of object.
     *
     * \return               number of bytes
     */
    virtual int getSize() const
    { 
      return (JDAQPreamble   ::sizeOf() +
              JDAQEventHeader::sizeOf() +
              sizeof(int)  +  triggeredHits.size() * JDAQTriggeredHit::sizeOf() +
              sizeof(int)  +  snapshotHits .size() * JDAQSnapshotHit ::sizeOf());
    }


    ClassDef(JDAQEvent,4);


  protected:
    std::vector<JDAQTriggeredHit> triggeredHits;
    std::vector<JDAQSnapshotHit>  snapshotHits;
  };


  /**
   * Equal operator for DAQ events.
   *
   * \param  first     event
   * \param  second    event
   * \result           true if first event equal to second; else false
   */
  bool operator==(const JDAQEvent& first,
                  const JDAQEvent& second);
  

  /**
   * Not-equal operator for DAQ events.
   *
   * \param  first     event
   * \param  second    event
   * \result           true if first event not equal to second; else false
   */
  inline bool operator!=(const JDAQEvent& first,
                         const JDAQEvent& second)
  {
    return !(first == second);
  }

  
  /**
   * Print DAQ Event.
   *
   * \param  out         output stream
   * \param  event       event
   * \return             output stream
   */
  inline std::ostream& operator<<(std::ostream& out, const JDAQEvent& event)
  {
    return event.print(out, getDAQLongprint());
  }
}

#endif