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 ()=delete
	RunIndex (const RunIndex &)=default
unsigned int	value () const
	~RunIndex ()=default

Static Public Member Functions
static RunIndex	invalidRunIndex ()

Private Member Functions
	RunIndex (unsigned int iIndex)

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

~RunIndex()

edm::RunIndex::~RunIndex ( )

default

RunIndex() [1/3]

edm::RunIndex::RunIndex ( )

delete

Referenced by invalidRunIndex().

RunIndex() [2/3]

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

default

RunIndex() [3/3]

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

inlineexplicitprivate

Definition at line 52 of file RunIndex.h.

: value_(iIndex) {}

Member Function Documentation

invalidRunIndex()

RunIndex edm::RunIndex::invalidRunIndex ( )

static

Definition at line 9 of file RunIndex.cc.

{ return RunIndex(invalidValue_); }

References invalidValue_, and RunIndex().

Referenced by edm::Worker::beginStream(), edm::Worker::endStream(), edm::OccurrenceTraits< ProcessBlockPrincipal, BranchActionGlobalBegin >::makeGlobalContext(), edm::OccurrenceTraits< ProcessBlockPrincipal, BranchActionProcessBlockInput >::makeGlobalContext(), edm::OccurrenceTraits< ProcessBlockPrincipal, BranchActionGlobalEnd >::makeGlobalContext(), edm::OutputModuleCommunicatorT< T >::writeProcessBlockAsync(), and edm::Schedule::writeProcessBlockAsync().

operator unsigned int()

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

inline

Definition at line 41 of file RunIndex.h.

{ return value_; }

References value_.

operator=()

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

default

operator==()

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

inline

Definition at line 40 of file RunIndex.h.

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

References value().

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 45 of file RunIndex.h.

{ return value_; }

References value_.

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

Friends And Related Function Documentation

RunPrincipal

friend class RunPrincipal

friend

Only the RunPrincipal is allowed to make one of these.

Definition at line 51 of file RunIndex.h.

Member Data Documentation

invalidValue_

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

staticprivate

Definition at line 57 of file RunIndex.h.

Referenced by invalidRunIndex().

value_

unsigned int edm::RunIndex::value_

private

Definition at line 55 of file RunIndex.h.

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