edm::LuminosityBlockIndex Class Reference

#include "FWCore/Utilities/interface/LuminosityBlockIndex.h"

Public Member Functions
	LuminosityBlockIndex (const LuminosityBlockIndex &)=default
	operator unsigned int () const
LuminosityBlockIndex &	operator= (const LuminosityBlockIndex &)=default
bool	operator== (LuminosityBlockIndex const &iRHS) const
unsigned int	value () const
	~LuminosityBlockIndex ()=default

Static Public Member Functions
static LuminosityBlockIndex	invalidLuminosityBlockIndex ()

Private Member Functions
	LuminosityBlockIndex (unsigned int iValue)
	LuminosityBlockIndex ()=delete

Private Attributes
unsigned int	value_

Static Private Attributes
static const unsigned int	invalidValue_ = std::numeric_limits<unsigned int>::max()

Friends
class	LuminosityBlockPrincipal
	Only the LuminosityBlockPrincipal is allowed to make one of these. More...

Detailed Description

Description: Identifies a 'slot' being used to hold an active LuminosityBlock

Usage: Various APIs used this to access per LuminosityBlock information. It is important to realize that the same LuminosityBockIndex may be used to refer to different LuminosityBlocks over the lifetime of a job. A LuminosityBlockIndex will only get a new LuminosityBlock after the previous LuminosityBlock using that index has finished being used.

Definition at line 33 of file LuminosityBlockIndex.h.

Constructor & Destructor Documentation

edm::LuminosityBlockIndex::LuminosityBlockIndex ( const LuminosityBlockIndex &  )

default

edm::LuminosityBlockIndex::~LuminosityBlockIndex ( )

default

edm::LuminosityBlockIndex::LuminosityBlockIndex ( unsigned int  iValue )

inlineexplicitprivate

Definition at line 60 of file LuminosityBlockIndex.h.

References LuminosityBlockIndex().

: value_{iValue} {}

edm::LuminosityBlockIndex::LuminosityBlockIndex ( )

privatedelete

Referenced by invalidLuminosityBlockIndex(), and LuminosityBlockIndex().

Member Function Documentation

LuminosityBlockIndex edm::LuminosityBlockIndex::invalidLuminosityBlockIndex ( )

static

Definition at line 9 of file LuminosityBlockIndex.cc.

References invalidValue_, and LuminosityBlockIndex().

Referenced by edm::Worker::beginStream(), edm::EDLooperBase::doBeginRun(), edm::EDLooperBase::doEndRun(), edm::Worker::endStream(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalBegin >::makeGlobalContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionGlobalEnd >::makeGlobalContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionStreamBegin >::setStreamContext(), edm::OccurrenceTraits< RunPrincipal, BranchActionStreamEnd >::setStreamContext(), value(), and edm::OutputModuleCommunicatorT< T >::writeRun().

                                                                         {
    return LuminosityBlockIndex(invalidValue_);
  }

edm::LuminosityBlockIndex::operator unsigned int ( ) const

inline

Definition at line 42 of file LuminosityBlockIndex.h.

References value_.

                                  {
      return value_;
    }

LuminosityBlockIndex& edm::LuminosityBlockIndex::operator= ( const LuminosityBlockIndex &  )

default

bool edm::LuminosityBlockIndex::operator== ( LuminosityBlockIndex const &  iRHS ) const

inline

Definition at line 46 of file LuminosityBlockIndex.h.

References value().

                                                            {
      return value() == iRHS.value();
    }

unsigned int edm::LuminosityBlockIndex::value ( ) const

inline

Returns

value ranging from 0 to one less than max number of simultaneous luminosityblocks.

Definition at line 52 of file LuminosityBlockIndex.h.

References invalidLuminosityBlockIndex(), and value_.

Referenced by average.Average::average(), edm::service::RandomNumberGeneratorService::getEngine(), edm::service::RandomNumberGeneratorService::getLumiCache(), edm::operator<<(), operator==(), edm::service::MessageLogger::preModuleGlobalBeginLumi(), edm::service::MessageLogger::preModuleGlobalEndLumi(), and edm::LuminosityBlockPrincipal::transitionIndex_().

{ return value_;}

Friends And Related Function Documentation

friend class LuminosityBlockPrincipal

friend

Only the LuminosityBlockPrincipal is allowed to make one of these.

Definition at line 58 of file LuminosityBlockIndex.h.

Member Data Documentation

const unsigned int edm::LuminosityBlockIndex::invalidValue_ = std::numeric_limits<unsigned int>::max()

staticprivate

Definition at line 67 of file LuminosityBlockIndex.h.

Referenced by invalidLuminosityBlockIndex().

unsigned int edm::LuminosityBlockIndex::value_

private

Definition at line 65 of file LuminosityBlockIndex.h.

Referenced by operator unsigned int(), and value().