TopLevelTPConverter is the final and most specialized template for all top-level TP converters. More...

#include <TopLevelTPConverter.h>

Inherits TopLevelTPCnvBaseP< TL_PERS >, and ITPCnvBase.

Inherited by CMMCPHitsCollectionCnv_tlp1, CMMEtSumsCollectionCnv_tlp1, CMMJetHitsCollectionCnv_tlp1, CMXCPHitsCollectionCnv_tlp1, CMXCPTobCollectionCnv_tlp1, CMXEtSumsCollectionCnv_tlp1, CMXJetHitsCollectionCnv_tlp1, CMXJetTobCollectionCnv_tlp1, CPMHitsCollectionCnv_tlp1, CPMRoICollectionCnv_tlp1, CPMTobRoICollectionCnv_tlp1, CPMTowerCollectionCnv_tlp1, CombinedMuonFeatureCnv_tlp1, CombinedMuonFeatureContainerCnv_tlp1, CscPrepDataContainerCnv_tlp1, CscStripPrepDataContainerCnv_tlp1, InDetLowBetaCandidateCnv_tlp1, InDetLowBetaContainerCnv_tlp1, IsoMuonFeatureCnv_tlp1, IsoMuonFeatureContainerCnv_tlp1, JEMEtSumsCollectionCnv_tlp1, JEMHitsCollectionCnv_tlp1, JEMRoICollectionCnv_tlp1, JEMTobRoICollectionCnv_tlp1, JetCollectionCnv_tlp2, JetCollectionCnv_tlp5, JetCollectionCnv_tlp6, JetElementCollectionCnv_tlp1, JetKeyDescriptorCollectionCnv_tlp1, LayerMaterialMapCnv_tlp1, MVFVxContainerCnv_tlp1, MdtPrepDataContainerCnv_tlp1, MuonCaloEnergyContainerCnv_tlp1, MuonFeatureContainerCnv_tlp1, MuonFeatureContainerCnv_tlp2, MuonFeatureDetailsContainerCnv_tlp1, PixelClusterContainerCnv_tlp1, RODHeaderCollectionCnv_tlp1, RingerRingsCnv_tlp1, RingerRingsContainerCnv_tlp1, RpcPrepDataContainerCnv_tlp1, SCT_ClusterContainerCnv_tlp1, SegmentCollectionCnv_tlp1, SegmentCollectionCnv_tlp2, SegmentCollectionCnv_tlp3, TRT_DriftCircleContainerCnv_tlp1, TauDetailsContainerCnv_tlp1, TauDetailsContainerCnv_tlp2, TauDetailsContainerCnv_tlp3, TauDetailsContainerCnv_tlp4, TgcCoinDataContainerCnv_tlp1, TgcCoinDataContainerCnv_tlp2, TgcCoinDataContainerCnv_tlp3, TgcPrepDataContainerCnv_tlp1, TileMuFeatureContainerCnv_tlp1, TileTrackMuFeatureCnv_tlp1, TileTrackMuFeatureContainerCnv_tlp1, TrackCollectionCnv_tlp1, TrackCollectionCnv_tlp2, TrackCollectionCnv_tlp3, TrackCollectionCnv_tlp4, TrackCollectionCnv_tlp5, TrackParticleContainerCnv_tlp1, TrackParticleContainerCnv_tlp2, TrackParticleContainerCnv_tlp3, TrackParticleTruthCollectionContainerCnv_tlp1, TrackParticleTruthCollectionContainerCnv_tlp2, TrackParticleTruthCollectionContainerCnv_tlp3, TrigEFBjetContainerCnv_tlp1, TrigEFBjetContainerCnv_tlp2, TrigEFBphysContainerCnv_tlp1, TrigEFBphysContainerCnv_tlp2, TrigEMClusterCnv_tlp1, TrigEMClusterCnv_tlp2, TrigEMClusterContainerCnv_tlp1, TrigElectronContainerCnv_tlp1, TrigElectronContainerCnv_tlp2, TrigHisto1DContainerCnv_tlp1, TrigHisto2DContainerCnv_tlp1, TrigInDetTrackCollectionCnv_tlp1, TrigInDetTrackCollectionCnv_tlp2, TrigInDetTrackCollectionCnv_tlp3, TrigInDetTrackCollectionCnv_tlp4, TrigInDetTrackTruthMapCnv_tlp1, TrigInDetTrackTruthMapCnv_tlp2, TrigInDetTrackTruthMapCnv_tlp3, TrigInDetTrackTruthMapCnv_tlp4, TrigL2BjetContainerCnv_tlp1, TrigL2BjetContainerCnv_tlp2, TrigL2BphysContainerCnv_tlp1, TrigL2BphysContainerCnv_tlp2, TrigMissingETContainerCnv_tlp1, TrigMonConfigCollectionCnv_tlp1, TrigMonEventCollectionCnv_tlp1, TrigMuonClusterFeatureCnv_tlp1, TrigMuonClusterFeatureContainerCnv_tlp1, TrigMuonEFContainerCnv_tlp1, TrigMuonEFInfoContainerCnv_tlp1, TrigMuonEFInfoContainerCnv_tlp2, TrigOperationalInfoCollectionCnv_tlp1, TrigPhotonContainerCnv_tlp1, TrigPhotonContainerCnv_tlp2, TrigRNNOutputCnv_tlp1, TrigRNNOutputContainerCnv_tlp1, TrigRoiDescriptorCollectionCnv_tlp1, TrigSpacePointCountsCollectionCnv_tlp1, TrigT2JetCnv_tlp1, TrigT2JetContainerCnv_tlp1, TrigT2MbtsBitsContainerCnv_tlp1, TrigTauClusterCnv_tlp1, TrigTauClusterCnv_tlp2, TrigTauClusterContainerCnv_tlp1, TrigTauClusterDetailsCnv_tlp1, TrigTauClusterDetailsContainerCnv_tlp1, TrigTauCnv_tlp1, TrigTauCnv_tlp2, TrigTauContainerCnv_tlp1, TrigTauTracksInfoCnv_tlp1, TrigTauTracksInfoCollectionCnv_tlp1, TrigTrackCountsCollectionCnv_tlp1, TrigTrtHitCountsCollectionCnv_tlp1, TrigVertexCollectionCnv_tlp1, TrigVertexCollectionCnv_tlp2, TrigVertexCountsCollectionCnv_tlp1, TriggerTowerCollectionCnv_tlp1, V0ContainerCnv_tlp1, V0ContainerCnv_tlp2, VxContainerCnv_tlp1, and VxContainerCnv_tlp2.

Collaboration diagram for TopLevelTPConverter< MAIN_CNV, TL_PERS >:

Public Types
typedef MAIN_CNV::Trans_t	TRANS
typedef TL_PERS	PERS
typedef Gaudi::PluginService::Factory< ITPCnvBase *()>	Factory

Public Member Functions
virtual void	setPStorage (TL_PERS *persObj) override=0
	A stub for a method that should be provided by the converter creator.
	TopLevelTPConverter ()
	Constructor.
TRANS *	createTransient (MsgStream &log)
	Create transient representation of the persistent object known to this converter.
TRANS *	createTransientWithKey (const std::string &key, MsgStream &log)
	Create transient representation of the persistent object known to this converter.
virtual TRANS *	createTransient (const TL_PERS *persObj, MsgStream &log)
	Create transient representation of persObj.
virtual TL_PERS *	createPersistent (const TRANS *transObj, MsgStream &log)
	Create persistent representation of transObj.
virtual TL_PERS *	createPersistentWithKey (const TRANS *transObj, const std::string &key, MsgStream &log)
	Create persistent representation of transObj.
void	addMainTPConverter ()
	Add the main TP converter to the internal list - should be called from user-defined constructor.
template<typename STORAGE>
void	setMainCnvPStorage (STORAGE *storage)
	Set the persistent storage space for the main TP converter.
virtual unsigned short	getConverterID () override
	Returns this converter's ID.
virtual const std::type_info &	transientTInfo () const override
	return C++ type id of the transient class this converter is for
virtual const std::type_info &	persistentTInfo () const override
	return C++ type id of the persistent class this converter is for
virtual void	persToTransUntyped (const void pers, void trans, MsgStream &log) override
	Convert persistent object representation to transient.
virtual void	transToPersUntyped (const void trans, void pers, MsgStream &log) override
	Convert transient object representation to persistent.
virtual void	persToTransWithKeyUntyped (const void pers, void trans, const std::string &, MsgStream &log) override
	Convert persistent object representation to transient.
virtual void	transToPersWithKeyUntyped (const void trans, void pers, const std::string &, MsgStream &log) override
	Convert transient object representation to persistent.
virtual void	persToTrans (const PERS pers, TRANS trans, MsgStream &msg)
virtual void	transToPers (const TRANS trans, PERS pers, MsgStream &msg)
virtual bool	hasTLPersObject () const override
	Returns `true` if the converter has a persistent object.
virtual void	createTLPersObject () override
	Create persistent object - the converter keeps it.
virtual void	deleteTLPersObject () override
	Delete the persistent object owned by the converter.
TL_PERS *	getTLPersObject ()
const TL_PERS *	getTLPersObject () const
TL_PERS *	releaseTLPersObject ()
	@release the persistent object from this converter
virtual void *	getTLPersObjectAsVoid () override
virtual const void *	getTLPersObjectAsVoid () const override
virtual void	clearTLPersObject () override
	Discard the persistent object.
virtual void	setTLPersObject (void *persObj) override
	Take ownership of the persistent object.
virtual TPCnvTokenList_p1 *	getTokenListVar () override
	Return the list of tokens to the objects extending the object owned by this converter.
virtual TPCnvTokenList_p1 *	getTokenListVarFrom (void *persObj) override
	Return the list of tokens to the objects extending the object NOT owned by this converter.
virtual void	addTPConverter (ITPConverter *cnv)
	Add a TP converter to this top level converter.
virtual void	addTPConverterForReading (ITPConverter *cnv)
	Add a TP converter to this top level converter but only for reading.
virtual void	addExtTPConverterForReading (ITPConverter *cnv)
	add extending TP converter to this top level converter - to the list consulted when reading only.
virtual void	addTPConvertersTo (TopLevelTPCnvBase *dest)
	copy all extending converters from this top level converter to "dest" top level converter
virtual void	addTPConvertersForReadingTo (TopLevelTPCnvBase *dest)
	copy all extending converters from this top level converter to "dest" top level converter - for reading
ITPConverter *	converterForType (const std::type_info &info) const
	Find and return a TP converter for a given C++ type info.
ITPConverter *	converterForRef (const TPObjRef &ref) const
	Find and return a TP converter for persistent type referenced by ref.

Protected Types
typedef std::map< unsigned, ITPConverter * >	convIdMap_t

Protected Member Functions
void	rememberConverter (TopLevelTPCnvBase *cnv)
	Remember that elemental TP converters from the given top-level converter are already registered.
bool	hasConvertersFrom (TopLevelTPCnvBase *cnv)
	Check if TP converters from a given top-level converter were already registered in this converter.

Protected Attributes
MAIN_CNV	m_mainConverter
TL_PERS *	m_tlPersObject
	The persistent object this conveter is working on.
convIdMap_t	m_convIdMap
	Map of elemental TP converters indexed by their ID - used for reading.
TPConverterTypeMap< ITPConverter >	m_converters
	Map of elemental TP converters indexed by transient typeid - used for writing.
std::set< TopLevelTPCnvBase * >	m_registeredTLConverters
	Set top-level converters from which elemental TP converters were registered.
unsigned	m_typeIDCount
	Counter used to create typed IDs used in the transient Ref.

Private Member Functions
virtual void	addTPConverterForWriting (ITPConverter *cnv)
	add TP converter to the list of converters consulted when writing - internal method.

Detailed Description

template<class MAIN_CNV, class TL_PERS>
class TopLevelTPConverter< MAIN_CNV, TL_PERS >

TopLevelTPConverter is the final and most specialized template for all top-level TP converters.

It combines the top-level converter interface and functionality with the elemental TP converter interface, so a top-level converter can look and function as a standard TP converter.

This class uses a concept of the main TP converter, which is the first TP converter that needs to be invoked in the conversion process. This converter is 'built-in' and shold be added to the list of elemental TP converters by invoking addMainTPConverter()

Definition at line 32 of file TopLevelTPConverter.h.

Member Typedef Documentation

◆ convIdMap_t

typedef std::map<unsigned, ITPConverter*> TopLevelTPCnvBase::convIdMap_t

protectedinherited

Definition at line 174 of file TopLevelTPCnvBase.h.

◆ Factory

typedef Gaudi::PluginService::Factory<ITPCnvBase*()> ITPCnvBase::Factory

inherited

Definition at line 26 of file ITPCnvBase.h.

◆ PERS

template<class MAIN_CNV, class TL_PERS>

typedef TL_PERS TopLevelTPConverter< MAIN_CNV, TL_PERS >::PERS

Definition at line 38 of file TopLevelTPConverter.h.

◆ TRANS

template<class MAIN_CNV, class TL_PERS>

typedef MAIN_CNV::Trans_t TopLevelTPConverter< MAIN_CNV, TL_PERS >::TRANS

Definition at line 37 of file TopLevelTPConverter.h.

Constructor & Destructor Documentation

◆ TopLevelTPConverter()

template<class MAIN_CNV, class TL_PERS>

TopLevelTPConverter< MAIN_CNV, TL_PERS >::TopLevelTPConverter ( )

inline

Constructor.

Note: The constructor in the derived class should add all local converters using AddTPConverter()

Definition at line 50 of file TopLevelTPConverter.h.

50{}

Member Function Documentation

◆ addExtTPConverterForReading()

void TopLevelTPCnvBase::addExtTPConverterForReading ( ITPConverter * cnv )

virtualinherited

add extending TP converter to this top level converter - to the list consulted when reading only.

Parameters

cnv	[IN] the TP converter to be added

Definition at line 47 of file TopLevelTPCnvBase.cxx.

{
   // for reading, converters are selected based on our own typeID value
   // which comes from the Ref
   // Ref contains top level converter ID + local type ID
   m_convIdMap[ converter->typeID().value() ] = converter;
 
//   std::cout << " **addExtTPConverterForReading - adding converter for " << converter->transientTInfo().name() << " CnvID=" << converter->typeID().value() << std::endl;
   converter->setRuntimeTopConverter( this );
}

◆ addMainTPConverter()

template<class MAIN_CNV, class TL_PERS>

void TopLevelTPConverter< MAIN_CNV, TL_PERS >::addMainTPConverter ( )

inline

Add the main TP converter to the internal list - should be called from user-defined constructor.

Definition at line 146 of file TopLevelTPConverter.h.

146{ this->addTPConverter( &m_mainConverter ); }

TopLevelTPCnvBase::addTPConverter

virtual void addTPConverter(ITPConverter *cnv)

Add a TP converter to this top level converter.

Definition TopLevelTPCnvBase.cxx:11

TopLevelTPConverter::m_mainConverter

MAIN_CNV m_mainConverter

Definition TopLevelTPConverter.h:217

◆ addTPConverter()

void TopLevelTPCnvBase::addTPConverter ( ITPConverter * cnv )

virtualinherited

Add a TP converter to this top level converter.

Parameters

cnv	[IN] the TP converter to be added

Definition at line 11 of file TopLevelTPCnvBase.cxx.

{
   addTPConverterForWriting( converter );
   addTPConverterForReading( converter );
}

◆ addTPConverterForReading()

void TopLevelTPCnvBase::addTPConverterForReading ( ITPConverter * cnv )

virtualinherited

Add a TP converter to this top level converter but only for reading.

Old converters that read schema evolved objects should be added only for reading.

Parameters

cnv	[IN] the TP converter to be added

Definition at line 19 of file TopLevelTPCnvBase.cxx.

{
   // for reading, converters are selected based on their typeID value
   // which comes from the Ref
   // Ref contains top level converter ID + local type ID
   TPObjRef::typeID_t   full_typeID( getConverterID(), ++m_typeIDCount );
   m_convIdMap[ full_typeID.value() ] = converter;
 
//   std::cout << " **addTPConverter - adding converter for " << converter->transientTInfo().name() << " CnvID=" << full_typeID.value() << std::endl;
   converter->setTopConverter( this, full_typeID );
}

◆ addTPConverterForWriting()

void TopLevelTPCnvBase::addTPConverterForWriting ( ITPConverter * cnv )

privatevirtualinherited

add TP converter to the list of converters consulted when writing - internal method.

Parameters

cnv	[IN] the TP converter to be added

Definition at line 33 of file TopLevelTPCnvBase.cxx.

{
   // add converter to the map keyed by type_info
   // this map is used to find a converter when writing
   const  std::type_info &info( converter->transientTInfo() );
   if( m_converters.findConverter( info ) ) {
      // adding a second converter for the same type will mess up things
      const std::string error("Duplicate TP converter for class ");
      throw std::runtime_error( error +  info.name() );
   }
   m_converters.addConverter( converter, info );
}

◆ addTPConvertersForReadingTo()

void TopLevelTPCnvBase::addTPConvertersForReadingTo ( TopLevelTPCnvBase * dest )

virtualinherited

copy all extending converters from this top level converter to "dest" top level converter - for reading

Parameters

dest	[IN] destination converter which will receive all elemental TP converters that this one has

Definition at line 78 of file TopLevelTPCnvBase.cxx.

{
   // check if we have done this already, and if so then exit
   if( cnv->hasConvertersFrom( this ) ) {
      return;
   }
   // copy all TP converters to another topLevel conveter 
   for( convIdMap_t::const_iterator itr = m_convIdMap.begin();
    itr != m_convIdMap.end(); ++itr ) {
      cnv->addExtTPConverterForReading( itr->second );
   }
   // prevent attempts to add the same converters again
   cnv->rememberConverter( this );
}

◆ addTPConvertersTo()

void TopLevelTPCnvBase::addTPConvertersTo ( TopLevelTPCnvBase * dest )

virtualinherited

copy all extending converters from this top level converter to "dest" top level converter

copy all TP converters to another topLevel conveter

Parameters

dest	[IN] destination converter which will receive all elemental TP converters that this one has

Definition at line 60 of file TopLevelTPCnvBase.cxx.

{
   // loop over all registered converters 
   for( convIdMap_t::const_iterator itr = m_convIdMap.begin();
    itr != m_convIdMap.end(); ++itr ) {
      // check if the converter is in the list of R/W converters
      if( m_converters.findConverter( itr->second->transientTInfo() ) == itr->second ) {
         // this is a R/W converter, add it for writing too
         cnv->addTPConverterForWriting( itr->second );
      }
      // add the convterter for reading
      cnv->addExtTPConverterForReading( itr->second );
   }
   // prevent adding of the same converter again
   cnv->rememberConverter( this );
}

◆ clearTLPersObject()

template<class TL_PERS>

virtual void TopLevelTPCnvBaseP< TL_PERS >::clearTLPersObject ( )

inlineoverridevirtualinherited

Discard the persistent object.

Implements TopLevelTPCnvBase.

Definition at line 99 of file TopLevelTPCnvBaseP.h.

                                                 {
     m_tlPersObject = 0;
  }

◆ converterForRef()

ITPConverter * TopLevelTPCnvBase::converterForRef ( const TPObjRef & ref ) const

inlineinherited

Find and return a TP converter for persistent type referenced by ref.

Parameters

ref	[IN] TP reference of a persistent object

Returns: ITPConverter* pointer to the TP converter for ref

Definition at line 89 of file TopLevelTPCnvBase.h.

                                                                {
     convIdMap_t::const_iterator  iter = m_convIdMap.find( ref.typeID() );
     return (iter == m_convIdMap.end())?
    0 : iter->second;
  }

◆ converterForType()

ITPConverter * TopLevelTPCnvBase::converterForType ( const std::type_info & info ) const

inlineinherited

Find and return a TP converter for a given C++ type info.

Parameters

info	[IN] C++ type info reference to the transient type

Returns: ITPConverter* pointer to the TP converter for type info

Definition at line 80 of file TopLevelTPCnvBase.h.

                                                                      {
     return m_converters.findConverter( info );
  }

◆ createPersistent()

template<class MAIN_CNV, class TL_PERS>

virtual TL_PERS * TopLevelTPConverter< MAIN_CNV, TL_PERS >::createPersistent	(	const TRANS *	transObj,
		MsgStream &	log )

inlinevirtual

Create persistent representation of transObj.

Parameters

transObj	[IN] pointer to the transient representation
log	[IN] message stream for output

Returns: TL_PRES* persistent object passed by a pointer

Definition at line 110 of file TopLevelTPConverter.h.

  {
     // create a new persistent object (empty)
     this->createTLPersObject();
     // do transToPers conversion, fill in the persistent object
     m_mainConverter.virt_toPersistent(transObj, log);
     // take the persistent object away from the TL converter 
     TL_PERS *ret = this->getTLPersObject();
     // important to clear so createTransient() will not try to delete it (and crash)
     this->clearTLPersObject();
     return ret;
  }

◆ createPersistentWithKey()

template<class MAIN_CNV, class TL_PERS>

virtual TL_PERS * TopLevelTPConverter< MAIN_CNV, TL_PERS >::createPersistentWithKey	(	const TRANS *	transObj,
		const std::string &	key,
		MsgStream &	log )

inlinevirtual

Create persistent representation of transObj.

Parameters

transObj	[IN] pointer to the transient representation
key	[IN] SG key of the object being converted.
log	[IN] message stream for output

Returns: TL_PRES* persistent object passed by a pointer

Definition at line 129 of file TopLevelTPConverter.h.

  {
     // create a new persistent object (empty)
     this->createTLPersObject();
     // do transToPers conversion, fill in the persistent object
     m_mainConverter.virt_toPersistentWithKey(transObj, key, log);
     // take the persistent object away from the TL converter 
     TL_PERS *ret = this->getTLPersObject();
     // important to clear so createTransient() will not try to delete it (and crash)
     this->clearTLPersObject();
     return ret;
  }

◆ createTLPersObject()

template<class TL_PERS>

virtual void TopLevelTPCnvBaseP< TL_PERS >::createTLPersObject ( )

inlineoverridevirtualinherited

Create persistent object - the converter keeps it.

Implements TopLevelTPCnvBase.

Definition at line 57 of file TopLevelTPCnvBaseP.h.

                                              {
     m_tlPersObject = new TL_PERS();
     setPStorage( m_tlPersObject );     
  }

◆ createTransient() [1/2]

template<class MAIN_CNV, class TL_PERS>

virtual TRANS * TopLevelTPConverter< MAIN_CNV, TL_PERS >::createTransient	(	const TL_PERS *	persObj,
		MsgStream &	log )

inlinevirtual

Create transient representation of persObj.

NOTE: usually this method will not delete persObj and the user needs to do it himself. However, if ownership was somehow passed to the converter earlier, then the object will be deleted.

Parameters

persObj	[IN] pointer to the persistent representation
log	[IN] message stream for output

Returns: TRANS* transient object passed by a pointer

Definition at line 96 of file TopLevelTPConverter.h.

                                                                          {
     // FIXME: TPConverter uses the same non-const member m_pStorage
     // for both reading and writing, but we want it to be const
     // in the former case.
     TL_PERS* pers_nc ATLAS_THREAD_SAFE = const_cast<TL_PERS*>(persObj);
     setPStorage( pers_nc ); 
     return createTransient( log );
  }

◆ createTransient() [2/2]

template<class MAIN_CNV, class TL_PERS>

TRANS * TopLevelTPConverter< MAIN_CNV, TL_PERS >::createTransient ( MsgStream & log )

inline

Create transient representation of the persistent object known to this converter.

NOTE: If the persistent object is owned by the converter, it will be deleted

Parameters

log	[IN] message stream for output

Returns: TRANS* transient object passed by a pointer

Definition at line 62 of file TopLevelTPConverter.h.

                                            {
     // 0 is the index of the main and only one top level object
     TRANS *transObj = m_mainConverter.virt_createTransFromPStore( 0, log );
     this->deleteTLPersObject();
     return transObj;
  }

◆ createTransientWithKey()

template<class MAIN_CNV, class TL_PERS>

TRANS * TopLevelTPConverter< MAIN_CNV, TL_PERS >::createTransientWithKey	(	const std::string &	key,
		MsgStream &	log )

inline

Create transient representation of the persistent object known to this converter.

NOTE: If the persistent object is owned by the converter, it will be deleted

Parameters

key	[IN] SG key of the object being converted
log	[IN] message stream for output

Returns: TRANS* transient object passed by a pointer

Definition at line 78 of file TopLevelTPConverter.h.

  {
     // 0 is the index of the main and only one top level object
    TRANS *transObj = m_mainConverter.virt_createTransFromPStoreWithKey( 0, key, log );
     this->deleteTLPersObject();
     return transObj;
  }

◆ deleteTLPersObject()

template<class TL_PERS>

virtual void TopLevelTPCnvBaseP< TL_PERS >::deleteTLPersObject ( )

inlineoverridevirtualinherited

Delete the persistent object owned by the converter.

Implements TopLevelTPCnvBase.

Definition at line 64 of file TopLevelTPCnvBaseP.h.

                                              {
     if( m_tlPersObject ) {
    delete m_tlPersObject;
    clearTLPersObject();
     }
  }

◆ getConverterID()

template<class MAIN_CNV, class TL_PERS>

virtual unsigned short TopLevelTPConverter< MAIN_CNV, TL_PERS >::getConverterID ( void )

inlineoverridevirtual

Returns this converter's ID.

By default it is 0. Should be overwritten in extending converters

Returns: this converter's ID

Implements TopLevelTPCnvBase.

Reimplemented in MuonCaloEnergyContainerCnv_tlp1, MVFVxContainerCnv_tlp1, V0ContainerCnv_tlp1, and V0ContainerCnv_tlp2.

Definition at line 159 of file TopLevelTPConverter.h.

159{ return 0; }

◆ getTLPersObject() [1/2]

template<class TL_PERS>

TL_PERS * TopLevelTPCnvBaseP< TL_PERS >::getTLPersObject ( )

inlineinherited

Returns: pointer to the persistent object owned by this converter

Definition at line 72 of file TopLevelTPCnvBaseP.h.

                              {
     return m_tlPersObject;
  }

◆ getTLPersObject() [2/2]

template<class TL_PERS>

const TL_PERS * TopLevelTPCnvBaseP< TL_PERS >::getTLPersObject ( ) const

inlineinherited

Returns: pointer to the persistent object owned by this converter

Definition at line 77 of file TopLevelTPCnvBaseP.h.

                                            {
     return m_tlPersObject;
  }

◆ getTLPersObjectAsVoid() [1/2]

template<class TL_PERS>

virtual const void * TopLevelTPCnvBaseP< TL_PERS >::getTLPersObjectAsVoid ( ) const

inlineoverridevirtualinherited

Returns: pointer to the persistent object owned by this converter as void*

Implements TopLevelTPCnvBase.

Definition at line 94 of file TopLevelTPCnvBaseP.h.

                                                               {
     return getTLPersObject();
  }     

◆ getTLPersObjectAsVoid() [2/2]

template<class TL_PERS>

virtual void * TopLevelTPCnvBaseP< TL_PERS >::getTLPersObjectAsVoid ( )

inlineoverridevirtualinherited

Returns: pointer to the persistent object owned by this converter as void*

Implements TopLevelTPCnvBase.

Definition at line 89 of file TopLevelTPCnvBaseP.h.

                                                 {
     return getTLPersObject();
  }     

◆ getTokenListVar()

template<class TL_PERS>

virtual TPCnvTokenList_p1 * TopLevelTPCnvBaseP< TL_PERS >::getTokenListVar ( )

inlineoverridevirtualinherited

Return the list of tokens to the objects extending the object owned by this converter.

This method is needed only in a conveter which has extensions. It needs to be implemented in the top-level converter by the user

Returns: pointer to the token list from the persistent object

Implements TopLevelTPCnvBase.

Reimplemented in CscPrepDataContainerCnv_tlp1, CscStripPrepDataContainerCnv_tlp1, JetCollectionCnv_tlp2, JetCollectionCnv_tlp5, JetCollectionCnv_tlp6, JetKeyDescriptorCollectionCnv_tlp1, LayerMaterialMapCnv_tlp1, MdtPrepDataContainerCnv_tlp1, PixelClusterContainerCnv_tlp1, RpcPrepDataContainerCnv_tlp1, SCT_ClusterContainerCnv_tlp1, SegmentCollectionCnv_tlp1, SegmentCollectionCnv_tlp2, SegmentCollectionCnv_tlp3, TgcCoinDataContainerCnv_tlp1, TgcCoinDataContainerCnv_tlp2, TgcCoinDataContainerCnv_tlp3, TgcPrepDataContainerCnv_tlp1, TrackCollectionCnv_tlp1, TrackCollectionCnv_tlp2, TrackCollectionCnv_tlp3, TrackCollectionCnv_tlp4, TrackCollectionCnv_tlp5, TrackParticleContainerCnv_tlp1, TrackParticleContainerCnv_tlp2, TrackParticleContainerCnv_tlp3, TRT_DriftCircleContainerCnv_tlp1, VxContainerCnv_tlp1, and VxContainerCnv_tlp2.

Definition at line 112 of file TopLevelTPCnvBaseP.h.

112{ return 0; }

◆ getTokenListVarFrom()

template<class TL_PERS>

virtual TPCnvTokenList_p1 * TopLevelTPCnvBaseP< TL_PERS >::getTokenListVarFrom ( void * persObj )

inlineoverridevirtualinherited

Return the list of tokens to the objects extending the object NOT owned by this converter.

Parameters

persObj [IN] persistent object from which contains list of tokens. Passes as void* - if the type is wrong, it may crash

Returns: pointer to the token list from persObj

Implements TopLevelTPCnvBase.

Definition at line 115 of file TopLevelTPCnvBaseP.h.

                                                                              {
     // avoid setting up the pointer to persistent object
     // (can lead to deleting it twice, if the user deletes too)
     TL_PERS *tmp = m_tlPersObject;
     m_tlPersObject = reinterpret_cast<TL_PERS*>( persObj );
     TPCnvTokenList_p1 *toklist = getTokenListVar();
     m_tlPersObject = tmp;
     return toklist;
  }

◆ hasConvertersFrom()

bool TopLevelTPCnvBase::hasConvertersFrom ( TopLevelTPCnvBase * cnv )

inlineprotectedinherited

Check if TP converters from a given top-level converter were already registered in this converter.

Parameters

cnv	[IN] top-level converter to check

Returns: true if TP converters from cnv were already registered

Definition at line 166 of file TopLevelTPCnvBase.h.

  {
     return m_registeredTLConverters.find(cnv) != m_registeredTLConverters.end();
  }

◆ hasTLPersObject()

template<class TL_PERS>

virtual bool TopLevelTPCnvBaseP< TL_PERS >::hasTLPersObject ( ) const

inlineoverridevirtualinherited

Returns true if the converter has a persistent object.

Implements TopLevelTPCnvBase.

Definition at line 52 of file TopLevelTPCnvBaseP.h.

                                                 {
     return m_tlPersObject;
  }

◆ persistentTInfo()

template<class MAIN_CNV, class TL_PERS>

virtual const std::type_info & TopLevelTPConverter< MAIN_CNV, TL_PERS >::persistentTInfo ( ) const

inlineoverridevirtual

return C++ type id of the persistent class this converter is for

Returns: std::type_info&

Implements ITPCnvBase.

Definition at line 169 of file TopLevelTPConverter.h.

169{ return typeid(PERS); }

TopLevelTPConverter::PERS

TL_PERS PERS

Definition TopLevelTPConverter.h:38

◆ persToTrans()

template<class MAIN_CNV, class TL_PERS>

virtual void TopLevelTPConverter< MAIN_CNV, TL_PERS >::persToTrans	(	const PERS *	pers,
		TRANS *	trans,
		MsgStream &	msg )

inlinevirtual

Definition at line 201 of file TopLevelTPConverter.h.

                                                                            {
    // FIXME: TPConverter uses the same non-const member m_pStorage
    // for both reading and writing, but we want it to be const
    // in the former case.
    TL_PERS* pers_nc ATLAS_THREAD_SAFE = const_cast<TL_PERS*>(pers);
    setPStorage( pers_nc ); 
    m_mainConverter.pstoreToTrans (0, trans, msg);
  }

◆ persToTransUntyped()

template<class MAIN_CNV, class TL_PERS>

virtual void TopLevelTPConverter< MAIN_CNV, TL_PERS >::persToTransUntyped	(	const void *	pers,
		void *	trans,
		MsgStream &	log )

inlineoverridevirtual

Convert persistent object representation to transient.

Parameters

pers	[IN] void* pointer to the persistent object
trans	[OUT] void* pointer to the empty transient object
log	[IN] output message stream

Implements ITPCnvBase.

Definition at line 173 of file TopLevelTPConverter.h.

                                                                                          {
     persToTrans( reinterpret_cast<const PERS*>(pers), reinterpret_cast<TRANS*>(trans), log );
  }

◆ persToTransWithKeyUntyped()

template<class MAIN_CNV, class TL_PERS>

virtual void TopLevelTPConverter< MAIN_CNV, TL_PERS >::persToTransWithKeyUntyped	(	const void *	pers,
		void *	trans,
		const std::string &	,
		MsgStream &	log )

inlineoverridevirtual

Convert persistent object representation to transient.

Parameters

pers	[IN] void* pointer to the persistent object
trans	[OUT] void* pointer to the empty transient object
key	[IN] SG key of object being read.
log	[IN] output message stream

Reimplemented from ITPCnvBase.

Definition at line 183 of file TopLevelTPConverter.h.

  {
     persToTrans( reinterpret_cast<const PERS*>(pers), reinterpret_cast<TRANS*>(trans), log );
  }

◆ releaseTLPersObject()

template<class TL_PERS>

TL_PERS * TopLevelTPCnvBaseP< TL_PERS >::releaseTLPersObject ( )

inlineinherited

@release the persistent object from this converter

Definition at line 82 of file TopLevelTPCnvBaseP.h.

                                  {
     TL_PERS *tmp = m_tlPersObject;
     clearTLPersObject();
     return tmp;
  }

◆ rememberConverter()

void TopLevelTPCnvBase::rememberConverter ( TopLevelTPCnvBase * cnv )

inlineprotectedinherited

Remember that elemental TP converters from the given top-level converter are already registered.

Parameters

cnv	[IN] top-level TP converter - source of the elemental TP converters

Definition at line 156 of file TopLevelTPCnvBase.h.

  {
     m_registeredTLConverters.insert(cnv);
  }

◆ setMainCnvPStorage()

template<class MAIN_CNV, class TL_PERS>

template<typename STORAGE>

void TopLevelTPConverter< MAIN_CNV, TL_PERS >::setMainCnvPStorage ( STORAGE * storage )

inline

Set the persistent storage space for the main TP converter.

Definition at line 152 of file TopLevelTPConverter.h.

                                               {
     m_mainConverter.setPStorage( storage );
  }

◆ setPStorage()

template<class MAIN_CNV, class TL_PERS>

virtual void TopLevelTPConverter< MAIN_CNV, TL_PERS >::setPStorage ( TL_PERS * persObj )

overridepure virtual

A stub for a method that should be provided by the converter creator.

In that methods all elemental TP converters that belong to this top-level converter need to be assigned to storage vectors in the persistent object.

Parameters

persObj [IN] persistent object

Implements TopLevelTPCnvBaseP< TL_PERS >.

◆ setTLPersObject()

template<class TL_PERS>

virtual void TopLevelTPCnvBaseP< TL_PERS >::setTLPersObject ( void * persObj )

inlineoverridevirtualinherited

Take ownership of the persistent object.

Also initialize all elemental TP converters to use that object.

Parameters

persObj [IN] the persistent object passed as void*

Implements TopLevelTPCnvBase.

Definition at line 104 of file TopLevelTPCnvBaseP.h.

                                                          {
     if( m_tlPersObject )   delete m_tlPersObject; 
     m_tlPersObject = reinterpret_cast<TL_PERS*>( persObj );
     setPStorage( m_tlPersObject  );
  }

◆ transientTInfo()

template<class MAIN_CNV, class TL_PERS>

virtual const std::type_info & TopLevelTPConverter< MAIN_CNV, TL_PERS >::transientTInfo ( ) const

inlineoverridevirtual

return C++ type id of the transient class this converter is for

Returns: std::type_info&

Implements ITPCnvBase.

Definition at line 166 of file TopLevelTPConverter.h.

166{ return typeid(TRANS); }

◆ transToPers()

template<class MAIN_CNV, class TL_PERS>

virtual void TopLevelTPConverter< MAIN_CNV, TL_PERS >::transToPers	(	const TRANS *	trans,
		PERS *	pers,
		MsgStream &	msg )

inlinevirtual

Definition at line 210 of file TopLevelTPConverter.h.

                                                                           {
    this->setTLPersObject( pers );
    m_mainConverter.virt_toPersistent(trans, msg);
    this->clearTLPersObject();
  }

◆ transToPersUntyped()

template<class MAIN_CNV, class TL_PERS>

virtual void TopLevelTPConverter< MAIN_CNV, TL_PERS >::transToPersUntyped	(	const void *	trans,
		void *	pers,
		MsgStream &	log )

inlineoverridevirtual

Convert transient object representation to persistent.

Parameters

trans	[IN] void* pointer to the transient object
pers	[OUT] void* pointer to the empty persistent object
log	[IN] output message stream

Implements ITPCnvBase.

Definition at line 178 of file TopLevelTPConverter.h.

                                                                                          {
     transToPers( reinterpret_cast<const TRANS*>(trans),  reinterpret_cast<PERS*>(pers), log );
  }

◆ transToPersWithKeyUntyped()

template<class MAIN_CNV, class TL_PERS>

virtual void TopLevelTPConverter< MAIN_CNV, TL_PERS >::transToPersWithKeyUntyped	(	const void *	trans,
		void *	pers,
		const std::string &	,
		MsgStream &	log )

inlineoverridevirtual

Convert transient object representation to persistent.

Parameters

trans	[IN] void* pointer to the transient object
pers	[OUT] void* pointer to the empty persistent object
key	[IN] SG key of object being written.
log	[IN] output message stream

Reimplemented from ITPCnvBase.

Definition at line 192 of file TopLevelTPConverter.h.

  {
     transToPers( reinterpret_cast<const TRANS*>(trans),  reinterpret_cast<PERS*>(pers), log );
  }

Member Data Documentation

◆ m_converters

TPConverterTypeMap< ITPConverter > TopLevelTPCnvBase::m_converters

protectedinherited

Map of elemental TP converters indexed by transient typeid - used for writing.

Definition at line 180 of file TopLevelTPCnvBase.h.

◆ m_convIdMap

convIdMap_t TopLevelTPCnvBase::m_convIdMap

protectedinherited

Map of elemental TP converters indexed by their ID - used for reading.

Definition at line 177 of file TopLevelTPCnvBase.h.

◆ m_mainConverter

template<class MAIN_CNV, class TL_PERS>

MAIN_CNV TopLevelTPConverter< MAIN_CNV, TL_PERS >::m_mainConverter

protected

Definition at line 217 of file TopLevelTPConverter.h.

◆ m_registeredTLConverters

std::set<TopLevelTPCnvBase*> TopLevelTPCnvBase::m_registeredTLConverters

protectedinherited

Set top-level converters from which elemental TP converters were registered.

Definition at line 184 of file TopLevelTPCnvBase.h.

◆ m_tlPersObject

template<class TL_PERS>

TL_PERS* TopLevelTPCnvBaseP< TL_PERS >::m_tlPersObject

protectedinherited

The persistent object this conveter is working on.

Definition at line 128 of file TopLevelTPCnvBaseP.h.

◆ m_typeIDCount

unsigned TopLevelTPCnvBase::m_typeIDCount

protectedinherited

Counter used to create typed IDs used in the transient Ref.

Definition at line 187 of file TopLevelTPCnvBase.h.

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

TopLevelTPConverter.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ convIdMap_t

◆ Factory

◆ PERS

◆ TRANS

Constructor & Destructor Documentation

◆ TopLevelTPConverter()

Member Function Documentation

◆ addExtTPConverterForReading()

◆ addMainTPConverter()

◆ addTPConverter()

◆ addTPConverterForReading()

◆ addTPConverterForWriting()

◆ addTPConvertersForReadingTo()

◆ addTPConvertersTo()

◆ clearTLPersObject()

◆ converterForRef()

◆ converterForType()

◆ createPersistent()

◆ createPersistentWithKey()

◆ createTLPersObject()

◆ createTransient() [1/2]

◆ createTransient() [2/2]

◆ createTransientWithKey()

◆ deleteTLPersObject()

◆ getConverterID()

◆ getTLPersObject() [1/2]

◆ getTLPersObject() [2/2]

◆ getTLPersObjectAsVoid() [1/2]

◆ getTLPersObjectAsVoid() [2/2]

◆ getTokenListVar()

◆ getTokenListVarFrom()

◆ hasConvertersFrom()

◆ hasTLPersObject()

◆ persistentTInfo()

◆ persToTrans()

◆ persToTransUntyped()

◆ persToTransWithKeyUntyped()

◆ releaseTLPersObject()

◆ rememberConverter()

◆ setMainCnvPStorage()

◆ setPStorage()

◆ setTLPersObject()

◆ transientTInfo()

◆ transToPers()

◆ transToPersUntyped()

◆ transToPersWithKeyUntyped()

Member Data Documentation

◆ m_converters

◆ m_convIdMap

◆ m_mainConverter

◆ m_registeredTLConverters

◆ m_tlPersObject

◆ m_typeIDCount