IAthMetaDataSvc Class Reference

This class provides the interface for MetaDataSvc. More...

#include <IAthMetaDataSvc.h>

Inheritance diagram for IAthMetaDataSvc:

Collaboration diagram for IAthMetaDataSvc:

Public Member Functions
	DeclareInterfaceID (IAthMetaDataSvc, 1, 0)
virtual StatusCode	shmProxy (const std::string &filename)=0
	used by AthenaPoolCnvSvc More...
virtual std::set< std::string >	getPerStreamKeysFor (const std::string &key) const
	Get all per-stream Key variants created for in-file metadata object with original key - if none, return key. More...
template<typename T , class TKEY >
T *	tryRetrieve (const TKEY &key) const
	Retrieve an object of type T from MetaDataStore Return 0 if not found. More...
template<typename T , class TKEY >
const T *	tryConstRetrieve (const TKEY &key) const
template<typename T , typename TKEY >
StatusCode	record (T *p2BRegistered, const TKEY &key)
	Record an object with a key. More...
template<typename T , typename TKEY >
StatusCode	record (std::unique_ptr< T > pUnique, const TKEY &key)
	Record an object with a key, take ownership of the unique_ptr obj. More...
template<typename T , typename TKEY >
StatusCode	remove (const TKEY &key, bool ignoreIfAbsent=false)
	Remove object with this type+key. More...
template<typename T , typename TKEY >
bool	contains (const TKEY &key)
	Check if object is already is already in store. More...
virtual StoreGateSvc *	outputDataStore () const =0
	The output MetaData Store. More...
virtual const std::string	currentRangeID () const =0
	rangeID for the current EventContext - used to index MetaContainers - More...
virtual void	recordHook (const std::type_info &)
	Hook for implementation to react to recording an object. More...
virtual void	removeHook (const std::type_info &)
	Hook for implementation to react to removing an object. More...

Private Attributes
std::mutex	m_mutex

Detailed Description

This class provides the interface for MetaDataSvc.

Note that Gaudi has an IMetaDataSvc, so we don't want to use that name.

Definition at line 28 of file IAthMetaDataSvc.h.

Member Function Documentation

contains()

template<typename T , typename TKEY >

bool IAthMetaDataSvc::contains

(

const TKEY &

key

)

Check if object is already is already in store.

Definition at line 155 of file IAthMetaDataSvc.h.

                                              {
  if (!outputDataStore()->contains< MetaCont<T> >(key))
    return false;
  const MetaCont<T>* container =
      outputDataStore()->tryConstRetrieve< MetaCont<T> >(key);
  return container && container->valid(currentRangeID());
}

currentRangeID()

virtual const std::string IAthMetaDataSvc::currentRangeID ( ) const

pure virtual

rangeID for the current EventContext - used to index MetaContainers -

DeclareInterfaceID()

IAthMetaDataSvc::DeclareInterfaceID	(	IAthMetaDataSvc	,
		1	,
		0
	)

getPerStreamKeysFor()

std::set< std::string > IAthMetaDataSvc::getPerStreamKeysFor ( const std::string &  key ) const

inlinevirtual

Get all per-stream Key variants created for in-file metadata object with original key - if none, return key.

default implementation that maps a key to itself - overwritten in MetaDataSvc

Definition at line 82 of file IAthMetaDataSvc.h.

                                                                {
   return std::set<std::string>( {key} );
}

outputDataStore()

virtual StoreGateSvc* IAthMetaDataSvc::outputDataStore ( ) const

pure virtual

The output MetaData Store.

record() [1/2]

template<typename T , typename TKEY >

StatusCode IAthMetaDataSvc::record	(	std::unique_ptr< T >	pUnique,
		const TKEY &	key
	)

Record an object with a key, take ownership of the unique_ptr obj.

Definition at line 130 of file IAthMetaDataSvc.h.

{
   if( this->record( pUnique.get(), key ).isSuccess() ) {
      (void)pUnique.release();
      return StatusCode::SUCCESS;
   }
   pUnique.reset();
   return StatusCode::FAILURE;
}

record() [2/2]

template<typename T , typename TKEY >

StatusCode IAthMetaDataSvc::record	(	T *	p2BRegistered,
		const TKEY &	key
	)

Record an object with a key.

Definition at line 112 of file IAthMetaDataSvc.h.

{
   std::lock_guard lock(m_mutex);
   MetaCont<T>* container = outputDataStore()->tryRetrieve< MetaCont<T> >(key);
   StatusCode sc = StatusCode::FAILURE;
   if( !container ) {
      auto cont_uptr = std::make_unique< MetaCont<T> >();
      if( cont_uptr->insert( currentRangeID() , pObject) )
         sc = outputDataStore()->record( std::move(cont_uptr), key );
   } else {
      if (container->insert(currentRangeID(), pObject)) sc = StatusCode::SUCCESS;
   }
   if (sc.isSuccess()) recordHook(typeid(T));
   return sc;
}

recordHook()

virtual void IAthMetaDataSvc::recordHook ( const std::type_info &  )

inlinevirtual

Hook for implementation to react to recording an object.

Definition at line 70 of file IAthMetaDataSvc.h.

{}

remove()

template<typename T , class TKEY >

StatusCode IAthMetaDataSvc::remove	(	const TKEY &	key,
		bool	ignoreIfAbsent = false
	)

Remove object with this type+key.

Definition at line 142 of file IAthMetaDataSvc.h.

{
   std::lock_guard lock(m_mutex);
   // change erase to setting nullptr?
   MetaCont<T>* container = outputDataStore()->tryRetrieve< MetaCont<T> >(key);
   if (container && container->erase(currentRangeID())) {
     if (container->entries() == 0u) removeHook(typeid(T));
     return StatusCode::SUCCESS;
   }
   return ignoreIfAbsent? StatusCode::SUCCESS : StatusCode::FAILURE;
}

removeHook()

virtual void IAthMetaDataSvc::removeHook ( const std::type_info &  )

inlinevirtual

Hook for implementation to react to removing an object.

Definition at line 73 of file IAthMetaDataSvc.h.

{}

shmProxy()

virtual StatusCode IAthMetaDataSvc::shmProxy ( const std::string &  filename )

pure virtual

used by AthenaPoolCnvSvc

tryConstRetrieve()

template<typename T , class TKEY >

const T * IAthMetaDataSvc::tryConstRetrieve

(

const TKEY &

key

)

const

Definition at line 102 of file IAthMetaDataSvc.h.

{
   const MetaCont<T>* container = outputDataStore()->tryRetrieve< MetaCont<T> >(key);
   if( container ) {
      return container->get( currentRangeID() );
   }
   return nullptr;
}

tryRetrieve()

template<typename T , class TKEY >

T * IAthMetaDataSvc::tryRetrieve

(

const TKEY &

key

)

const

Retrieve an object of type T from MetaDataStore Return 0 if not found.

Don't print any WARNINGs

Parameters

key	The key to use for the lookup.

Definition at line 92 of file IAthMetaDataSvc.h.

{
   const MetaCont<T>* container = outputDataStore()->tryRetrieve< MetaCont<T> >(key);
   if( container ) {
      return container->get( currentRangeID() );
   }
   return nullptr;
}

Member Data Documentation

m_mutex

std::mutex IAthMetaDataSvc::m_mutex

private

Definition at line 76 of file IAthMetaDataSvc.h.

---

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

• IAthMetaDataSvc.h