JDAQTriggeredHit.hh

Go to the documentation of this file.

#ifndef __JDAQTRIGGEREDHIT__
#define __JDAQTRIGGEREDHIT__

#include "JIO/JSerialisable.hh"
#include "JDAQ/JDAQRoot.hh"
#include "JDAQ/JDAQModuleIdentifier.hh"
#include "JDAQ/JDAQHit.hh"
#include "JDAQ/JDAQKeyHit.hh"
#include "JDAQ/JDAQTriggerMask.hh"


/**
 * \author mdejong
 */

namespace KM3NETDAQ {

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


  /**
   * DAQ triggered hit
   */
  class JDAQTriggeredHit :
    public JDAQKeyHit,
    public JDAQTriggerMask
  {
  public:


    /**
     * Default constructor.
     */
    JDAQTriggeredHit() :
      JDAQKeyHit     (),
      JDAQTriggerMask()
    {}


    /**
     * Constructor.
     *
     * \param  ID             module identifier
     * \param  hit            PMT hit
     * \param  mask           trigger mask
     */
    JDAQTriggeredHit(const JDAQModuleIdentifier& ID,
                     const JDAQHit&              hit,
                     const JDAQTriggerMask&      mask) :
      JDAQKeyHit(ID,hit),
      JDAQTriggerMask(mask)
    {}


    /**
     * Virtual destructor.
     */
    virtual ~JDAQTriggeredHit()
    {}


    /**
     * Read JDAQTriggeredHit from input.
     *
     * \param  in             JReader
     * \param  hit            JDAQTriggeredHit
     * \return                JReader
     */
    friend inline JReader& operator>>(JReader& in, JDAQTriggeredHit& hit)
    {
      in >> static_cast<JDAQKeyHit&>     (hit);
      in >> static_cast<JDAQTriggerMask&>(hit);
 
      return in;
    }


    /**
     * Write JDAQTriggeredHit to output.
     *
     * \param  out           JWriter
     * \param  hit           JDAQTriggeredHit
     * \return               JWriter
     */
    friend inline JWriter& operator<<(JWriter& out, const JDAQTriggeredHit& hit)
    {
      out << static_cast<const JDAQKeyHit&>     (hit);
      out << static_cast<const JDAQTriggerMask&>(hit);

      return out;
    }


    /**
     * Get size of object.
     *
     * \return               number of bytes
     */
    static int sizeOf()
    {
      return (JDAQKeyHit     ::sizeOf() + 
              JDAQTriggerMask::sizeOf());
    }


    ClassDef(JDAQTriggeredHit,2);
  };


  /**
   * Equal operator for DAQ triggered hits.
   *
   * \param  first     triggered hit
   * \param  second    triggered hit
   * \result           true if first triggered hit equal to second; else false
   */
  inline bool operator==(const JDAQTriggeredHit& first,
                         const JDAQTriggeredHit& second)
  {
    return (static_cast<const JDAQKeyHit&>     (first) == static_cast<const JDAQKeyHit&>     (second) &&
            static_cast<const JDAQTriggerMask&>(first) == static_cast<const JDAQTriggerMask&>(second));
  }


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

#endif