edm::RunIndex Class Reference

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

Public Member Functions
	operator unsigned int () const
RunIndex &	operator= (const RunIndex &)=default
bool	operator== (const RunIndex &iIndex) const
	RunIndex (const RunIndex &)=default
unsigned int	value () const
	~RunIndex ()=default

Static Public Member Functions
static RunIndex	invalidRunIndex ()

Private Member Functions
	RunIndex (unsigned int iIndex)
	RunIndex ()=delete

Private Attributes
unsigned int	value_

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

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

Detailed Description

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

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

Definition at line 32 of file RunIndex.h.

Constructor & Destructor Documentation

edm::RunIndex::~RunIndex ( )

default

edm::RunIndex::RunIndex ( const RunIndex &  )

default

edm::RunIndex::RunIndex ( unsigned int  iIndex )

inlineexplicitprivate

Definition at line 57 of file RunIndex.h.

References RunIndex().

: value_(iIndex) {}

edm::RunIndex::RunIndex ( )

privatedelete

Referenced by invalidRunIndex(), and RunIndex().

Member Function Documentation

RunIndex edm::RunIndex::invalidRunIndex ( )

static

Definition at line 9 of file RunIndex.cc.

References invalidValue_, and RunIndex().

Referenced by edm::Worker::beginStream(), edm::Worker::endStream(), and value().

                                     {
    return RunIndex(invalidValue_);
  }

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

inline

Definition at line 44 of file RunIndex.h.

References value_.

                                  {
      return value_;
    }

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

default

bool edm::RunIndex::operator== ( const RunIndex &  iIndex ) const

inline

Definition at line 41 of file RunIndex.h.

References value().

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

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

inline

Returns

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

Definition at line 50 of file RunIndex.h.

References invalidRunIndex(), and value_.

Referenced by average.Average::average(), edm::operator<<(), operator==(), edm::service::MessageLogger::preModuleGlobalBeginRun(), edm::service::MessageLogger::preModuleGlobalEndRun(), and edm::RunPrincipal::transitionIndex_().

{ return value_;}

Friends And Related Function Documentation

friend class RunPrincipal

friend

Only the RunPrincipal is allowed to make one of these.

Definition at line 56 of file RunIndex.h.

Member Data Documentation

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

staticprivate

Definition at line 64 of file RunIndex.h.

Referenced by invalidRunIndex().

unsigned int edm::RunIndex::value_

private

Definition at line 62 of file RunIndex.h.

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