This templated class provides the converter to translate an object to/from its persistent POOL representation. More...

#include <T_AthenaPoolCnvBase.h>

Inheritance diagram for T_AthenaPoolCnvBase< T >:

Collaboration diagram for T_AthenaPoolCnvBase< T >:

Public Member Functions
	T_AthenaPoolCnvBase (ISvcLocator svcloc, const char name=nullptr)
	Constructor.
virtual StatusCode	finalize () override
virtual long	repSvcType () const override
virtual StatusCode	createObj (IOpaqueAddress pAddr, DataObject &pObj) override
	Create a transient object from a POOL persistent representation.
virtual StatusCode	createRep (DataObject pObj, IOpaqueAddress &pAddr) override
	Create a POOL persistent representation for a transient object.
virtual StatusCode	fillRepRefs (IOpaqueAddress pAddr, DataObject pObj) override
	Create a POOL persistent representation for a transient object.
const ServiceHandle< StoreGateSvc > &	detStore () const
	Handle to DetectorStore.
virtual StatusCode	cleanUp (const std::string &output) override
	Implement cleanUp for AthenaPoolConverter to do nothing.
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.

Static Public Member Functions
static CLID	classID ()
static long	storageType ()

Protected Types
typedef std::mutex	CallMutex

Protected Member Functions
virtual StatusCode	initialize ()
	Gaudi Service Interface method implementations:
virtual StatusCode	DataObjectToPool (IOpaqueAddress pAddr, DataObject pObj)
	Write an object into POOL.
virtual StatusCode	PoolToDataObject (DataObject &pObj, const Token token, const std::string &key)
	Read an object from POOL.
virtual Placement	setPlacement (const std::string &key, const std::string &output)
	Set POOL placement.
virtual Placement	setPlacementWithType (const std::string &tname, const std::string &key, const std::string &output)
	Set POOL placement hint for a given type.
bool	compareClassGuid (const Token *token, const Guid &guid) const

Protected Attributes
RootType	m_classDesc
ServiceHandle< StoreGateSvc >	m_detStore
ServiceHandle< IAthenaPoolCnvSvc >	m_athenaPoolCnvSvc
CallMutex	m_conv_mut

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).

Detailed Description

template<class T>
class T_AthenaPoolCnvBase< T >

This templated class provides the converter to translate an object to/from its persistent POOL representation.

After reading, we also call SG::ToTransient<T>::toTransient (without an EventContext) on the object we read.

Definition at line 28 of file T_AthenaPoolCnvBase.h.

Member Typedef Documentation

◆ CallMutex

typedef std::mutex AthenaPoolConverter::CallMutex

protectedinherited

Definition at line 110 of file AthenaPoolConverter.h.

Constructor & Destructor Documentation

◆ T_AthenaPoolCnvBase()

template<class T>

T_AthenaPoolCnvBase< T >::T_AthenaPoolCnvBase	(	ISvcLocator *	svcloc,
		const char *	name = nullptr )

Constructor.

Member Function Documentation

◆ classID()

template<class T>

CLID T_AthenaPoolCnvBase< T >::classID ( )

static

Returns: class ID.

◆ cleanUp()

StatusCode AthenaPoolConverter::cleanUp ( const std::string & output )

overridevirtualinherited

Implement cleanUp for AthenaPoolConverter to do nothing.

Implements IAthenaPoolCleanUp.

Definition at line 220 of file AthenaPoolConverter.cxx.

                                                          {
   ATH_MSG_DEBUG("AthenaPoolConverter cleanUp called for base class.");
   return StatusCode::SUCCESS;
}

◆ compareClassGuid()

bool AthenaPoolConverter::compareClassGuid	(	const Token *	token,
		const Guid &	guid ) const

protectedinherited

Definition at line 216 of file AthenaPoolConverter.cxx.

                                                                                     {
   return(token ? (guid == token->classID()) : false);
}

◆ createObj()

StatusCode AthenaPoolConverter::createObj	(	IOpaqueAddress *	pAddr,
		DataObject *&	pObj )

overridevirtualinherited

Create a transient object from a POOL persistent representation.

Parameters

pAddr	[IN] IOpaqueAddress of POOL persistent representation.
pObj	[OUT] pointer to the transient object.

Definition at line 52 of file AthenaPoolConverter.cxx.

                                                                                  {
   TokenAddress* tokAddr = dynamic_cast<TokenAddress*>(pAddr);
   
   bool ownTokAddr = false;
   if (tokAddr == nullptr || tokAddr->getToken() == nullptr) {
      ownTokAddr = true;
      auto token = std::make_unique<Token>();
      token->fromString(*(pAddr->par()));
      GenericAddress* genAddr = dynamic_cast<GenericAddress*>(pAddr);
      if (not genAddr){
        ATH_MSG_ERROR("Dynamic cast failed in AthenaPoolConverter::createObj");
        //clean up
        return StatusCode::FAILURE;
      }
      tokAddr = new TokenAddress(*genAddr, std::move(token));
   }
   if( tokAddr->ipar()[0] > 0 and tokAddr->getToken()->auxString().empty() ) {
      tokAddr->getToken()->setAuxString(CxxUtils::HexString<"[CTXT={}]">(static_cast<int>(*(pAddr->ipar()))));
   }
   ATH_MSG_VERBOSE("createObj: " << tokAddr->getToken()->toString() << ", CTX=" << tokAddr->ipar()[0]
                   << ", auxStr=" << tokAddr->getToken()->auxString() );
   try {
      std::string key = pAddr->par()[1];
      if (!PoolToDataObject(pObj, tokAddr->getToken(), key).isSuccess()) {
         ATH_MSG_ERROR("createObj PoolToDataObject() failed, Token = " << (tokAddr->getToken() ? tokAddr->getToken()->toString() : "NULL"));
         pObj = nullptr;
      }
   } catch (std::exception& e) {
      ATH_MSG_ERROR("createObj - caught exception: " << e.what());
      pObj = nullptr;
   }
   if (pObj == nullptr) {
      ATH_MSG_ERROR("createObj failed to get DataObject, Token = " << (tokAddr->getToken() ? tokAddr->getToken()->toString() : "NULL"));
   }
   if (ownTokAddr) {
      delete tokAddr; tokAddr = nullptr;
   }
   if (pObj == nullptr) {
      return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
}

◆ createRep()

StatusCode AthenaPoolConverter::createRep	(	DataObject *	pObj,
		IOpaqueAddress *&	pAddr )

overridevirtualinherited

Create a POOL persistent representation for a transient object.

Parameters

pObj	[IN] pointer to the transient object.
pAddr	[OUT] IOpaqueAddress of POOL persistent representation.

Definition at line 95 of file AthenaPoolConverter.cxx.

                                                                                  {
   const SG::DataProxy* proxy = dynamic_cast<SG::DataProxy*>(pObj->registry());
   if (proxy == nullptr) {
      ATH_MSG_ERROR("AthenaPoolConverter CreateRep failed to cast DataProxy, key = " << pObj->name());
      return StatusCode::FAILURE;
   }
   const CLID clid = proxy->clID();
   if (pAddr == nullptr) {
      // Create a IOpaqueAddress for this object.
      pAddr = new TokenAddress(this->storageType(), clid, "", "", 0, 0);
   } else {
      GenericAddress* gAddr = dynamic_cast<GenericAddress*>(pAddr);
      if (gAddr != nullptr) {
         gAddr->setSvcType(this->storageType());
      }
   }
   return StatusCode::SUCCESS;
}

◆ DataObjectToPool()

template<class T>

virtual StatusCode T_AthenaPoolCnvBase< T >::DataObjectToPool	(	IOpaqueAddress *	pAddr,
		DataObject *	pObj )

protectedvirtual

Write an object into POOL.

Parameters

pObj	[IN] pointer to the transient object.

Implements AthenaPoolConverter.

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthenaPoolConverter::detStore ( ) const

inlineinherited

Handle to DetectorStore.

Definition at line 68 of file AthenaPoolConverter.h.

68{ return m_detStore; }

AthenaPoolConverter::m_detStore

ServiceHandle< StoreGateSvc > m_detStore

Definition AthenaPoolConverter.h:107

◆ fillRepRefs()

StatusCode AthenaPoolConverter::fillRepRefs	(	IOpaqueAddress *	pAddr,
		DataObject *	pObj )

overridevirtualinherited

Create a POOL persistent representation for a transient object.

Parameters

pAddr	[IN] IOpaqueAddress of POOL persistent representation.
pObj	[IN] pointer to the transient object.

Definition at line 114 of file AthenaPoolConverter.cxx.

                                                                                   {
   try {
      if (!DataObjectToPool(pAddr, pObj).isSuccess()) {
         ATH_MSG_ERROR("FillRepRefs failed, key = " << pObj->name());
         return StatusCode::FAILURE;
      }
   } catch (std::exception& e) {
      ATH_MSG_ERROR("fillRepRefs - caught exception: " << e.what());
      return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode AthenaPoolConverter::finalize ( )

overridevirtualinherited

Definition at line 40 of file AthenaPoolConverter.cxx.

                                         {
   // Release AthenaPoolCnvSvc
   if (!m_athenaPoolCnvSvc.release().isSuccess()) {
      ATH_MSG_WARNING("Cannot release AthenaPoolCnvSvc.");
   }
   return(::Converter::finalize());
}

◆ initialize()

template<class T>

virtual StatusCode T_AthenaPoolCnvBase< T >::initialize ( )

protectedvirtual

Gaudi Service Interface method implementations:

Reimplemented from AthenaPoolConverter.

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

◆ 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 167 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 182 of file AthMessaging.h.

183{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:167

◆ 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 user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ PoolToDataObject()

template<class T>

virtual StatusCode T_AthenaPoolCnvBase< T >::PoolToDataObject	(	DataObject *&	pObj,
		const Token *	token,
		const std::string &	key )

protectedvirtual

Read an object from POOL.

Parameters

pObj	[OUT] pointer to the transient object.
token	[IN] POOL token of the persistent representation.
key	[IN] SG key of the object being read.

Implements AthenaPoolConverter.

◆ repSvcType()

long AthenaPoolConverter::repSvcType ( ) const

overridevirtualinherited

Definition at line 48 of file AthenaPoolConverter.cxx.

                                           {
   return pool::POOL_StorageType.type();
}

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

◆ setPlacement()

template<class T>

virtual Placement T_AthenaPoolCnvBase< T >::setPlacement	(	const std::string &	key,
		const std::string &	output )

protectedvirtual

Set POOL placement.

Implements AthenaPoolConverter.

◆ setPlacementWithType()

Placement AthenaPoolConverter::setPlacementWithType	(	const std::string &	tname,
		const std::string &	key,
		const std::string &	output )

protectedvirtualinherited

Set POOL placement hint for a given type.

Parameters

tname	[IN] type name.
key	[IN] SG key.

Definition at line 140 of file AthenaPoolConverter.cxx.

                                                                                                                         {
   // Resulting placement
   Placement placement;
 
   // Extract the file name and global technology (if available)
   std::string::size_type pos1 = output.find('[');
   std::string outputConnectionSpec = output.substr(0, pos1);
   placement.setFileName(outputConnectionSpec);
 
   // Override streaming parameters from StreamTool if requested.
   std::string containerPrefix{APRDefaults::WriteConfig::getEventDataName()};
   std::string dhContainerPrefix{APRDefaults::WriteConfig::getDataHeaderName()};
   std::string containerName{""};
   std::string containerNameHint{""};
   std::string branchNameHint{""};
   std::string containerFriendPostfix{""};
   while (pos1 != std::string::npos) {
      const std::string::size_type pos2 = output.find('=', pos1);
      const std::string thisKey = output.substr(pos1 + 1, pos2 - pos1 - 1);
      const std::string::size_type pos3 = output.find(']', pos2);
      const std::string value = output.substr(pos2 + 1, pos3 - pos2 - 1);
      if (thisKey == "OutputCollection") {
         dhContainerPrefix = std::move(value);
      } else if (thisKey == "PoolContainerPrefix") {
         containerPrefix = std::move(value);
      } else if (thisKey == "TopLevelContainerName") {
        containerNameHint = std::move(value);
      } else if (thisKey == "SubLevelBranchName") {
         branchNameHint = std::move(value);
      } else if (thisKey == "PoolContainerFriendPostfix") {
         containerFriendPostfix = std::move(value);
      }
      pos1 = output.find('[', pos3);
   }
 
   // Extract the technology from the container prefix (if available)
   if (auto colonPost = containerPrefix.find(':'); colonPost != std::string::npos) {
      placement.setTechnology(pool::DbType::getType(containerPrefix.substr(0, colonPost)).type());
      containerPrefix.erase(0, colonPost + 1); // Note that DataHeader and EventTag bypass this...
   }
 
   // ---  Special types:   DataHeader & Form
   if ( tname.starts_with(APRDefaults::DataHeaderTypeName) ) {
      containerName = std::format("{}{}({}{})",
         dhContainerPrefix,
         tname.starts_with(APRDefaults::DataHeaderFormTypeName) ? "Form" : "",
         key.back() == '/' ? key : "",
         tname);
   }
   // AttributeList - writing attributes separately to EventTag container group
   else if ( tname.starts_with(APRDefaults::EventTagTypeName) ) {
      containerName = std::format("{}({})",
         APRDefaults::WriteConfig::getEventTagName(),
         key);
   }
   // all other object types
   else {
      constexpr std::string_view typeTok = "<type>", keyTok = "<key>";
      containerName = std::format("{}{}{}{}",
                           containerPrefix,
                           containerFriendPostfix,
                           containerNameHint,
                           branchNameHint.empty() ? "" : std::format("({})", branchNameHint));
      if (auto pos = containerName.find(typeTok); pos != std::string::npos) {
         containerName.replace(pos, typeTok.size(), tname);
      }
      if (auto pos = containerName.find(keyTok); pos != std::string::npos) {
         containerName.replace(pos, keyTok.size(), key.empty() ? tname : key);
      }
   }
 
   // Set the container name
   placement.setContainerName(containerName);
   return(placement);
}

◆ storageType()

long AthenaPoolConverter::storageType ( )

staticinherited

Returns: storage type.

Definition at line 127 of file AthenaPoolConverter.cxx.

                                      {
   return pool::POOL_StorageType.type();
}

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_athenaPoolCnvSvc

ServiceHandle<IAthenaPoolCnvSvc> AthenaPoolConverter::m_athenaPoolCnvSvc

protectedinherited

Definition at line 108 of file AthenaPoolConverter.h.

◆ m_classDesc

template<class T>

RootType T_AthenaPoolCnvBase< T >::m_classDesc

protected

Definition at line 58 of file T_AthenaPoolCnvBase.h.

◆ m_conv_mut

CallMutex AthenaPoolConverter::m_conv_mut

protectedinherited

Definition at line 111 of file AthenaPoolConverter.h.

◆ m_detStore

ServiceHandle<StoreGateSvc> AthenaPoolConverter::m_detStore

protectedinherited

Definition at line 107 of file AthenaPoolConverter.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ 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_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.

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

T_AthenaPoolCnvBase.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CallMutex

Constructor & Destructor Documentation

◆ T_AthenaPoolCnvBase()

Member Function Documentation

◆ classID()

◆ cleanUp()

◆ compareClassGuid()

◆ createObj()

◆ createRep()

◆ DataObjectToPool()

◆ detStore()

◆ fillRepRefs()

◆ finalize()

◆ initialize()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ PoolToDataObject()

◆ repSvcType()

◆ setLevel()

◆ setPlacement()

◆ setPlacementWithType()

◆ storageType()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_athenaPoolCnvSvc

◆ m_classDesc

◆ m_conv_mut

◆ m_detStore

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm