a triple selector/context/store defines a stream More...

#include <PileUpStream.h>

Inheritance diagram for PileUpStream:

Collaboration diagram for PileUpStream:

Public Types
typedef IEvtSelector::Context	EvtIterator

Public Member Functions
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Structors
	PileUpStream ()
	Structors.
	PileUpStream (const PileUpStream &rhs)=delete
PileUpStream &	operator= (const PileUpStream &rhs)=delete
	PileUpStream (PileUpStream &&rhs)
PileUpStream &	operator= (PileUpStream &&rhs)
	PileUpStream (const std::string &name, ISvcLocator *svcLoc, const std::string &selecName)
	PileUpStream (const std::string &name, ISvcLocator svcLoc, IEvtSelector sel)
virtual	~PileUpStream ()

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

accessors
std::string	m_name
	Stream name.
ISvcLocator *	p_svcLoc {nullptr}
	ServiceLocator.
SmartIF< IEvtSelector >	m_sel
	Selector.
SmartIF< StoreGateSvc >	m_SG
	StoreGateSvc;.
EvtIterator *	p_iter {nullptr}
	Input Iterators.
ServiceHandle< PileUpMergeSvc >	m_mergeSvc
bool	m_ownEvtIterator {false}
	do we own p_iter?
bool	m_neverLoaded {true}
	has an event been loaded into this stream?
bool	m_ownStore {false}
	is m_SG a store we cloned from the master one?
bool	m_used {false}
	has this stream already been used? (for the current event)
bool	m_hasRing {false}
unsigned int	m_iOriginalRing {0}
	original ring in which event was used
const std::string &	name ()
IEvtSelector &	selector ()
EvtIterator &	iterator ()
StoreGateSvc &	store ()
const IEvtSelector &	selector () const
const EvtIterator &	iterator () const
const StoreGateSvc &	store () const
const xAOD::EventInfo *	nextEventPre (bool readRecord=true)
	return next Event, load store with next Event
bool	nextEventPre_Passive (bool readRecord)
	like nextEventPre, but doesn't actually load anything
bool	setupStore ()
	setup input and overlay selectors and iters
bool	setupStore (bool)
	backward compatibility
StatusCode	finalize ()
	finalize and release store. To be called on ... finalize()
bool	used () const
	has this stream already be used in this event?
void	setUsed ()
void	resetUsed ()
bool	hasRing () const
unsigned int	originalIRing () const
	index of the ring for which this stream was used originally
void	setOriginalIRing (unsigned int iR)
ISvcLocator *	serviceLocator ()
StatusCode	nextRecordPre ()
	increment event iterator before loading store
StatusCode	nextRecordPre_Passive ()
	increment event iterator
bool	loadStore ()
	clear store and load new proxies
void	setActiveStore ()
	set ActiveStore

Detailed Description

a triple selector/context/store defines a stream

Definition at line 30 of file PileUpStream.h.

Member Typedef Documentation

◆ EvtIterator

typedef IEvtSelector::Context PileUpStream::EvtIterator

Definition at line 34 of file PileUpStream.h.

Constructor & Destructor Documentation

◆ PileUpStream() [1/5]

PileUpStream::PileUpStream ( )

Structors.

Definition at line 25 of file PileUpStream.cxx.

                          :
  AthMessaging ("PileUpStream"),
  m_name("INVALID"),
  m_mergeSvc("PileUpMergeSvc", m_name)
{
}

◆ PileUpStream() [2/5]

PileUpStream::PileUpStream ( const PileUpStream & rhs )

delete

◆ PileUpStream() [3/5]

PileUpStream::PileUpStream ( PileUpStream && rhs )

Definition at line 32 of file PileUpStream.cxx.

                                            :
  PileUpStream()
{
  *this = std::move(rhs);
}

◆ PileUpStream() [4/5]

PileUpStream::PileUpStream	(	const std::string &	name,
		ISvcLocator *	svcLoc,
		const std::string &	selecName )

Definition at line 77 of file PileUpStream.cxx.

                                          :
  AthMessaging (name),
  m_name(name),
  p_svcLoc(svcLoc),
  m_mergeSvc("PileUpMergeSvc", name)
{
  m_sel = serviceLocator()->service<IEvtSelector>(selecName);
  if ( !(m_sel.isValid() && m_mergeSvc.isValid() &&
         m_sel->createContext(p_iter).isSuccess()) ) {
    const std::string errMsg("PileUpStream: can not create stream");
    ATH_MSG_ERROR ( errMsg );
    throw std::runtime_error(errMsg);
  } else  m_ownEvtIterator=true;
}

◆ PileUpStream() [5/5]

PileUpStream::PileUpStream	(	const std::string &	name,
		ISvcLocator *	svcLoc,
		IEvtSelector *	sel )

Definition at line 61 of file PileUpStream.cxx.

                                 :
  AthMessaging (name),
  m_name(name),
  p_svcLoc(svcLoc),
  m_sel(sel),
  m_mergeSvc("PileUpMergeSvc", name)
{
  if( !( m_sel->createContext(p_iter).isSuccess() && m_mergeSvc.isValid() ) ) {
    const std::string errMsg("PileUpStream:: can not create stream");
    ATH_MSG_ERROR ( errMsg );
    throw std::runtime_error(errMsg);
  } else  m_ownEvtIterator=true;
}

◆ ~PileUpStream()

PileUpStream::~PileUpStream ( )

virtual

Definition at line 94 of file PileUpStream.cxx.

95{

96}

Member Function Documentation

◆ finalize()

StatusCode PileUpStream::finalize ( )

finalize and release store. To be called on ... finalize()

Definition at line 232 of file PileUpStream.cxx.

                                  {
  StatusCode sc(StatusCode::SUCCESS);
  if (m_ownEvtIterator) delete p_iter;
  //we own and manage our cloned SG instance
  if (m_ownStore && Gaudi::StateMachine::INITIALIZED == store().FSMState()) {
    sc = this->store().sysFinalize();
  }
  this->store().release();
  return sc;
}

◆ hasRing()

bool PileUpStream::hasRing ( ) const

inline

Definition at line 81 of file PileUpStream.h.

81{ return m_hasRing; }

PileUpStream::m_hasRing

bool m_hasRing

Definition PileUpStream.h:126

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ iterator() [1/2]

EvtIterator & PileUpStream::iterator ( )

inline

Definition at line 56 of file PileUpStream.h.

56{ return *p_iter; }

◆ iterator() [2/2]

const EvtIterator & PileUpStream::iterator ( ) const

inline

Definition at line 59 of file PileUpStream.h.

59{ return *p_iter; }

◆ loadStore()

bool PileUpStream::loadStore ( )

private

clear store and load new proxies

Definition at line 179 of file PileUpStream.cxx.

{
  m_neverLoaded=false;
 
  IOpaqueAddress* paddr(0);
  bool rc = (this->selector().createAddress(iterator(), paddr)).isSuccess();
  if ( 0 != paddr) rc &= this->store().recordAddress(paddr).isSuccess();
 
  // load store proxies
  rc &= this->store().loadEventProxies().isSuccess();
  return rc;
}

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 163 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 178 of file AthMessaging.h.

179{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:163

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ name()

const std::string & PileUpStream::name ( )

inline

Definition at line 54 of file PileUpStream.h.

54{ return m_name; }

◆ nextEventPre()

const xAOD::EventInfo * PileUpStream::nextEventPre ( bool readRecord = true )

return next Event, load store with next Event

Definition at line 193 of file PileUpStream.cxx.

{
   if (m_neverLoaded) readRecord=true;
   else if (readRecord) {
      //do not reset these the first time we call nextEventPre
      this->resetUsed();
      m_hasRing=false;
   }
   //  if (isNotEmpty()) {
   if (readRecord && this->nextRecordPre().isFailure()) {
      ATH_MSG_INFO ( "nextEventPre(): end of the loop. No more events in the selection" );
      return nullptr;
   }
 
   const xAOD::EventInfo* xAODEventInfo = m_mergeSvc->getPileUpEvent( m_SG, "" );
   if (readRecord and xAODEventInfo) {
      ATH_MSG_DEBUG ( "nextEventPre(): read new event " 
              <<  xAODEventInfo->eventNumber() 
              << " run " << xAODEventInfo->runNumber()
              << " into store " << this->store().name() );
   }
 
   return xAODEventInfo;
}

◆ nextEventPre_Passive()

bool PileUpStream::nextEventPre_Passive ( bool readRecord )

like nextEventPre, but doesn't actually load anything

Definition at line 218 of file PileUpStream.cxx.

                                                       {
  if (m_neverLoaded) readRecord=true;
  else if (readRecord) {
    //do not reset these the first time we call nextEventPre_Passive
    this->resetUsed();
    m_hasRing=false;
  }
  if (readRecord && this->nextRecordPre_Passive().isFailure()) {
    ATH_MSG_INFO ( "nextEventPre_Passive(): end of the loop. No more events in the selection" );
    return false;
  } 
  return true;
}    

◆ nextRecordPre()

StatusCode PileUpStream::nextRecordPre ( )

private

increment event iterator before loading store

Definition at line 170 of file PileUpStream.cxx.

{
  // Clear the store, move to next event and load the store
  return (this->nextRecordPre_Passive().isSuccess() && 
      this->loadStore()) ?
    StatusCode::SUCCESS :
    StatusCode::FAILURE;
}

◆ nextRecordPre_Passive()

StatusCode PileUpStream::nextRecordPre_Passive ( )

private

increment event iterator

Definition at line 160 of file PileUpStream.cxx.

{
  this->setActiveStore();
  // Clear the store, move to next event
  return (this->store().clearStore().isSuccess() && 
      this->selector().next(iterator()).isSuccess() ) ?
    StatusCode::SUCCESS :
    StatusCode::FAILURE;
}

◆ operator=() [1/2]

PileUpStream & PileUpStream::operator= ( const PileUpStream & rhs )

delete

◆ operator=() [2/2]

PileUpStream & PileUpStream::operator= ( PileUpStream && rhs )

Definition at line 39 of file PileUpStream.cxx.

{
  if (this != &rhs) {
    m_name=rhs.m_name;
    p_svcLoc=rhs.p_svcLoc;
    m_sel=rhs.m_sel;
    m_SG=rhs.m_SG;
    p_iter=rhs.p_iter;
    m_mergeSvc = rhs.m_mergeSvc;
    m_ownEvtIterator=rhs.m_ownEvtIterator;
    m_neverLoaded=rhs.m_neverLoaded;
    m_ownStore=rhs.m_ownStore;
    m_used=rhs.m_used;
    m_hasRing=rhs.m_hasRing;
    m_iOriginalRing=rhs.m_iOriginalRing;
    //transferred ownership
    rhs.m_ownEvtIterator=false;
    rhs.m_ownStore=false;
  }
  return *this;
}

◆ originalIRing()

unsigned int PileUpStream::originalIRing ( ) const

inline

index of the ring for which this stream was used originally

Definition at line 83 of file PileUpStream.h.

83{ return m_iOriginalRing; }

◆ resetUsed()

void PileUpStream::resetUsed ( )

inline

Definition at line 80 of file PileUpStream.h.

80{m_used=false;}

◆ selector() [1/2]

IEvtSelector & PileUpStream::selector ( )

inline

Definition at line 55 of file PileUpStream.h.

55{ return *m_sel; }

◆ selector() [2/2]

const IEvtSelector & PileUpStream::selector ( ) const

inline

Definition at line 58 of file PileUpStream.h.

58{ return *m_sel; }

◆ serviceLocator()

ISvcLocator * PileUpStream::serviceLocator ( )

inlineprivate

Definition at line 93 of file PileUpStream.h.

93{ return p_svcLoc; }

◆ setActiveStore()

void PileUpStream::setActiveStore ( )

private

set ActiveStore

Definition at line 155 of file PileUpStream.cxx.

{
  store().makeCurrent();
}

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

◆ setOriginalIRing()

void PileUpStream::setOriginalIRing ( unsigned int iR )

inline

Definition at line 84 of file PileUpStream.h.

                                         {
    if (!m_hasRing) {
      m_hasRing=true;
      m_iOriginalRing=iR; 
    }
  }

◆ setupStore() [1/2]

bool PileUpStream::setupStore ( )

setup input and overlay selectors and iters

Definition at line 98 of file PileUpStream.cxx.

{
  bool rc(true);
  std::string storeName(name() + "_SG");
 
  //start by looking for the store directly: in overlay jobs it may already be there
  m_SG = serviceLocator()->service<StoreGateSvc>(storeName, /*createIf*/false);
  if (m_SG) {
    m_ownStore = false;
  } else {
    //not there, create one cloning the master store
    Service *child;
    //if the parent store is not there barf
    //remember the clone function also initializes the service if needed
    SmartIF<StoreGateSvc> pIS(serviceLocator()->service("StoreGateSvc"));
    rc = (pIS.isValid() &&
          CloneService::clone(pIS, storeName, child).isSuccess() &&
          (m_SG = SmartIF<StoreGateSvc>(child)).isValid());
    if ( rc )  {
      m_ownStore = true;
      // further initialization of the cloned service 
      rc = (m_SG->sysInitialize()).isSuccess();
      m_SG->setStoreID(StoreID::PILEUP_STORE); //needed by ProxyProviderSvc
    } //clones
  }
  if (rc) {
    //if the selector is an address provider like the AthenaPool one, 
    //create a dedicated ProxyProviderSvc and associate it to the store
    SmartIF<IAddressProvider> pIAP(m_sel);
    if (pIAP.isValid()) {
      const std::string PPSName(name() + "_PPS");
      SmartIF<IProxyProviderSvc> pPPSvc(serviceLocator()->service(PPSName));
      SmartIF<ISvcManager> pISM(serviceLocator());
      if ( pISM.isValid() &&
           pISM->declareSvcType(PPSName, "ProxyProviderSvc").isSuccess() &&
           pPPSvc.isValid() ) {
 
        pPPSvc->addProvider(pIAP);
        SmartIF<IAddressProvider> pAthPoolAddProv(serviceLocator()->service("AthenaPoolAddressProviderSvc"));
        if (pAthPoolAddProv.isValid()) {
          pPPSvc->addProvider(pAthPoolAddProv);
        } else {
          ATH_MSG_WARNING ( "could not add AthenaPoolAddressProviderSvc as AddresssProvider for "<< PPSName );
        }
        SmartIF<IAddressProvider> pAddrRemap(serviceLocator()->service("AddressRemappingSvc"));
        if (pAddrRemap.isValid()) {
          pPPSvc->addProvider(pAddrRemap);
        } else {
          ATH_MSG_WARNING ( "could not add AddressRemappingSvc as AddresssProvider for "<< PPSName );
        }
        m_SG->setProxyProviderSvc(pPPSvc);
      } 
    } //valid address provider
  }
  return rc;
}

◆ setupStore() [2/2]

bool PileUpStream::setupStore ( bool )

inline

backward compatibility

Definition at line 72 of file PileUpStream.h.

72{ return setupStore();}

PileUpStream::setupStore

bool setupStore()

setup input and overlay selectors and iters

Definition PileUpStream.cxx:98

◆ setUsed()

void PileUpStream::setUsed ( )

inline

Definition at line 79 of file PileUpStream.h.

79{m_used=true;}

◆ store() [1/2]

StoreGateSvc & PileUpStream::store ( )

inline

Definition at line 57 of file PileUpStream.h.

57{ return *m_SG; }

◆ store() [2/2]

const StoreGateSvc & PileUpStream::store ( ) const

inline

Definition at line 60 of file PileUpStream.h.

60{ return *m_SG; }

◆ used()

bool PileUpStream::used ( ) const

inline

has this stream already be used in this event?

Definition at line 78 of file PileUpStream.h.

78{return m_used;}

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_hasRing

bool PileUpStream::m_hasRing {false}

private

Definition at line 126 of file PileUpStream.h.

126{false};

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_iOriginalRing

unsigned int PileUpStream::m_iOriginalRing {0}

private

original ring in which event was used

Definition at line 127 of file PileUpStream.h.

127{0};

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_mergeSvc

ServiceHandle<PileUpMergeSvc> PileUpStream::m_mergeSvc

private

Definition at line 118 of file PileUpStream.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_name

std::string PileUpStream::m_name

private

Stream name.

Definition at line 108 of file PileUpStream.h.

◆ m_neverLoaded

bool PileUpStream::m_neverLoaded {true}

private

has an event been loaded into this stream?

Definition at line 122 of file PileUpStream.h.

122{true};

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_ownEvtIterator

bool PileUpStream::m_ownEvtIterator {false}

private

do we own p_iter?

Definition at line 121 of file PileUpStream.h.

121{false};

◆ m_ownStore

bool PileUpStream::m_ownStore {false}

private

is m_SG a store we cloned from the master one?

Definition at line 123 of file PileUpStream.h.

123{false};

◆ m_sel

SmartIF<IEvtSelector> PileUpStream::m_sel

private

Selector.

Definition at line 112 of file PileUpStream.h.

◆ m_SG

SmartIF<StoreGateSvc> PileUpStream::m_SG

private

StoreGateSvc;.

Definition at line 114 of file PileUpStream.h.

◆ m_used

bool PileUpStream::m_used {false}

private

has this stream already been used? (for the current event)

Definition at line 125 of file PileUpStream.h.

125{false};

◆ p_iter

EvtIterator* PileUpStream::p_iter {nullptr}

private

Input Iterators.

Definition at line 116 of file PileUpStream.h.

116{nullptr};

◆ p_svcLoc

ISvcLocator* PileUpStream::p_svcLoc {nullptr}

private

ServiceLocator.

Definition at line 110 of file PileUpStream.h.

110{nullptr};

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Private Member Functions

Private Attributes

accessors

Detailed Description

Member Typedef Documentation

◆ EvtIterator

Constructor & Destructor Documentation

◆ PileUpStream() [1/5]

◆ PileUpStream() [2/5]

◆ PileUpStream() [3/5]

◆ PileUpStream() [4/5]

◆ PileUpStream() [5/5]

◆ ~PileUpStream()

Member Function Documentation

◆ finalize()

◆ hasRing()

◆ initMessaging()

◆ iterator() [1/2]

◆ iterator() [2/2]

◆ loadStore()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ nextEventPre()

◆ nextEventPre_Passive()

◆ nextRecordPre()

◆ nextRecordPre_Passive()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ originalIRing()

◆ resetUsed()

◆ selector() [1/2]

◆ selector() [2/2]

◆ serviceLocator()

◆ setActiveStore()

◆ setLevel()

◆ setOriginalIRing()

◆ setupStore() [1/2]

◆ setupStore() [2/2]

◆ setUsed()

◆ store() [1/2]

◆ store() [2/2]

◆ used()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_hasRing

◆ m_imsg

◆ m_iOriginalRing

◆ m_lvl

◆ m_mergeSvc

◆ m_msg_tls

◆ m_name

◆ m_neverLoaded

◆ m_nm

◆ m_ownEvtIterator

◆ m_ownStore

◆ m_sel

◆ m_SG

◆ m_used

◆ p_iter

◆ p_svcLoc