CMS 3D CMS Logo

edm::LuminosityBlockID Class Reference

#include <DataFormats/Provenance/interface/LuminosityBlockID.h>

List of all members.

Public Member Functions

LuminosityBlockNumber_t luminosityBlock () const
 LuminosityBlockID (RunNumber_t iRun, LuminosityBlockNumber_t iLuminosityBlock)
 LuminosityBlockID ()
LuminosityBlockID next () const
LuminosityBlockID nextRun () const
LuminosityBlockID nextRunFirstLuminosityBlock () const
bool operator!= (LuminosityBlockID const &iRHS) const
bool operator< (LuminosityBlockID const &iRHS) const
bool operator<= (LuminosityBlockID const &iRHS) const
bool operator== (LuminosityBlockID const &iRHS) const
bool operator> (LuminosityBlockID const &iRHS) const
bool operator>= (LuminosityBlockID const &iRHS) const
LuminosityBlockID previous () const
LuminosityBlockID previousRunLastLuminosityBlock () const
RunNumber_t run () const

Static Public Member Functions

static LuminosityBlockID firstValidLuminosityBlock ()
static LuminosityBlockNumber_t maxLuminosityBlockNumber ()

Private Member Functions

template<template< typename > class Op>
bool doOp (LuminosityBlockID const &iRHS) const

Private Attributes

LuminosityBlockNumber_t luminosityBlock_
RunNumber_t run_


Detailed Description

Definition at line 33 of file LuminosityBlockID.h.


Constructor & Destructor Documentation

edm::LuminosityBlockID::LuminosityBlockID (  )  [inline]

Definition at line 39 of file LuminosityBlockID.h.

Referenced by firstValidLuminosityBlock(), next(), nextRun(), nextRunFirstLuminosityBlock(), previous(), and previousRunLastLuminosityBlock().

00039 : run_(0), luminosityBlock_(0) {}

edm::LuminosityBlockID::LuminosityBlockID ( RunNumber_t  iRun,
LuminosityBlockNumber_t  iLuminosityBlock 
) [inline]

Definition at line 40 of file LuminosityBlockID.h.

00040                                                                                     :
00041         run_(iRun), luminosityBlock_(iLuminosityBlock) {}
      


Member Function Documentation

template<template< typename > class Op>
bool edm::LuminosityBlockID::doOp ( LuminosityBlockID const &  iRHS  )  const [inline, private]

Definition at line 111 of file LuminosityBlockID.h.

References luminosityBlock_, and run_.

00111                                                      {
00112          //Run takes presidence for comparisions
00113          if(run_ == iRHS.run_) {
00114             Op<LuminosityBlockNumber_t> op_e;
00115             return op_e(luminosityBlock_, iRHS.luminosityBlock_);
00116          }
00117          Op<RunNumber_t> op;
00118          return op(run_, iRHS.run_) ;
00119       }

static LuminosityBlockID edm::LuminosityBlockID::firstValidLuminosityBlock (  )  [inline, static]

Definition at line 104 of file LuminosityBlockID.h.

References LuminosityBlockID().

00104                                                            {
00105          return LuminosityBlockID(1, 1);
00106       }

LuminosityBlockNumber_t edm::LuminosityBlockID::luminosityBlock (  )  const [inline]

Definition at line 47 of file LuminosityBlockID.h.

References luminosityBlock_.

Referenced by DTDigiTask::beginLuminosityBlock(), DTLocalTriggerTask::beginLuminosityBlock(), DTChamberEfficiencyTask::beginLuminosityBlock(), DTDigiForNoiseTask::beginLuminosityBlock(), DTEfficiencyTask::beginLuminosityBlock(), DTResolutionAnalysisTask::beginLuminosityBlock(), BOOST_PYTHON_MODULE(), edm::encode(), DTtTrigCalibrationTest::endLuminosityBlock(), MuonRecoTest::endLuminosityBlock(), DTResolutionAnalysisTest::endLuminosityBlock(), DTChamberEfficiencyTest::endLuminosityBlock(), QualityTester::endLuminosityBlock(), DTSegmentAnalysisTest::endLuminosityBlock(), RPCEventSummary::endLuminosityBlock(), L1Scalers::endLuminosityBlock(), RPCQualityTests::endLuminosityBlock(), RPCMultiplicityTest::endLuminosityBlock(), DTEfficiencyTest::endLuminosityBlock(), RPCDeadChannelTest::endLuminosityBlock(), HLTScalers::endLuminosityBlock(), DTDeadChannelTest::endLuminosityBlock(), DTResolutionTest::endLuminosityBlock(), DTNoiseTest::endLuminosityBlock(), DTDataIntegrityTest::endLuminosityBlock(), MuonTrackResidualsTest::endLuminosityBlock(), edm::LuminosityBlockAuxiliary::luminosityBlock(), edm::operator<<(), edm::RootFile::readLumi(), edm::RootFile::setEntryAtLumi(), and edm::PoolOutputModule::writeLuminosityBlock().

00047 { return luminosityBlock_; }

static LuminosityBlockNumber_t edm::LuminosityBlockID::maxLuminosityBlockNumber (  )  [inline, static]

Definition at line 100 of file LuminosityBlockID.h.

Referenced by edm::EventProcessor::endRun(), next(), previous(), and previousRunLastLuminosityBlock().

00100                                                                 {
00101          return 0xFFFFFFFFU;
00102       }

LuminosityBlockID edm::LuminosityBlockID::next (  )  const [inline]

Definition at line 50 of file LuminosityBlockID.h.

References luminosityBlock_, LuminosityBlockID(), maxLuminosityBlockNumber(), and run_.

00050                                      {
00051          if(luminosityBlock_ != maxLuminosityBlockNumber()) {
00052             return LuminosityBlockID(run_, luminosityBlock_+1);
00053          }
00054          return LuminosityBlockID(run_+1, 1);
00055       }

LuminosityBlockID edm::LuminosityBlockID::nextRun (  )  const [inline]

Definition at line 56 of file LuminosityBlockID.h.

References LuminosityBlockID(), and run_.

00056                                         {
00057          return LuminosityBlockID(run_+1, 0);
00058       }

LuminosityBlockID edm::LuminosityBlockID::nextRunFirstLuminosityBlock (  )  const [inline]

Definition at line 59 of file LuminosityBlockID.h.

References LuminosityBlockID(), and run_.

00059                                                             {
00060          return LuminosityBlockID(run_+1, 1);
00061       }

bool edm::LuminosityBlockID::operator!= ( LuminosityBlockID const &  iRHS  )  const [inline]

Definition at line 82 of file LuminosityBlockID.h.

00082                                                            {
00083          return ! (*this == iRHS);
00084       }

bool edm::LuminosityBlockID::operator< ( LuminosityBlockID const &  iRHS  )  const [inline]

Definition at line 86 of file LuminosityBlockID.h.

00086                                                           {
00087          return doOp<std::less>(iRHS);
00088       }

bool edm::LuminosityBlockID::operator<= ( LuminosityBlockID const &  iRHS  )  const [inline]

Definition at line 89 of file LuminosityBlockID.h.

00089                                                            {
00090          return doOp<std::less_equal>(iRHS);
00091       }

bool edm::LuminosityBlockID::operator== ( LuminosityBlockID const &  iRHS  )  const [inline]

Definition at line 79 of file LuminosityBlockID.h.

References luminosityBlock_, and run_.

00079                                                            {
00080          return iRHS.run_ == run_ && iRHS.luminosityBlock_ == luminosityBlock_;
00081       }

bool edm::LuminosityBlockID::operator> ( LuminosityBlockID const &  iRHS  )  const [inline]

Definition at line 92 of file LuminosityBlockID.h.

00092                                                           {
00093          return doOp<std::greater>(iRHS);
00094       }

bool edm::LuminosityBlockID::operator>= ( LuminosityBlockID const &  iRHS  )  const [inline]

Definition at line 95 of file LuminosityBlockID.h.

00095                                                            {
00096          return doOp<std::greater_equal>(iRHS);
00097       }

LuminosityBlockID edm::LuminosityBlockID::previous (  )  const [inline]

Definition at line 69 of file LuminosityBlockID.h.

References luminosityBlock_, LuminosityBlockID(), maxLuminosityBlockNumber(), and run_.

00069                                          {
00070          if(luminosityBlock_ > 1) {
00071             return LuminosityBlockID(run_, luminosityBlock_-1);
00072          }
00073          if(run_ != 0) {
00074             return LuminosityBlockID(run_ -1, maxLuminosityBlockNumber());
00075          }
00076          return LuminosityBlockID(0,0);
00077       }

LuminosityBlockID edm::LuminosityBlockID::previousRunLastLuminosityBlock (  )  const [inline]

Definition at line 62 of file LuminosityBlockID.h.

References LuminosityBlockID(), maxLuminosityBlockNumber(), and run_.

00062                                                                {
00063          if(run_ > 1) {
00064             return LuminosityBlockID(run_-1, maxLuminosityBlockNumber());
00065          }
00066          return LuminosityBlockID(0,0);
00067       }

RunNumber_t edm::LuminosityBlockID::run (  )  const [inline]

Definition at line 46 of file LuminosityBlockID.h.

References run_.

Referenced by EcalEndcapMonitorClient::beginLuminosityBlock(), EcalBarrelMonitorClient::beginLuminosityBlock(), BOOST_PYTHON_MODULE(), edm::encode(), EcalEndcapMonitorClient::endLuminosityBlock(), EcalBarrelMonitorClient::endLuminosityBlock(), edm::operator<<(), edm::LuminosityBlockAuxiliary::run(), edm::RootFile::setEntryAtLumi(), and edm::PoolOutputModule::writeLuminosityBlock().

00046 { return run_; }


Member Data Documentation

LuminosityBlockNumber_t edm::LuminosityBlockID::luminosityBlock_ [private]

Definition at line 126 of file LuminosityBlockID.h.

Referenced by doOp(), luminosityBlock(), next(), operator==(), and previous().

RunNumber_t edm::LuminosityBlockID::run_ [private]

Definition at line 125 of file LuminosityBlockID.h.

Referenced by doOp(), next(), nextRun(), nextRunFirstLuminosityBlock(), operator==(), previous(), previousRunLastLuminosityBlock(), and run().


The documentation for this class was generated from the following file:
Generated on Tue Jun 9 18:41:46 2009 for CMSSW by  doxygen 1.5.4