CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Private Attributes
edm::StreamContext Class Reference

#include <StreamContext.h>

Public Types

enum  Transition {
  Transition::kBeginStream, Transition::kBeginRun, Transition::kBeginLuminosityBlock, Transition::kEvent,
  Transition::kEndLuminosityBlock, Transition::kEndRun, Transition::kEndStream, Transition::kInvalid
}
 

Public Member Functions

EventID const & eventID () const
 
bool isAtEndTransition () const
 
LuminosityBlockIndex const & luminosityBlockIndex () const
 
ProcessContext const * processContext () const
 
RunIndex const & runIndex () const
 
void setEventID (EventID const &v)
 
void setLuminosityBlockIndex (LuminosityBlockIndex const &v)
 
void setRunIndex (RunIndex const &v)
 
void setTimestamp (Timestamp const &v)
 
void setTransition (Transition v)
 
 StreamContext (StreamID const &streamID, ProcessContext const *processContext)
 
 StreamContext (StreamID const &streamID, Transition transition, EventID const &eventID, RunIndex const &runIndex, LuminosityBlockIndex const &luminosityBlockIndex, Timestamp const &timestamp, ProcessContext const *processContext)
 
StreamID const & streamID () const
 
Timestamp const & timestamp () const
 
Transition transition () const
 

Private Attributes

EventID eventID_
 
LuminosityBlockIndex luminosityBlockIndex_
 
ProcessContext const * processContext_
 
RunIndex runIndex_
 
StreamID streamID_
 
Timestamp timestamp_
 
Transition transition_
 

Detailed Description

Description: Holds pointer to ProcessContext, StreamID, transition, EventID and timestamp. This is intended primarily to be passed to Services as an argument to their callback functions.

Usage:

Definition at line 31 of file StreamContext.h.

Member Enumeration Documentation

◆ Transition

Enumerator
kBeginStream 
kBeginRun 
kBeginLuminosityBlock 
kEvent 
kEndLuminosityBlock 
kEndRun 
kEndStream 
kInvalid 

Definition at line 33 of file StreamContext.h.

33  {
35  kBeginRun,
36  kBeginLuminosityBlock,
37  kEvent,
38  kEndLuminosityBlock,
39  kEndRun,
40  kEndStream,
41  kInvalid
42  };

Constructor & Destructor Documentation

◆ StreamContext() [1/2]

edm::StreamContext::StreamContext ( StreamID const &  streamID,
ProcessContext const *  processContext 
)

Definition at line 9 of file StreamContext.cc.

12  eventID_(EventID(0, 0, 0)),
15  timestamp_(),
ProcessContext const * processContext_
Definition: StreamContext.h:78
static RunIndex invalidRunIndex()
Definition: RunIndex.cc:9
StreamID const & streamID() const
Definition: StreamContext.h:54
ProcessContext const * processContext() const
Definition: StreamContext.h:63
static LuminosityBlockIndex invalidLuminosityBlockIndex()
Timestamp timestamp_
Definition: StreamContext.h:77
LuminosityBlockIndex luminosityBlockIndex_
Definition: StreamContext.h:76
Transition transition_
Definition: StreamContext.h:73

◆ StreamContext() [2/2]

edm::StreamContext::StreamContext ( StreamID const &  streamID,
Transition  transition,
EventID const &  eventID,
RunIndex const &  runIndex,
LuminosityBlockIndex const &  luminosityBlockIndex,
Timestamp const &  timestamp,
ProcessContext const *  processContext 
)

Definition at line 18 of file StreamContext.cc.

Timestamp const & timestamp() const
Definition: StreamContext.h:62
ProcessContext const * processContext_
Definition: StreamContext.h:78
StreamID const & streamID() const
Definition: StreamContext.h:54
ProcessContext const * processContext() const
Definition: StreamContext.h:63
Transition transition() const
Definition: StreamContext.h:55
LuminosityBlockIndex const & luminosityBlockIndex() const
Definition: StreamContext.h:61
Timestamp timestamp_
Definition: StreamContext.h:77
LuminosityBlockIndex luminosityBlockIndex_
Definition: StreamContext.h:76
EventID const & eventID() const
Definition: StreamContext.h:59
RunIndex const & runIndex() const
Definition: StreamContext.h:60
Transition transition_
Definition: StreamContext.h:73

Member Function Documentation

◆ eventID()

EventID const& edm::StreamContext::eventID ( ) const
inline

Definition at line 59 of file StreamContext.h.

References eventID_.

Referenced by edm::exceptionContext(), edm::service::Timing::lastPostEvent(), edm::operator<<(), edm::service::IgProfService::postEvent(), edm::service::SimpleMemoryCheck::postEvent(), FastTimerService::postEvent(), edm::service::Tracer::postEvent(), edm::service::StallMonitor::postEvent(), edm::service::SimpleMemoryCheck::postModule(), edm::service::IgProfService::postModuleEvent(), edm::service::Timing::postModuleEvent(), edm::service::Tracer::postStreamBeginLumi(), edm::service::Tracer::postStreamBeginRun(), edm::service::Tracer::postStreamEndLumi(), edm::service::Tracer::postStreamEndRun(), edm::service::IgProfService::preEvent(), edm::service::CheckTransitions::preEvent(), edm::service::MessageLogger::preEvent(), edm::service::Tracer::preEvent(), edm::service::StallMonitor::preEvent(), edm::service::IgProfService::preModuleEvent(), edm::service::CheckTransitions::preStreamBeginLumi(), edm::service::MessageLogger::preStreamBeginLumi(), edm::service::Tracer::preStreamBeginLumi(), evf::FastMonitoringService::preStreamBeginLumi(), edm::service::CheckTransitions::preStreamBeginRun(), edm::service::MessageLogger::preStreamBeginRun(), edm::service::Tracer::preStreamBeginRun(), evf::FastMonitoringService::preStreamEarlyTermination(), edm::service::CheckTransitions::preStreamEndLumi(), edm::service::MessageLogger::preStreamEndLumi(), edm::service::Tracer::preStreamEndLumi(), evf::FastMonitoringService::preStreamEndLumi(), edm::service::CheckTransitions::preStreamEndRun(), edm::service::MessageLogger::preStreamEndRun(), edm::service::Tracer::preStreamEndRun(), and edm::service::Tracer::Tracer().

59 { return eventID_; } // event#==0 is a lumi, event#==0&lumi#==0 is a run

◆ isAtEndTransition()

bool edm::StreamContext::isAtEndTransition ( ) const
inline

Definition at line 56 of file StreamContext.h.

References kEndLuminosityBlock, kEndRun, or, and transition().

Referenced by edm::ParentContext::isAtEndTransition().

56  {
58  }
The Signals That Services Can Subscribe To This is based on ActivityRegistry and is current per Services can connect to the signals distributed by the ActivityRegistry in order to monitor the activity of the application Each possible callback has some defined which we here list in angle e< void, edm::EventID const &, edm::Timestamp const & > We also list in braces which AR_WATCH_USING_METHOD_ is used for those or
Definition: Activities.doc:12
Transition transition() const
Definition: StreamContext.h:55

◆ luminosityBlockIndex()

LuminosityBlockIndex const& edm::StreamContext::luminosityBlockIndex ( ) const
inline

◆ processContext()

ProcessContext const* edm::StreamContext::processContext ( ) const
inline

◆ runIndex()

RunIndex const& edm::StreamContext::runIndex ( ) const
inline

◆ setEventID()

void edm::StreamContext::setEventID ( EventID const &  v)
inline

◆ setLuminosityBlockIndex()

void edm::StreamContext::setLuminosityBlockIndex ( LuminosityBlockIndex const &  v)
inline

◆ setRunIndex()

void edm::StreamContext::setRunIndex ( RunIndex const &  v)
inline

◆ setTimestamp()

void edm::StreamContext::setTimestamp ( Timestamp const &  v)
inline

◆ setTransition()

void edm::StreamContext::setTransition ( Transition  v)
inline

◆ streamID()

StreamID const& edm::StreamContext::streamID ( ) const
inline

Definition at line 54 of file StreamContext.h.

References streamID_.

Referenced by edm::SecondaryEventProvider::beginLuminosityBlock(), edm::SecondaryEventProvider::beginRun(), edm::SecondaryEventProvider::endLuminosityBlock(), edm::SecondaryEventProvider::endRun(), edm::InputSource::EventSourceSentry::EventSourceSentry(), edm::exceptionContext(), edm::operator<<(), edm::SystemTimeKeeper::pathTiming(), edm::SystemTimeKeeper::pauseModuleEvent(), FastTimerService::postESModule(), edm::service::Timing::postEvent(), FastTimerService::postEvent(), edm::service::MessageLogger::postEvent(), edm::service::Tracer::postEvent(), NVProfilerService::postEvent(), evf::FastMonitoringService::postEvent(), edm::service::Tracer::postEventReadFromSource(), FastTimerService::postEventReadFromSource(), edm::service::SimpleMemoryCheck::postModule(), edm::service::Tracer::postModuleBeginStream(), NVProfilerService::postModuleBeginStream(), edm::service::Tracer::postModuleEndStream(), NVProfilerService::postModuleEndStream(), edm::service::Tracer::postModuleEvent(), FastTimerService::postModuleEvent(), evf::FastMonitoringService::postModuleEvent(), NVProfilerService::postModuleEvent(), FastTimerService::postModuleEventAcquire(), edm::service::Tracer::postModuleEventAcquire(), evf::FastMonitoringService::postModuleEventAcquire(), NVProfilerService::postModuleEventAcquire(), edm::service::Tracer::postModuleEventDelayedGet(), edm::service::Tracer::postModuleEventPrefetching(), NVProfilerService::postModuleEventPrefetching(), edm::service::Tracer::postModuleStreamBeginLumi(), NVProfilerService::postModuleStreamBeginLumi(), edm::service::Tracer::postModuleStreamBeginRun(), NVProfilerService::postModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::postModuleStreamCheck(), edm::service::Tracer::postModuleStreamEndLumi(), NVProfilerService::postModuleStreamEndLumi(), edm::service::Tracer::postModuleStreamEndRun(), NVProfilerService::postModuleStreamEndRun(), FastTimerService::postPathEvent(), edm::service::Tracer::postPathEvent(), NVProfilerService::postPathEvent(), edm::service::Tracer::postStreamBeginLumi(), NVProfilerService::postStreamBeginLumi(), evf::FastMonitoringService::postStreamBeginLumi(), edm::service::Tracer::postStreamBeginRun(), NVProfilerService::postStreamBeginRun(), edm::service::Tracer::postStreamEndLumi(), NVProfilerService::postStreamEndLumi(), evf::FastMonitoringService::postStreamEndLumi(), edm::service::Tracer::postStreamEndRun(), NVProfilerService::postStreamEndRun(), FastTimerService::preESModule(), edm::service::Timing::preEvent(), edm::service::CheckTransitions::preEvent(), edm::service::MessageLogger::preEvent(), edm::service::Tracer::preEvent(), NVProfilerService::preEvent(), cond::service::PoolDBOutputService::preEventProcessing(), edm::service::Tracer::preEventReadFromSource(), FastTimerService::preEventReadFromSource(), edm::service::SimpleMemoryCheck::preModule(), edm::service::Tracer::preModuleBeginStream(), NVProfilerService::preModuleBeginStream(), edm::service::Tracer::preModuleEndStream(), NVProfilerService::preModuleEndStream(), edm::service::Tracer::preModuleEvent(), FastTimerService::preModuleEvent(), evf::FastMonitoringService::preModuleEvent(), NVProfilerService::preModuleEvent(), cond::service::PoolDBOutputService::preModuleEvent(), FastTimerService::preModuleEventAcquire(), edm::service::Tracer::preModuleEventAcquire(), evf::FastMonitoringService::preModuleEventAcquire(), NVProfilerService::preModuleEventAcquire(), edm::service::Tracer::preModuleEventDelayedGet(), edm::service::Tracer::preModuleEventPrefetching(), NVProfilerService::preModuleEventPrefetching(), edm::service::Tracer::preModuleStreamBeginLumi(), NVProfilerService::preModuleStreamBeginLumi(), edm::service::Tracer::preModuleStreamBeginRun(), NVProfilerService::preModuleStreamBeginRun(), edm::service::RandomNumberGeneratorService::preModuleStreamCheck(), edm::service::Tracer::preModuleStreamEndLumi(), NVProfilerService::preModuleStreamEndLumi(), edm::service::Tracer::preModuleStreamEndRun(), NVProfilerService::preModuleStreamEndRun(), FastTimerService::prePathEvent(), edm::service::Tracer::prePathEvent(), NVProfilerService::prePathEvent(), evf::FastMonitoringService::prePathEvent(), edm::service::CheckTransitions::preStreamBeginLumi(), edm::service::MessageLogger::preStreamBeginLumi(), edm::service::Tracer::preStreamBeginLumi(), NVProfilerService::preStreamBeginLumi(), evf::FastMonitoringService::preStreamBeginLumi(), edm::service::CheckTransitions::preStreamBeginRun(), edm::service::MessageLogger::preStreamBeginRun(), edm::service::Tracer::preStreamBeginRun(), NVProfilerService::preStreamBeginRun(), evf::FastMonitoringService::preStreamEarlyTermination(), edm::service::CheckTransitions::preStreamEndLumi(), edm::service::MessageLogger::preStreamEndLumi(), edm::service::Tracer::preStreamEndLumi(), NVProfilerService::preStreamEndLumi(), evf::FastMonitoringService::preStreamEndLumi(), edm::service::CheckTransitions::preStreamEndRun(), edm::service::MessageLogger::preStreamEndRun(), edm::service::Tracer::preStreamEndRun(), NVProfilerService::preStreamEndRun(), edm::SystemTimeKeeper::restartModuleEvent(), edm::SystemTimeKeeper::startModuleEvent(), edm::SystemTimeKeeper::stopEvent(), edm::SystemTimeKeeper::stopModuleEvent(), and edm::service::Tracer::Tracer().

54 { return streamID_; }

◆ timestamp()

Timestamp const& edm::StreamContext::timestamp ( ) const
inline

◆ transition()

Transition edm::StreamContext::transition ( ) const
inline

Definition at line 55 of file StreamContext.h.

References transition_.

Referenced by edm::exceptionContext(), isAtEndTransition(), and edm::operator<<().

55 { return transition_; }
Transition transition_
Definition: StreamContext.h:73

Member Data Documentation

◆ eventID_

EventID edm::StreamContext::eventID_
private

Definition at line 74 of file StreamContext.h.

Referenced by eventID(), and setEventID().

◆ luminosityBlockIndex_

LuminosityBlockIndex edm::StreamContext::luminosityBlockIndex_
private

Definition at line 76 of file StreamContext.h.

Referenced by luminosityBlockIndex(), and setLuminosityBlockIndex().

◆ processContext_

ProcessContext const* edm::StreamContext::processContext_
private

Definition at line 78 of file StreamContext.h.

Referenced by processContext().

◆ runIndex_

RunIndex edm::StreamContext::runIndex_
private

Definition at line 75 of file StreamContext.h.

Referenced by runIndex(), and setRunIndex().

◆ streamID_

StreamID edm::StreamContext::streamID_
private

Definition at line 72 of file StreamContext.h.

Referenced by streamID().

◆ timestamp_

Timestamp edm::StreamContext::timestamp_
private

Definition at line 77 of file StreamContext.h.

Referenced by setTimestamp(), and timestamp().

◆ transition_

Transition edm::StreamContext::transition_
private

Definition at line 73 of file StreamContext.h.

Referenced by setTransition(), and transition().