TopLevelTPCnvBaseP< TL_PERS > Class Template Reference

This class is a more specialized version of TopLevelTPCnvBase - it is a template parametrized by the actual type of the persistent object the converter will work with. More...

#include <TopLevelTPCnvBaseP.h>

Inherits TopLevelTPCnvBase.

Inherited by TopLevelTPConverter< SegmentCollectionCnv_p1, Trk::SegmentCollection_tlp4 >, TopLevelTPConverter< TrackCollectionCnv_p4, Trk::TrackCollection_tlp6 >, TopLevelTPConverter< TrackCollectionCnv_p4, Trk::TrackCollection_tlp7 >, Analysis::JetTagInfoCnv_tlp1, Analysis::JetTagInfoCnv_tlp2, Analysis::JetTagInfoCnv_tlp3, InDetTrackCnv_tlp1, InDetTrackCnv_tlp2, MuonMeasurementsCnv_tlp1, MuonMeasurementsCnv_tlp2, and TopLevelTPConverter< MAIN_CNV, TL_PERS >.

Collaboration diagram for TopLevelTPCnvBaseP< TL_PERS >:

Public Member Functions
virtual void	setPStorage (TL_PERS *persObj)=0
	A stub for a method that should be provided by the converter creator.
	TopLevelTPCnvBaseP ()
virtual	~TopLevelTPCnvBaseP ()
	TopLevelTPCnvBaseP (const TopLevelTPCnvBaseP &)=delete
TopLevelTPCnvBaseP &	operator= (const TopLevelTPCnvBaseP &)=delete
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.
virtual unsigned short	getConverterID ()=0

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
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 TL_PERS>
class TopLevelTPCnvBaseP< TL_PERS >

This class is a more specialized version of TopLevelTPCnvBase - it is a template parametrized by the actual type of the persistent object the converter will work with.

It provided implementations for several methods that were pure virtual before (because of the lack of specific type there)

Definition at line 25 of file TopLevelTPCnvBaseP.h.

Member Typedef Documentation

convIdMap_t

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

protectedinherited

Definition at line 174 of file TopLevelTPCnvBase.h.

Constructor & Destructor Documentation

TopLevelTPCnvBaseP() [1/2]

template<class TL_PERS>

TopLevelTPCnvBaseP< TL_PERS >::TopLevelTPCnvBaseP ( )

inline

Definition at line 41 of file TopLevelTPCnvBaseP.h.

: m_tlPersObject(0)  {}

~TopLevelTPCnvBaseP()

template<class TL_PERS>

virtual TopLevelTPCnvBaseP< TL_PERS >::~TopLevelTPCnvBaseP ( )

inlinevirtual

Definition at line 43 of file TopLevelTPCnvBaseP.h.

{ deleteTLPersObject(); }

TopLevelTPCnvBaseP() [2/2]

template<class TL_PERS>

TopLevelTPCnvBaseP< TL_PERS >::TopLevelTPCnvBaseP ( const TopLevelTPCnvBaseP< TL_PERS > & )

delete

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

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

inlineoverridevirtual

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

createTLPersObject()

template<class TL_PERS>

virtual void TopLevelTPCnvBaseP< TL_PERS >::createTLPersObject ( )

inlineoverridevirtual

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

deleteTLPersObject()

template<class TL_PERS>

virtual void TopLevelTPCnvBaseP< TL_PERS >::deleteTLPersObject ( )

inlineoverridevirtual

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

virtual unsigned short TopLevelTPCnvBase::getConverterID ( )

pure virtualinherited

Returns

ID of the converter

Implemented in Analysis::JetTagInfoCnv_tlp1, Analysis::JetTagInfoCnv_tlp2, Analysis::JetTagInfoCnv_tlp3, InDetTrackCnv_tlp1, InDetTrackCnv_tlp2, JetTagInfoCnv_tlp1, JetTagInfoCnv_tlp2, JetTagInfoCnv_tlp3, MuonCaloEnergyContainerCnv_tlp1, MuonMeasurementsCnv_tlp1, MuonMeasurementsCnv_tlp2, MVFVxContainerCnv_tlp1, TopLevelTPConverter< MAIN_CNV, TL_PERS >, TopLevelTPConverter< SegmentCollectionCnv_p1, Trk::SegmentCollection_tlp4 >, TopLevelTPConverter< TrackCollectionCnv_p4, Trk::TrackCollection_tlp6 >, TopLevelTPConverter< TrackCollectionCnv_p4, Trk::TrackCollection_tlp7 >, V0ContainerCnv_tlp1, and V0ContainerCnv_tlp2.

getTLPersObject() [1/2]

template<class TL_PERS>

TL_PERS * TopLevelTPCnvBaseP< TL_PERS >::getTLPersObject ( )

inline

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

inline

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

inlineoverridevirtual

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

inlineoverridevirtual

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

inlineoverridevirtual

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.

{ return 0; }

getTokenListVarFrom()

template<class TL_PERS>

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

inlineoverridevirtual

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

inlineoverridevirtual

Returns true if the converter has a persistent object.

Implements TopLevelTPCnvBase.

Definition at line 52 of file TopLevelTPCnvBaseP.h.

                                                 {
     return m_tlPersObject;
  }

operator=()

template<class TL_PERS>

TopLevelTPCnvBaseP & TopLevelTPCnvBaseP< TL_PERS >::operator= ( const TopLevelTPCnvBaseP< TL_PERS > & )

delete

releaseTLPersObject()

template<class TL_PERS>

TL_PERS * TopLevelTPCnvBaseP< TL_PERS >::releaseTLPersObject ( )

inline

@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);
  }

setPStorage()

template<class TL_PERS>

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

pure 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

Implemented in TopLevelTPConverter< MAIN_CNV, TL_PERS >.

setTLPersObject()

template<class TL_PERS>

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

inlineoverridevirtual

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

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

protected

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:

• TopLevelTPCnvBaseP.h