Helper class for Start Of Run (SOR) record. More...

#include <TrigSORFromPtreeHelper.h>

Inheritance diagram for TrigSORFromPtreeHelper:

Collaboration diagram for TrigSORFromPtreeHelper:

Public Types
typedef CondAttrListCollection	SOR

Public Member Functions
	TrigSORFromPtreeHelper (IMessageSvc *msgSvc, const ServiceHandle< StoreGateSvc > &detStore, const std::string &sorpath, const boost::property_tree::ptree &rparams)
	Create the SOR helper @params msgSvc Pointer to MessageSvc @params detStore Handle to DetectorStore @params sorpath COOL folder path of SOR record (e.g. More...

void	setRunNumber (unsigned int run)
	Overwrite run number from RunParams @params run New run number. More...

void	setSORtime_ns (unsigned long long sorTime_ns)
	Overwrite SOR time from RunParams @params sorTime_ns New start of run time in nanoseconds since epoch. More...

StatusCode	fillSOR (const EventContext &ctx) const
	Fill SOR record in Detector Store, reusing if present or creating new one otherwise/ @params ctx EventContext to be used for IOVDbSvc. More...

EventIDBase	eventID () const
	Create an EventIDBase filled with the value from rparams. More...

bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Member Functions
StatusCode createSOR	ATLAS_NOT_THREAD_SAFE () const

coral::AttributeList getAttrList	ATLAS_NOT_THREAD_SAFE () const

StatusCode	setIOVRange (IOVRange &iovRange) const

StatusCode	updateProxy (SOR *sor) const

void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
ServiceHandle< StoreGateSvc >	m_detStore

std::string	m_sorpath

const boost::property_tree::ptree &	m_rparams

unsigned int	m_runNumber {0}

unsigned long long	m_sorTime_ns {0}

std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Helper class for Start Of Run (SOR) record.

Author: Ricardo Abreu

Helper class to retrieve the Start Of Run parameters from the prepareForRun ptree and put them into the detector store with whole-run validity.

Definition at line 25 of file TrigSORFromPtreeHelper.h.

Member Typedef Documentation

◆ SOR

typedef CondAttrListCollection TrigSORFromPtreeHelper::SOR

Definition at line 27 of file TrigSORFromPtreeHelper.h.

Constructor & Destructor Documentation

◆ TrigSORFromPtreeHelper()

TrigSORFromPtreeHelper::TrigSORFromPtreeHelper	(	IMessageSvc *	msgSvc,
		const ServiceHandle< StoreGateSvc > &	detStore,
		const std::string &	sorpath,
		const boost::property_tree::ptree &	rparams
	)

Create the SOR helper @params msgSvc Pointer to MessageSvc @params detStore Handle to DetectorStore @params sorpath COOL folder path of SOR record (e.g.

/TDAQ/RunCtrl/SOR_Params) @params rparams RunParams record

Definition at line 23 of file TrigSORFromPtreeHelper.cxx.

                                                                      :
   AthMessaging(msgSvc, CLNAME),
   m_detStore(detStore),
   m_sorpath(sorpath),
   m_rparams(rparams)
 {
   // Set run number and timestamp from RunParams. Can be overwritten later.
   m_runNumber = rparams.get<unsigned int>("run_number");
  
   std::istringstream ss(rparams.get_child("timeSOR").data());
   std::tm t = {};
   t.tm_isdst = -1; // auto-detect daylight savings time
   unsigned int microseconds = 0;
  
   // Format: 08/05/24 22:14:38.000000 (see OWLTime in tdaq)
   ss >> std::get_time(&t, "%d/%m/%y %H:%M:%S.") >> microseconds;
   if (ss.fail()) {
     ATH_MSG_ERROR("Cannot parse timeSOR: " << ss.str());
   }
   m_sorTime_ns = std::mktime(&t)*std::nano::den + microseconds*1000;
 }

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/2]

StatusCode createSOR TrigSORFromPtreeHelper::ATLAS_NOT_THREAD_SAFE ( ) const

private

◆ ATLAS_NOT_THREAD_SAFE() [2/2]

coral::AttributeList getAttrList TrigSORFromPtreeHelper::ATLAS_NOT_THREAD_SAFE ( ) const

private

◆ eventID()

EventIDBase TrigSORFromPtreeHelper::eventID ( ) const

Create an EventIDBase filled with the value from rparams.

Definition at line 76 of file TrigSORFromPtreeHelper.cxx.

 {
   EventIDBase eid;
  
   // Set run and timestamp
   eid.set_run_number( m_runNumber );
   eid.set_time_stamp( m_sorTime_ns / (1000*1000*1000) );
   eid.set_time_stamp_ns_offset( m_sorTime_ns % (1000*1000*1000) );
  
   eid.set_lumi_block(0);  // our best guess as this is not part of RunParams
  
   return eid;
 }

◆ fillSOR()

StatusCode TrigSORFromPtreeHelper::fillSOR ( const EventContext & ctx ) const

Fill SOR record in Detector Store, reusing if present or creating new one otherwise/ @params ctx EventContext to be used for IOVDbSvc.

Definition at line 49 of file TrigSORFromPtreeHelper.cxx.

 {
   ATH_MSG_DEBUG("Setup SOR in DetectorStore");
  
   // get handle to the IOVDbSvc
   ServiceHandle<IIOVDbSvc> iovdbsvc("IOVDbSvc", CLNAME);
   if ((iovdbsvc.retrieve()).isFailure()) {
     ATH_MSG_ERROR("Could not find IOVDbSvc. Time dependent conditions data may be not properly handled.");
   } else {
     IOVTime currentIOVTime(ctx.eventID());
     // Signal BeginRun directly to IOVDbSvc to set complete IOV start time
     if ( iovdbsvc->signalBeginRun(currentIOVTime, ctx).isFailure() ) {
       ATH_MSG_ERROR("Unable to signal begin run IOVTime to IOVDbSvc. IOVTime = " << currentIOVTime);
     } else {
       ATH_MSG_DEBUG("Set start of run time to IOVTime = " << currentIOVTime);
     }
   }
  
   // createSOR marked unsafe due to copying/deletion of coral::AttributeList
   // objects.  There's no sharing of specificiations, though, so it's ok.
   StatusCode sc ATLAS_THREAD_SAFE = createSOR();
   ATH_CHECK( sc );
  
   return StatusCode::SUCCESS;
 }

◆ 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();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ 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 164 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 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ 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_initialized.test_and_set()) initMessaging();
   if (m_lvl <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ setIOVRange()

StatusCode TrigSORFromPtreeHelper::setIOVRange ( IOVRange & iovRange ) const

private

Definition at line 165 of file TrigSORFromPtreeHelper.cxx.

 {
   // set IOVRange on the IOVSvc
   ServiceHandle<IIOVSvc> iovsvc("IOVSvc", CLNAME);
   ATH_CHECK( iovsvc.retrieve() );
  
   auto clid = ClassID_traits<SOR>::ID();
   ATH_CHECK( iovsvc->setRange(clid, m_sorpath, iovRange, "StoreGateSvc") );
  
   return StatusCode::SUCCESS;
 }

◆ 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;
 }

◆ setRunNumber()

void TrigSORFromPtreeHelper::setRunNumber ( unsigned int run )

inline

Overwrite run number from RunParams @params run New run number.

Definition at line 43 of file TrigSORFromPtreeHelper.h.

43 { m_runNumber = run; }

◆ setSORtime_ns()

void TrigSORFromPtreeHelper::setSORtime_ns ( unsigned long long sorTime_ns )

inline

Overwrite SOR time from RunParams @params sorTime_ns New start of run time in nanoseconds since epoch.

Definition at line 49 of file TrigSORFromPtreeHelper.h.

49 { m_sorTime_ns = sorTime_ns; }

◆ updateProxy()

StatusCode TrigSORFromPtreeHelper::updateProxy ( SOR * sor ) const

private

Definition at line 178 of file TrigSORFromPtreeHelper.cxx.

 {
   // check the SOR_Params proxy and add if necessary an IAddressProvider (typically for MC)
   auto proxy = m_detStore->proxy(sor);
   if (!proxy) {
     ATH_MSG_ERROR("Could not find proxy for SOR_Params folder.");
     return StatusCode::FAILURE;
   }
  
   // check if the transient address has an IAddressProvider, if not set IOVDbSvc as provider
   if (!proxy->provider()) {
     // get handle to the IOVDbSvc
     ServiceHandle<IIOVDbSvc> iovdbsvc("IOVDbSvc", CLNAME);
     ATH_CHECK( iovdbsvc.retrieve() );
  
     IAddressProvider* provider = dynamic_cast<IAddressProvider*>(&*iovdbsvc);
     if (!provider) {
       ATH_MSG_ERROR("Could not cast to IAddressProvider interface and set the provider for SOR_Params.");
       return StatusCode::FAILURE;
     }
     proxy->setProvider(provider, proxy->storeID());
   }
  
   return StatusCode::SUCCESS;
 }

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_detStore

ServiceHandle<StoreGateSvc> TrigSORFromPtreeHelper::m_detStore

private

Definition at line 68 of file TrigSORFromPtreeHelper.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.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_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_rparams

const boost::property_tree::ptree& TrigSORFromPtreeHelper::m_rparams

private

Definition at line 70 of file TrigSORFromPtreeHelper.h.

◆ m_runNumber

unsigned int TrigSORFromPtreeHelper::m_runNumber {0}

private

Definition at line 71 of file TrigSORFromPtreeHelper.h.

◆ m_sorpath

std::string TrigSORFromPtreeHelper::m_sorpath

private

Definition at line 69 of file TrigSORFromPtreeHelper.h.

◆ m_sorTime_ns

unsigned long long TrigSORFromPtreeHelper::m_sorTime_ns {0}

private

Definition at line 72 of file TrigSORFromPtreeHelper.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ SOR

Constructor & Destructor Documentation

◆ TrigSORFromPtreeHelper()

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/2]

◆ ATLAS_NOT_THREAD_SAFE() [2/2]

◆ eventID()

◆ fillSOR()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ setIOVRange()

◆ setLevel()

◆ setRunNumber()

◆ setSORtime_ns()

◆ updateProxy()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_detStore

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_rparams

◆ m_runNumber

◆ m_sorpath

◆ m_sorTime_ns