CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends
edm::StreamID Class Reference

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

Public Member Functions

 operator unsigned int () const
 
StreamIDoperator= (const StreamID &)=default
 
bool operator== (const StreamID &iID) const
 
 StreamID ()=delete
 
 StreamID (const StreamID &)=default
 
unsigned int value () const
 
 ~StreamID ()=default
 

Static Public Member Functions

static StreamID invalidStreamID ()
 

Private Member Functions

 StreamID (unsigned int iValue)
 

Private Attributes

unsigned int value_
 

Friends

class EventPrincipal
 
class Schedule
 Only a Schedule is allowed to create one of these. More...
 

Detailed Description

Description: Identifies an edm stream

Usage: Various APIs use this type to allow access to per stream information.

Definition at line 30 of file StreamID.h.

Constructor & Destructor Documentation

◆ ~StreamID()

edm::StreamID::~StreamID ( )
default

◆ StreamID() [1/3]

edm::StreamID::StreamID ( )
delete

Referenced by invalidStreamID().

◆ StreamID() [2/3]

edm::StreamID::StreamID ( const StreamID )
default

◆ StreamID() [3/3]

edm::StreamID::StreamID ( unsigned int  iValue)
inlineexplicitprivate

Definition at line 51 of file StreamID.h.

51 : value_(iValue) {}
unsigned int value_
Definition: StreamID.h:54

Member Function Documentation

◆ invalidStreamID()

static StreamID edm::StreamID::invalidStreamID ( )
inlinestatic

◆ operator unsigned int()

edm::StreamID::operator unsigned int ( ) const
inline

Definition at line 39 of file StreamID.h.

References value_.

39 { return value_; }
unsigned int value_
Definition: StreamID.h:54

◆ operator=()

StreamID& edm::StreamID::operator= ( const StreamID )
default

◆ operator==()

bool edm::StreamID::operator== ( const StreamID iID) const
inline

Definition at line 37 of file StreamID.h.

References value_.

37 { return iID.value_ == value_; }
unsigned int value_
Definition: StreamID.h:54

◆ value()

unsigned int edm::StreamID::value ( ) const
inline
Returns
value ranging from 0 to one less than max number of streams.

Definition at line 43 of file StreamID.h.

References value_.

Referenced by average.Average::average(), ExternalGeneratorFilter::beginStream(), DQMEDAnalyzer::DQMEDAnalyzer(), edm::ModuloStreamIDFilter::filter(), edm::service::RandomNumberGeneratorService::getEngine(), edm::service::RandomNumberGeneratorService::getEventCache(), edm::InputSource::issueReports(), edm::SystemTimeKeeper::pathTiming(), edm::SystemTimeKeeper::pauseModuleEvent(), FastTimerService::postESModule(), edm::service::Timing::postEvent(), edm::service::MessageLogger::postEvent(), edm::service::SimpleMemoryCheck::postModule(), FastTimerService::postModuleEvent(), evf::FastMonitoringService::postModuleEvent(), FastTimerService::postModuleEventAcquire(), evf::FastMonitoringService::postModuleEventAcquire(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), FastTimerService::postPathEvent(), evf::FastMonitoringService::postSourceEvent(), edm::service::StallMonitor::postSourceEvent(), evf::FastMonitoringService::postStreamBeginLumi(), evf::FastMonitoringService::postStreamEndLumi(), FastTimerService::preESModule(), edm::service::Timing::preEvent(), edm::service::MessageLogger::preEvent(), cond::service::PoolDBOutputService::preEventProcessing(), edm::service::SimpleMemoryCheck::preModule(), FastTimerService::preModuleEvent(), evf::FastMonitoringService::preModuleEvent(), cond::service::PoolDBOutputService::preModuleEvent(), FastTimerService::preModuleEventAcquire(), evf::FastMonitoringService::preModuleEventAcquire(), edm::service::RandomNumberGeneratorService::preModuleStreamCheck(), FastTimerService::prePathEvent(), evf::FastMonitoringService::preSourceEvent(), edm::service::StallMonitor::preSourceEvent(), edm::service::MessageLogger::preStreamBeginLumi(), evf::FastMonitoringService::preStreamBeginLumi(), edm::service::MessageLogger::preStreamBeginRun(), evf::FastMonitoringService::preStreamEarlyTermination(), edm::service::MessageLogger::preStreamEndLumi(), evf::FastMonitoringService::preStreamEndLumi(), edm::service::MessageLogger::preStreamEndRun(), edm::SubProcess::processAsync(), edm::StreamSchedule::processOneStreamAsync(), edm::PathStatusInserter::produce(), edm::LogErrorHarvester::produce(), EcalMixingModuleValidation::randomEngine(), edm::StreamerInputSource::read(), edm::RootFile::readCurrentEvent(), edm::PoolSource::readEvent_(), edm::RepeatingCachedRootSource::readEvent_(), edm::SystemTimeKeeper::restartModuleEvent(), edm::service::RandomNumberGeneratorService::saveStatesToFile(), edm::PathStatusInserter::setPathStatus(), edm::SystemTimeKeeper::startEvent(), edm::SystemTimeKeeper::startModuleEvent(), edm::SystemTimeKeeper::stopEvent(), edm::SystemTimeKeeper::stopModuleEvent(), edm::global::outputmodule::StreamCacheHolder< T, C >::streamCache(), edm::global::impl::StreamCacheHolder< T, C >::streamCache(), edm::limited::impl::StreamCacheHolder< T, C >::streamCache(), ExternalGeneratorFilter::streamEndRun(), edm::StreamSchedule::StreamSchedule(), and edm::EventPrincipal::transitionIndex_().

43 { return value_; }
unsigned int value_
Definition: StreamID.h:54

Friends And Related Function Documentation

◆ EventPrincipal

friend class EventPrincipal
friend

Definition at line 50 of file StreamID.h.

◆ Schedule

friend class Schedule
friend

Only a Schedule is allowed to create one of these.

Definition at line 49 of file StreamID.h.

Member Data Documentation

◆ value_

unsigned int edm::StreamID::value_
private

Definition at line 54 of file StreamID.h.

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