/data/refman/pasoursint/CMSSW_6_1_2_SLHC2_patch1/src/DataFormats/SiStripCommon/interface/SiStripEventSummary.h

Go to the documentation of this file.

// Last commit: $Id: SiStripEventSummary.h,v 1.10 2008/06/09 12:55:03 delaer Exp $

#ifndef DataFormats_SiStripEventSummary_SiStripEventSummary_H
#define DataFormats_SiStripEventSummary_SiStripEventSummary_H

#include "DataFormats/SiStripCommon/interface/SiStripConstants.h"
#include <sstream>
#include <vector>

class SiStripEventSummary;

std::ostream& operator<< ( std::ostream&, const SiStripEventSummary& );

class SiStripEventSummary {

 public:

  // ---------- Constructors, destructors ----------
  
  SiStripEventSummary();
  
  ~SiStripEventSummary() {;}
  
  // ---------- General information ----------
  
  inline bool valid() const;
  
  inline uint16_t triggerFed() const;

  inline bool isSet() const;
  
  // ---------- Run and event-related info ----------
  
  inline const sistrip::RunType& runType() const;

  inline const uint32_t& event() const;

  inline const uint32_t& bx() const;
  
  // ---------- Hardware-related info ----------

  inline const sistrip::FedReadoutMode& fedReadoutMode() const;

  inline const sistrip::ApvReadoutMode& apvReadoutMode() const;

  inline const uint16_t& apveAddress() const;

  inline const uint32_t& nApvsInSync() const;

  inline const uint32_t& nApvsOutOfSync() const;

  inline const uint32_t& nApvsErrors() const;
  
  // ---------- Commissioning info ----------

  inline bool nullParams() const; 

  inline const std::vector<uint32_t>& params() const; 
  
  inline const uint32_t& binNumber() const; 

  inline const uint32_t& pllCoarse() const; 
  
  inline const uint32_t& pllFine() const; 

  inline const uint32_t& latency() const;
  
  inline const uint32_t& calChan() const;
  
  inline const uint32_t& calSel() const;
  
  inline const uint32_t& isha() const;
  
  inline const uint32_t& vfs() const;
  
  inline const uint32_t& ttcrx() const;
  
  inline const uint32_t& vpsp() const;
  
  inline const uint32_t& vpspCcuChan() const;
  
  inline const uint32_t& lldGain() const;

  inline const uint32_t& lldBias() const;
  
  inline const uint32_t& deviceId() const;
  
  inline const uint32_t& processId() const;
  
  inline const uint32_t& processIp() const;
  
  inline const uint32_t& dcuId() const;
  
  inline const uint32_t& layerScanned() const;

  // ---------- Setter methods ----------
  
  void commissioningInfo( const uint32_t* const buffer,
                          const uint32_t& event );

  void commissioningInfo( const uint32_t& daq_register1,
                          const uint32_t& daq_register2 );
  
  inline void triggerFed( const int16_t& );
  
  void fedReadoutMode( const uint16_t& );
  
  inline void event( const uint32_t& );

  inline void bx( const uint32_t& );

  inline void apveAddress( uint16_t& addr );
  inline void nApvsInSync( uint32_t& napvs_in_sync );
  inline void nApvsOutOfSync( uint32_t& napvs_out_of_sync );
  inline void nApvsErrors( uint32_t& napvs_with_errors );
  
 private:

  // ---------- General info ----------

  bool valid_;

  uint16_t triggerFed_;


  // ---------- Run- and event-related info ----------
  
  sistrip::RunType runType_;

  uint32_t event_;
  
  uint32_t bx_;

  uint32_t spillNumber_;

  uint32_t nDataSenders_;
  
  // ---------- Hardware-related info ----------

  sistrip::FedReadoutMode fedReadoutMode_;

  sistrip::ApvReadoutMode apvReadoutMode_;

  uint16_t apveAddress_;

  uint32_t nApvsInSync_;

  uint32_t nApvsOutOfSync_;

  uint32_t nApvsErrors_;

  std::vector<uint32_t> params_;

};

// ---------- inline methods ----------

bool SiStripEventSummary::valid() const { return valid_; }
uint16_t SiStripEventSummary::triggerFed() const { return triggerFed_; }
bool SiStripEventSummary::isSet() const { return ( /* triggerFed_ > 0 && */ runType_ != sistrip::UNDEFINED_RUN_TYPE ); }  

const sistrip::RunType& SiStripEventSummary::runType() const { return runType_; }
const uint32_t& SiStripEventSummary::event() const { return event_; }
const uint32_t& SiStripEventSummary::bx() const { return bx_; }

const sistrip::FedReadoutMode& SiStripEventSummary::fedReadoutMode() const { return fedReadoutMode_; }
const sistrip::ApvReadoutMode& SiStripEventSummary::apvReadoutMode() const { return apvReadoutMode_; }

const uint16_t& SiStripEventSummary::apveAddress() const { return apveAddress_; }
const uint32_t& SiStripEventSummary::nApvsInSync() const { return nApvsInSync_; }
const uint32_t& SiStripEventSummary::nApvsOutOfSync() const { return nApvsOutOfSync_; }
const uint32_t& SiStripEventSummary::nApvsErrors() const { return nApvsErrors_; }

bool SiStripEventSummary::nullParams() const { return ( !params_[0] && !params_[1] && !params_[2] && !params_[3] ); } 
const std::vector<uint32_t>& SiStripEventSummary::params() const { return params_; } 
const uint32_t& SiStripEventSummary::binNumber() const { return params_[0]; }
const uint32_t& SiStripEventSummary::pllCoarse() const { return params_[0]; }
const uint32_t& SiStripEventSummary::pllFine() const { return params_[1]; }
const uint32_t& SiStripEventSummary::latency() const { return params_[0]; }
const uint32_t& SiStripEventSummary::calChan() const { return params_[1]; }
const uint32_t& SiStripEventSummary::calSel() const { return params_[2]; }
const uint32_t& SiStripEventSummary::isha() const { return params_[3]; }
const uint32_t& SiStripEventSummary::vfs() const { return params_[4]; }
const uint32_t& SiStripEventSummary::ttcrx() const { return params_[2]; }
const uint32_t& SiStripEventSummary::vpsp() const { return params_[0]; }
const uint32_t& SiStripEventSummary::vpspCcuChan() const { return params_[1]; }
const uint32_t& SiStripEventSummary::lldGain() const { return params_[0]; }
const uint32_t& SiStripEventSummary::lldBias() const { return params_[1]; }
const uint32_t& SiStripEventSummary::deviceId() const { return params_[0]; }
const uint32_t& SiStripEventSummary::processId() const { return params_[1]; }
const uint32_t& SiStripEventSummary::processIp() const { return params_[2]; }
const uint32_t& SiStripEventSummary::dcuId() const { return params_[3]; }
const uint32_t& SiStripEventSummary::layerScanned() const { return params_[3]; }

void SiStripEventSummary::triggerFed( const int16_t& fed ) { fed < 0 ? triggerFed_ = 0 : triggerFed_ = fed; }
void SiStripEventSummary::event( const uint32_t& event ) { event_ = event; }
void SiStripEventSummary::bx( const uint32_t& bx ) { bx_ = bx; }

void SiStripEventSummary::apveAddress( uint16_t& addr ) { apveAddress_ = addr; }
void SiStripEventSummary::nApvsInSync( uint32_t& napvs_in_sync ) { nApvsInSync_ = napvs_in_sync; }
void SiStripEventSummary::nApvsOutOfSync( uint32_t& napvs_out_of_sync ) { nApvsOutOfSync_ = napvs_out_of_sync; }
void SiStripEventSummary::nApvsErrors( uint32_t& napvs_with_errors ) { nApvsErrors_ = napvs_with_errors; }

#endif // DataFormats_SiStripEventSummary_SiStripEventSummary_H