JDAQSuperFrameHeader.hh

Go to the documentation of this file.

#ifndef __JDAQSUPERFRAMEHEADER__
#define __JDAQSUPERFRAMEHEADER__

#include "JIO/JSerialisable.hh"
#include "JDAQ/JDAQ.hh"
#include "JDAQ/JDAQHeader.hh"
#include "JDAQ/JDAQModuleIdentifier.hh"
#include "JDAQ/JDAQFrameStatus.hh"
#include "JDAQ/JDAQRoot.hh"


/**
 * \author mdejong
 */

namespace KM3NETDAQ {

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


  /**
   * DAQ super frame header.
   */
  class JDAQSuperFrameHeader :
    public JDAQHeader,
    public JDAQModuleIdentifier,
    public JDAQFrameStatus
 {
  public:
    /**
     * Default constructor.
     */
    JDAQSuperFrameHeader() :
      JDAQHeader          (),
      JDAQModuleIdentifier(),
      JDAQFrameStatus     ()
    {}


    /**
     * Constructor.
     *
     * \param  chronometer    chronometer
     * \param  id             module identifier
     */
    JDAQSuperFrameHeader(const JDAQChronometer& chronometer,
                         const int              id) :
      JDAQHeader          (chronometer),
      JDAQModuleIdentifier(id),
      JDAQFrameStatus     (JDAQFrameStatus::getInstance())
    {}


    /**
     * Constructor.
     *
     * \param  chronometer    chronometer
     * \param  id             module identifier
     * \param  status         frame status
     */
    JDAQSuperFrameHeader(const JDAQChronometer& chronometer,
                         const int              id,
                         const JDAQFrameStatus& status) :
      JDAQHeader          (chronometer),
      JDAQModuleIdentifier(id),
      JDAQFrameStatus     (status)
    {}


    /**
     * Get DAQ super frame header.
     *
     * \return                DAQ super frame header
     */
    const JDAQSuperFrameHeader& getDAQSuperFrameHeader() const
    {
      return static_cast<const JDAQSuperFrameHeader&>(*this);
    }


    /**
     * Set DAQ super frame header.
     *
     * \param  header         DAQ super frame header
     */
    void setDAQSuperFrameHeader(const JDAQSuperFrameHeader& header)
    {
      static_cast<JDAQSuperFrameHeader&>(*this) = header;
    }


    /**
     * Read DAQ super frame header from input.
     *
     * \param  in             JReader
     * \param  header         JDAQSuperFrameHeader
     * \return                JReader
     */
    friend inline JReader& operator>>(JReader& in, JDAQSuperFrameHeader& header)
    {
      in >> static_cast<JDAQHeader&>          (header);
      in >> static_cast<JDAQModuleIdentifier&>(header);
      in >> static_cast<JDAQFrameStatus&>     (header);

      return in;
    }


    /**
     * Write DAQ super frame header to output.
     *
     * \param  out            JWriter
     * \param  header         JDAQSuperFrameHeader
     * \return                JWriter
     */
    friend inline JWriter& operator<<(JWriter& out, const JDAQSuperFrameHeader& header)
    {
      out << static_cast<const JDAQHeader&>          (header);
      out << static_cast<const JDAQModuleIdentifier&>(header);
      out << static_cast<const JDAQFrameStatus&>     (header);

      return out;
    }


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


    ClassDef(JDAQSuperFrameHeader,2);
  };


  /**
   * Equal operator for DAQ super frame headers.
   *
   * \param  first     super frame header
   * \param  second    super frame header
   * \result           true if first super frame header equal to second; else false
   */
  inline bool operator==(const JDAQSuperFrameHeader& first,
                         const JDAQSuperFrameHeader& second)
  {
    return (first.getDAQHeader()        == second.getDAQHeader()         &&
            first.getModuleIdentifier() == second.getModuleIdentifier()  &&
            first.getDAQFrameStatus()   == second.getDAQFrameStatus());
  }


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

#endif