SIOVChannelStatusProvider.h

Go to the documentation of this file.

#ifndef SIOVCHANNELSTATUSPROVIDER_H
#define SIOVCHANNELSTATUSPROVIDER_H 1

// LArSoft libraries
#include "larevt/CalibrationDBI/Interface/ChannelStatusProvider.h"
#include "larevt/CalibrationDBI/Providers/DatabaseRetrievalAlg.h"
#include "larevt/CalibrationDBI/IOVData/ChannelStatus.h"
#include "larevt/CalibrationDBI/IOVData/Snapshot.h"

// Utility libraries
#include "fhiclcpp/ParameterSet.h"


namespace lariov {


  class SIOVChannelStatusProvider: public DatabaseRetrievalAlg, public ChannelStatusProvider {
    
    public:
    
      SIOVChannelStatusProvider(fhicl::ParameterSet const& pset);
    
      virtual ~SIOVChannelStatusProvider() = default;

      //
      // non-interface methods
      //
      const ChannelStatus& GetChannelStatus(raw::ChannelID_t channel) const;

      //
      // interface methods
      //

      bool IsPresent(raw::ChannelID_t channel) const override {
        return GetChannelStatus(channel).IsPresent();
      }

      bool IsBad(raw::ChannelID_t channel) const override {
        return GetChannelStatus(channel).IsDead() || GetChannelStatus(channel).IsLowNoise() || !IsPresent(channel);
      }

      bool IsNoisy(raw::ChannelID_t channel) const override {
        return GetChannelStatus(channel).IsNoisy();
      }
      
      bool IsGood(raw::ChannelID_t channel) const override {
        return GetChannelStatus(channel).IsGood(); 
      }
      
      Status_t Status(raw::ChannelID_t channel) const override {
        return (Status_t) this->GetChannelStatus(channel).Status();
      }

      ChannelSet_t GoodChannels() const override;

      ChannelSet_t BadChannels() const override;

      ChannelSet_t NoisyChannels() const override;


      void UpdateTimeStamp(DBTimeStamp_t ts);

      bool Update(DBTimeStamp_t);

      void AddNoisyChannel(raw::ChannelID_t ch);

      
      
      static DBChannelID_t rawToDBChannel(raw::ChannelID_t channel)
        { return DBChannelID_t(channel); }
      
    private:
    

      bool DBUpdate() const;                    // Uses current event time.
      bool DBUpdate(DBTimeStamp_t ts) const;

      // Time stamps.

      DBTimeStamp_t fEventTimeStamp;            // Most recently seen time stamp.
      mutable DBTimeStamp_t fCurrentTimeStamp;  // Time stamp of cached data.

      DataSource::ds fDataSource;
      mutable Snapshot<ChannelStatus> fData;    // Lazily updated once per IOV.
      Snapshot<ChannelStatus> fNewNoisy;        // Updated once per event.
      ChannelStatus fDefault;
      
      ChannelSet_t GetChannelsWithStatus(chStatus status) const;
    
  }; // class SIOVChannelStatusProvider
  
  
} // namespace lariov


#endif // SIOVCHANNELSTATUSPROVIDER_H