MEvent/Channel.h

Go to the documentation of this file.

#ifndef _mevt_Channel_h_
#define _mevt_Channel_h_

#include <evt/ComponentGroup.h>
#include <mevt/ChannelRecData.h>
//
#include <utl/ShadowPtr.h>
#include <utl/Trace.h>
#include <utl/TimeStamp.h>


namespace mevt {

  class Channel {

  public:
    utl::TraceB& GetTrace();

    const utl::TraceB& GetTrace() const;

    void MakeTrace();

    bool HasTrace() const;

    utl::TimeStamp GetTraceStartTime () const { return *fTimeStamp; }

    void SetTraceStartTime (const utl::TimeStamp& t) { fTimeStamp = new utl::TimeStamp(t); }

    bool HasTraceStartTime() const { return bool(fTimeStamp); }

    // Implicit ones.
    //Channel(const Channel& chan);
    //Channel& operator=(const Channel& chan);

    int GetId() const { return fId; }

    /* Mask used to exclude broken channels from the analysis
       Broken channels are conserved in the data with fMasked set to true.
       This can be useful, for example, to check that channels were masked correctly
    */
    void SetMask(bool mask) { fMasked = mask; }

    bool IsMasked() const { return fMasked; }


    ChannelRecData& GetRecData() { return *fRecData; }

    const ChannelRecData& GetRecData() const { return *fRecData; }

    void MakeRecData();

    bool HasRecData() const { return bool(fRecData); }
    //@

  private:
    //Channel() { }

    Channel(const int cId) : fId(cId), fMasked(false) { }

    ~Channel() { }

    friend class evt::ComponentGroup<Channel>;

    template<class T>
    friend void boost::checked_delete(T*) BOOST_NOEXCEPT;

    /*
     * Should be the trace linked to a timestamp?
     * Should be the channel hold multiple traces?
     * Seems not: at first the channel has only
     * a fixed size buffer (composed of two parts, see
     * mdet::FrontEnd).
     * An indentifier or timestamp may be associated
     * but that seems to be a higher-level responsability.
     */

    utl::ShadowPtr<utl::TraceB> fTrace;
    utl::ShadowPtr<utl::TimeStamp> fTimeStamp;
    int fId = -1;
    bool fMasked = false;
    utl::ShadowPtr<ChannelRecData> fRecData;

  };

}


#endif