#include <TrigSerTPTool.h>

Inheritance diagram for TrigSerTPTool:

Public Member Functions
	TrigSerTPTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard AlgTool constructor.
virtual StatusCode	initialize () override
	Function initialising the tool.
void *	convertTP (const std::string &transName, void *trans, std::string &persName) const
	Convert a transient object to its persistent self.
void *	convertPT (const std::string &persName, void *pers, std::string &transName) const
	Convert a persistent object to its transient self.
const std::string &	persClassName (const std::string &transClassName) const
	Get the name of the persistent class belonging to a transient one.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Declare the interface provided by the tool.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
TClass *	getClass (const std::string &clname) const
	Get the ROOT dictionary for a type.
ITPCnvBase *	getConverter (const std::string &persistent) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
CxxUtils::ClassName::Rules	m_clNameRules
std::unique_ptr< MsgStream >	m_logTP
std::map< std::string, std::string >	m_TPmap
std::vector< std::string >	m_activeClasses
ServiceHandle< IMessageSvc >	m_msgsvcTP
ServiceHandle< IDictLoaderSvc >	m_dictSvc
bool	m_useAthDictLoader
bool	m_online
ServiceHandle< ITPCnvSvc >	m_tpcnvsvc
std::mutex	m_convertersCacheMutex
std::map< std::string, ITPCnvBase * > m_convertesCache	ATLAS_THREAD_SAFE
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Author: Jiri Masik Jiri..nosp@m.Masi.nosp@m.k@cer.nosp@m.n.ch based on the code of AthenaROOTAccess by Scott Snyder

Definition at line 32 of file TrigSerTPTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TrigSerTPTool()

TrigSerTPTool::TrigSerTPTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard AlgTool constructor.

Definition at line 21 of file TrigSerTPTool.cxx.

                                                        :
   AthAlgTool( type, name, parent ),
   m_msgsvcTP( "", name ),
   m_dictSvc( "AthDictLoaderSvc", name ),
   m_useAthDictLoader( true ),
   m_online( false ),
   m_tpcnvsvc( "AthTPCnvSvc", name ) {
 
   declareInterface< TrigSerTPTool >( this );
 
   declareProperty( "TPMap", m_TPmap, "map of T->P classes" );
   declareProperty( "ActiveClasses", m_activeClasses,
                    "allows to skip classes not relevant in the current "
                    "trigger level" );
   declareProperty( "debuggingMsgSvc", m_msgsvcTP,
                    "an instance of the messageSvc for debugging purposes" );
   declareProperty( "onlineMode", m_online,
                    "simpler setup for running online" );
   declareProperty( "useAthDictLoader", m_useAthDictLoader,
                    "use AthDictLoaderSvc instead of plain ROOT" );
}

Member Function Documentation

◆ convertPT()

void * TrigSerTPTool::convertPT	(	const std::string &	persName,
		void *	pers,
		std::string &	transName ) const

Convert a persistent object to its transient self.

Definition at line 166 of file TrigSerTPTool.cxx.

{
   // First look for a trigger specific converter:
   ITPCnvBase* cnvtr =
      m_tpcnvsvc->p2t_cnv( persName, Athena::TPCnvType::Trigger );
   if( ! cnvtr ) {
      // If there is no such thing, try a generic one:
      cnvtr = m_tpcnvsvc->p2t_cnv( persName );
   }
   if( ! cnvtr ) {
      REPORT_MESSAGE( MSG::ERROR )
         << "T/P Converter for persistent class "
         << persName << " could not be retrieved";
      return 0;
   }
 
   // Get the name of the transient class:
   transName = m_clNameRules.apply( System::typeinfoName( cnvtr->transientTInfo() ) );
 
   // Create the transient object:
   TClass *transCl = getClass( transName );
   void *trans( 0 );
   if( transCl ){
      trans = transCl->New();
      ATH_MSG_DEBUG( "trans  " << trans );
   }
 
   // Do the conversion:
   ATH_MSG_DEBUG( "invoking PT for " << transName );
   try {
      cnvtr->persToTransWithKeyUntyped( pers, trans, "", m_logTP ? *m_logTP : msg() );
      ATH_MSG_DEBUG( " succeeded at " << trans );
   }
   catch (const std::runtime_error& e){
      REPORT_MESSAGE( MSG::ERROR ) << "An exception occurred: " << e.what();
      //it should destruct trans here (is it in a good state?)
      trans = 0;
   }
 
   // Return the converted object:
   return trans;
}

◆ convertTP()

void * TrigSerTPTool::convertTP	(	const std::string &	transName,
		void *	trans,
		std::string &	persName ) const

Convert a transient object to its persistent self.

Definition at line 101 of file TrigSerTPTool.cxx.

{
   ATH_MSG_DEBUG( "TrigSerTPTool::convertTP" );
 
   //pers and persName set only after successful conversion
   persName = "";
   void *pers( 0 );
 
   // Start by trying to find the correct persistent class from the TP map
   // Otherwise, use the internal logic of the TPCnvSvc
   const auto tpItr = m_TPmap.find( clname );
   if( tpItr == m_TPmap.end() ) {
      REPORT_MESSAGE( MSG::ERROR )
         << "Transient class " << clname 
         << " is not in the T/P Converter map";
      return 0;
   }
   persName = tpItr->second;
 
   ITPCnvBase* cnvtr = getConverter( persName );
   if( ! cnvtr ) {
      ATH_MSG_ERROR( "T/P Converter for transient class " << tpItr->first
                     << " persistent class " << persName << " could not be retrieved");
      return nullptr;
   }
 
   // Create a persistent object:
   const std::string persname =
      m_clNameRules.apply( System::typeinfoName( cnvtr->persistentTInfo() ) );
   TClass *persObjCl = getClass( persname );
   void *persptr( 0 );
   if( persObjCl ) {
      persptr = persObjCl->New();
      ATH_MSG_DEBUG( "created object of " << persptr << " at " << persptr  );
   } else {
      REPORT_MESSAGE( MSG::ERROR )
         << "Couldn't find dictionary for type " << persname;
      return 0;
   }
 
   // Do the conversion:
   ATH_MSG_DEBUG( "invoking TP for " << clname  << " at " << ptr );
   try {
      cnvtr->transToPersUntyped( ptr, persptr, m_logTP ? *m_logTP : msg() );
      persName = std::move(persname);
      pers = persptr;
      ATH_MSG_DEBUG( "succeeded at " << persptr  );
   }
   catch( const std::runtime_error& e ){
 
      //delete persObjCl->New();
      const std::string issue = e.what();
      if( issue.find( "is deprecated" ) != std::string::npos ) {
         ATH_MSG_INFO( "An exception " << e.what() );
      } else {
         pers = 0;
         REPORT_MESSAGE( MSG::ERROR ) << "An exception occurred: " << e.what();
      }
   }
 
   // Return the converted object:
   return pers;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getClass()

TClass * TrigSerTPTool::getClass ( const std::string & clname ) const

private

Get the ROOT dictionary for a type.

Definition at line 227 of file TrigSerTPTool.cxx.

                                                              {
 
   TClass *cl( 0 );
   if( m_useAthDictLoader && m_dictSvc ){
      m_dictSvc->load_type( cname );
   }
   cl = TClass::GetClass( cname.c_str() );
   return cl;
}

◆ getConverter()

ITPCnvBase * TrigSerTPTool::getConverter ( const std::string & persistent ) const

private

Definition at line 84 of file TrigSerTPTool.cxx.

{
   std::lock_guard<std::mutex> lock(m_convertersCacheMutex);
   ITPCnvBase* cnvtr = m_convertesCache[persistent];
   if ( ATH_LIKELY( cnvtr ) )
      return cnvtr;
 
   // no converter, we need to find it, first the trigger specific one
   cnvtr = m_tpcnvsvc->p2t_cnv( persistent, Athena::TPCnvType::Trigger );
   if( ! cnvtr ) {
      // If there is no such thing, try a generic one:
      cnvtr = m_tpcnvsvc->p2t_cnv( persistent );
   }
   m_convertesCache[persistent] = cnvtr;
   return cnvtr;
}

◆ initialize()

StatusCode TrigSerTPTool::initialize ( )

overridevirtual

Function initialising the tool.

Definition at line 45 of file TrigSerTPTool.cxx.

                                    {
 
   // Greet the user:
   ATH_MSG_INFO( "Initializing" );
 
   // Retrieve a custom message service:
   if( ! m_msgsvcTP.empty() ) {
      if( m_msgsvcTP.retrieve().isFailure() ) {
         ATH_MSG_INFO( "Could not retrieve a separate MsgSvc for "
                       "the T/P debugging" );
      } else {
         ATH_MSG_DEBUG( "Using " << m_msgsvcTP << " for debugging" );
         IMessageSvc* msvc = m_msgsvcTP.operator->();
         m_logTP = std::make_unique< MsgStream >( msvc,
                                                  "TrigSerTPTool-T/P" );
      }
   }
 
   // Retrieve the used services:
   ATH_CHECK( m_dictSvc.retrieve() );
   ATH_CHECK( m_tpcnvsvc.retrieve() );
 
   /* When a P<->T conversion is requested, this tool makes a call to TClass::GetClass.
    * The way it's done here can cause performance issues in some circumstances.
    * For example, reading data16 RAW files trigger a P->T conversion from
    * DataVector<xAOD::TauJet_v2> to DataVector<xAOD::TauJet_v3> in RAWtoALL/22.0.62.
    * The problem is that the converter returns the full class name through
    * ITPCnvBase::transientTInfo(), which in this case resolves into
    * DataVector<xAOD::TauJet_v3,DataVector<xAOD::IParticle,DataModel_detail::NoBase> >
    * Passing this directly to TClass::GetClass causes AutoLoading/HeaderParsing
    * which notoriously allocates memory and never releases it. Here, we work
    * around this problem by stripping the base class information from the name
    * that's passed to TClass::GetClass, in this case simply DataVector<xAOD::TauJet_v3>
    */
   m_clNameRules.add("DataVector<$T, $B>", "DataVector<$T>");
 
   return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & TrigSerTPTool::interfaceID ( )

inlinestatic

Declare the interface provided by the tool.

Definition at line 36 of file TrigSerTPTool.h.

                                            {
      static const InterfaceID
         IID_TrigSerTPTool("TrigSerTPTool", 1, 0);
      return IID_TrigSerTPTool;
   }

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ persClassName()

const std::string & TrigSerTPTool::persClassName ( const std::string & transClassName ) const

Get the name of the persistent class belonging to a transient one.

Definition at line 211 of file TrigSerTPTool.cxx.

                                                                    {
 
   // Try to extract from the TP map
   const auto tpItr = m_TPmap.find( transClassName );
   if( tpItr == m_TPmap.end() ) {
      REPORT_MESSAGE( MSG::ERROR )
         << "Transient class " << transClassName
         << " is not in the T/P Converter map";
      static const std::string dummy( "" );
      return dummy;
   }
 
   // Return the persistent class name:
   return tpItr->second;
}

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::map<std::string, ITPCnvBase*> m_convertesCache TrigSerTPTool::ATLAS_THREAD_SAFE

mutableprivate

Definition at line 73 of file TrigSerTPTool.h.

◆ m_activeClasses

std::vector< std::string > TrigSerTPTool::m_activeClasses

private

Definition at line 66 of file TrigSerTPTool.h.

◆ m_clNameRules

CxxUtils::ClassName::Rules TrigSerTPTool::m_clNameRules

private

Definition at line 62 of file TrigSerTPTool.h.

◆ m_convertersCacheMutex

std::mutex TrigSerTPTool::m_convertersCacheMutex

mutableprivate

Definition at line 72 of file TrigSerTPTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_dictSvc

ServiceHandle< IDictLoaderSvc > TrigSerTPTool::m_dictSvc

private

Definition at line 68 of file TrigSerTPTool.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_logTP

std::unique_ptr< MsgStream > TrigSerTPTool::m_logTP

private

Definition at line 64 of file TrigSerTPTool.h.

◆ m_msgsvcTP

ServiceHandle< IMessageSvc > TrigSerTPTool::m_msgsvcTP

private

Definition at line 67 of file TrigSerTPTool.h.

◆ m_online

bool TrigSerTPTool::m_online

private

Definition at line 70 of file TrigSerTPTool.h.

◆ m_tpcnvsvc

ServiceHandle< ITPCnvSvc > TrigSerTPTool::m_tpcnvsvc

private

Definition at line 71 of file TrigSerTPTool.h.

◆ m_TPmap

std::map< std::string, std::string > TrigSerTPTool::m_TPmap

private

Definition at line 65 of file TrigSerTPTool.h.

◆ m_useAthDictLoader

bool TrigSerTPTool::m_useAthDictLoader

private

Definition at line 69 of file TrigSerTPTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TrigSerTPTool()

Member Function Documentation

◆ convertPT()

◆ convertTP()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getClass()

◆ getConverter()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ persClassName()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_activeClasses

◆ m_clNameRules

◆ m_convertersCacheMutex

◆ m_detStore

◆ m_dictSvc

◆ m_evtStore

◆ m_logTP

◆ m_msgsvcTP

◆ m_online

◆ m_tpcnvsvc

◆ m_TPmap

◆ m_useAthDictLoader

◆ m_varHandleArraysDeclared

◆ m_vhka