This class is used to add functionality to a standard AthenaConverter. More...

#include <AthenaConverterTLPExtension.h>

Inheritance diagram for AthenaConverterTLPExtension:

Collaboration diagram for AthenaConverterTLPExtension:

Public Member Functions
	AthenaConverterTLPExtension ()
	Constructor. More...

virtual	~AthenaConverterTLPExtension ()
	Destructor. More...

virtual const Token *	writeObject (const std::string &, const std::string &)
	Writes the extending persistent object created by this converter Called from the EXTENDED (principal) Athena converter Implemented only in EXTENDING Athena converters. More...

virtual void	readObject (const std::string &)
	Read the extending object. More...

virtual AthenaConverterTLPExtension *	clone ()
	Clone this Athena Converter. More...

virtual void	wasClonedFrom (AthenaConverterTLPExtension *)
	Remember the original converter that this one was cloned from. More...

virtual bool	needsCloning () const
	Find out if this converter needs to be cloned Returns true if this converter was already registered once. More...

virtual const std::string	name () const
	Get name of this converter (anything that identifies it) More...

virtual TopLevelTPCnvBase *	getTopLevelTPCnv ()=0
	returns the main top-level TP converter More...

unsigned short	getTPCnvID ()
	Returns the ID of the main top-level TP converter. More...

TopLevelTPCnvBase *	getTopLevelTPCnvForReading ()
	returns the current top-level TP converter. More...

void	usingTPCnvForReading (TopLevelTPCnvBase &cnv)
	Sets top-level TP converter to be used for reading the next object. More...

void	resetTPCnvForReading ()
	Reset to 0 the TL TP converter for reading. More...

virtual void	readExtendingObjects (void *baseObj)
	Read all component persistent objects. More...

virtual void	deletePersistentObjects ()
	Delete persistent objects held by attached extending converters (used mainly in case of abort) More...

virtual bool	registerExtendingCnv (AthenaConverterTLPExtension *cnv)
	Register extending converter (that is, another converter that will extent this converter) and all his elemental converters. More...

Protected Types
typedef std::map< unsigned, AthenaConverterTLPExtension * >	extCnvMap_t

typedef std::map< TopLevelTPCnvBase , extCnvMap_t >	extCnvMapMap_t

Protected Member Functions
void	usingTPCnvForReading (void *cnv)

Protected Attributes
extCnvMap_t	m_extendingConverters
	map of Athena converters extending this one More...

extCnvMapMap_t	m_extCnvMapMap

TopLevelTPCnvBase *	m_TLCnvForReading
	additional Top Level TP converter used only for reading tells which converter is used in case of reading old versions (as different versions have different converters) NOT owned byt his class More...

std::vector< AthenaConverterTLPExtension * >	m_clonedExtendingCnvs
	list of duplicated converters to delete at the end held in the original converter More...

Detailed Description

This class is used to add functionality to a standard AthenaConverter.

AthenaConverterTLPExtension does not work standalone and should not be used directly. T_AthenaPoolExtendingCnv, which inherits from it, is the enhanced AthenaPool converter base inteded to be used to implement new Athena converters.

AthenaConverterTLPExtension provides:

interface to access top level TP converter(s) used by associated Athena converter
management (read/write/delete) of the group of persistent objects consisting of the object being extended together with the objects that extend it
converter "cloning" - creating more than one instance of a given type of Athena converter (not supported by Gaudi)

AthenaConverterTLPExtension defines interface for both extended and extending converters - some methods are implemented only in one converter type

Definition at line 42 of file AthenaConverterTLPExtension.h.

Member Typedef Documentation

◆ extCnvMap_t

typedef std::map<unsigned, AthenaConverterTLPExtension*> AthenaConverterTLPExtension::extCnvMap_t

protected

Definition at line 133 of file AthenaConverterTLPExtension.h.

◆ extCnvMapMap_t

typedef std::map<TopLevelTPCnvBase*, extCnvMap_t*> AthenaConverterTLPExtension::extCnvMapMap_t

protected

Definition at line 138 of file AthenaConverterTLPExtension.h.

Constructor & Destructor Documentation

◆ AthenaConverterTLPExtension()

AthenaConverterTLPExtension::AthenaConverterTLPExtension ( )

inline

Constructor.

Definition at line 46 of file AthenaConverterTLPExtension.h.

46 : m_TLCnvForReading(0) {}

◆ ~AthenaConverterTLPExtension()

AthenaConverterTLPExtension::~AthenaConverterTLPExtension ( )

virtual

Destructor.

Definition at line 164 of file AthenaConverterTLPExtension.cxx.

 {
    // cout << "Deleting " << m_clonedExtendingCnvs.size() << " extending converters" << endl;
    for( size_t c = 0; c < m_clonedExtendingCnvs.size(); c++ )
       delete m_clonedExtendingCnvs[c];
    for( extCnvMapMap_t::const_iterator mmiter = m_extCnvMapMap.begin();
         mmiter != m_extCnvMapMap.end(); ++mmiter ) {
       delete mmiter->second;
    }
    
 }

Member Function Documentation

◆ clone()

virtual AthenaConverterTLPExtension* AthenaConverterTLPExtension::clone ( )

inlinevirtual

Clone this Athena Converter.

Returns the cloned instance

Definition at line 70 of file AthenaConverterTLPExtension.h.

70 { return 0; }

◆ deletePersistentObjects()

void AthenaConverterTLPExtension::deletePersistentObjects ( )

virtual

Delete persistent objects held by attached extending converters (used mainly in case of abort)

Definition at line 148 of file AthenaConverterTLPExtension.cxx.

 {
    for( extCnvMap_t::const_iterator cnv = m_extendingConverters.begin();
     cnv != m_extendingConverters.end(); ++cnv ) {
       cnv->second->deletePersistentObjects();
    }
    for( size_t c = 0; c < m_clonedExtendingCnvs.size(); c++ )
       m_clonedExtendingCnvs[c]->deletePersistentObjects();
  
    getTopLevelTPCnv()->deleteTLPersObject();
    // Can not do that - sometimes the converter is an automatic variable that is gone already
    //if( m_TLCnvForReading ) m_TLCnvForReading->deleteTLPersObject();
 }

◆ getTopLevelTPCnv()

virtual TopLevelTPCnvBase* AthenaConverterTLPExtension::getTopLevelTPCnv ( )

pure virtual

returns the main top-level TP converter

To be implemented in the actual Converter implementation *

Implemented in JetCollectionCnv, TrackCollectionCnv, SegmentCollectionCnv, and VxContainerCnv.

◆ getTopLevelTPCnvForReading()

TopLevelTPCnvBase* AthenaConverterTLPExtension::getTopLevelTPCnvForReading ( )

inline

returns the current top-level TP converter.

This converter may be different from the main one in case of schema evolution

Definition at line 100 of file AthenaConverterTLPExtension.h.

100 { return m_TLCnvForReading; }

◆ getTPCnvID()

unsigned short AthenaConverterTLPExtension::getTPCnvID ( )

Returns the ID of the main top-level TP converter.

Definition at line 23 of file AthenaConverterTLPExtension.cxx.

                                         {
    return getTopLevelTPCnv()->getConverterID();
 }

◆ name()

virtual const std::string AthenaConverterTLPExtension::name ( ) const

inlinevirtual

Get name of this converter (anything that identifies it)

Returns: Name of this converter

Definition at line 85 of file AthenaConverterTLPExtension.h.

85 { return "Extended Athena TP Converter"; }

◆ needsCloning()

virtual bool AthenaConverterTLPExtension::needsCloning ( ) const

inlinevirtual

Find out if this converter needs to be cloned Returns true if this converter was already registered once.

Definition at line 80 of file AthenaConverterTLPExtension.h.

80 { return false; }

◆ readExtendingObjects()

void AthenaConverterTLPExtension::readExtendingObjects ( void * baseObj )

virtual

Read all component persistent objects.

Parameters

baseObj [IN] pointer to the principal persistent object holding the list of tokens for all component persistent objects to read

Definition at line 99 of file AthenaConverterTLPExtension.cxx.

 {
    // m_TLCnvForReading may be 0 if reading pre-TP object
    if( m_TLCnvForReading ) {
       TPCnvTokenList_p1     *tokens = m_TLCnvForReading->getTokenListVarFrom( baseObj );
       if( tokens && tokens->size() ) {
          // find which extending converter "set" to use
          extCnvMap_t *extendingConverters;
      if( getTopLevelTPCnv() == m_TLCnvForReading ) {
         // use the newest TP converters
         extendingConverters = &m_extendingConverters;
      } else {
         extCnvMapMap_t::const_iterator extCnvMapIter = m_extCnvMapMap.find(m_TLCnvForReading);
         if( extCnvMapIter == m_extCnvMapMap.end() ) {
            throw std::runtime_error("Extending TP converter not available");
         }
         extendingConverters = extCnvMapIter->second;
      }
      // load the remaining "pieces" of this object
      for( TPCnvTokenList_p1::const_iterator it = tokens->begin(); it != tokens->end(); ++it ) {
             if( it->token().size() < 36 ) {
                ostringstream err;
                err << "Corrupted Token in the list of extensions. Token='" << it->token() << "'"
                    << " CnvID=" << it->converterID() << ", Token list size=" << tokens->size();
            throw std::runtime_error(err.str());
             }              
         extCnvMap_t::const_iterator cnv = extendingConverters->find( it->converterID() );
         if( cnv == extendingConverters->end() ) {
                ostringstream err;
                err << "Extending TP converter not loaded! "
                    << "missing ExtCnvID=" << it->converterID()
                    << " corresponding POOL token: " << it->token();
            throw std::runtime_error(err.str());
         }
 //      std::cout << "--->>---  readExtendingObjects: "
 //            << " converter ID=" <<  it->converterID()
 //            << " token=" << it->token() << ", AP converter=" << cnv->second << std::endl;
  
         cnv->second->readObject( it->token() );
         TopLevelTPCnvBase *extTPCnv = cnv->second->getTopLevelTPCnvForReading();
         extTPCnv->addTPConvertersForReadingTo( m_TLCnvForReading );
      }
       }
    }
 }

◆ readObject()

virtual void AthenaConverterTLPExtension::readObject ( const std::string & )

inlinevirtual

Read the extending object.

Parameters

token [IN] Token of the object to read

Definition at line 65 of file AthenaConverterTLPExtension.h.

65 { }

◆ registerExtendingCnv()

bool AthenaConverterTLPExtension::registerExtendingCnv ( AthenaConverterTLPExtension * cnv )

virtual

Register extending converter (that is, another converter that will extent this converter) and all his elemental converters.

Parameters

cnv	[IN] pointer to extending Athena converter

Reimplemented in AthenaPoolCnvTPExtension.

Definition at line 28 of file AthenaConverterTLPExtension.cxx.

 {
    // check if all converter IDs are unique
    int  extendingTPLCnvID = extending_converter->getTPCnvID();
    if( extendingTPLCnvID == this->getTPCnvID()
        || m_extendingConverters.find( extendingTPLCnvID ) != m_extendingConverters.end() ) {
       ostringstream error;
       error << "Conflicting TP converter IDs when registering extending Athena Converter. ID=" << extendingTPLCnvID;
       throw runtime_error( error.str() );
    }
    AthenaConverterTLPExtension *cloned_converter;
    if( ! extending_converter->needsCloning() ) {
       cloned_converter = extending_converter;
       // cout << " TPCNVINFO: TP converter not cloned CLID=" << cnv->name() << endl;
    } else {
       // get a private converter copy
       cloned_converter = extending_converter->clone();
       if( !cloned_converter ) {
          ostringstream error;
          error << "Extending TP converter neeeds to define clone() method. Converter: " << extending_converter->name();
          throw runtime_error( error.str() );
       } 
       //cout << " TPCNVINFO: Cloned extending TP converter " << " Converter CLID=" << extending_converter->name() << endl;
       m_clonedExtendingCnvs.push_back( cloned_converter );
    }
    cloned_converter->wasClonedFrom( extending_converter );
    m_extendingConverters[ extendingTPLCnvID ] = cloned_converter;
    return true;
 }

◆ resetTPCnvForReading()

void AthenaConverterTLPExtension::resetTPCnvForReading ( )

inline

Reset to 0 the TL TP converter for reading.

Prevents the use of the previous TP converter if none was set before reading the next object Called automatically after reading an object.

Definition at line 111 of file AthenaConverterTLPExtension.h.

111 { m_TLCnvForReading = 0; }

◆ usingTPCnvForReading() [1/2]

void AthenaConverterTLPExtension::usingTPCnvForReading ( TopLevelTPCnvBase & cnv )

Sets top-level TP converter to be used for reading the next object.

Parameters

cnv	[IN] top-level TP converter to be used for reading the next

Definition at line 65 of file AthenaConverterTLPExtension.cxx.

 {
    m_TLCnvForReading = &baseTLPcnv;
  
    if( getTopLevelTPCnv() != m_TLCnvForReading ) {
       // we are reading an old class version
       if( m_extendingConverters.size()
       && m_extCnvMapMap.find( m_TLCnvForReading ) == m_extCnvMapMap.end() ) {
          // it is first time we use this TLP converter (for the old version)
          extCnvMap_t *newCnvMap = new extCnvMap_t;
          m_extCnvMapMap[ m_TLCnvForReading ] = newCnvMap;
  
          // copy clones of all extending converters to a new converter map 
          for( extCnvMap_t::const_iterator cnvI = m_extendingConverters.begin();
               cnvI != m_extendingConverters.end(); ++cnvI ) {
             AthenaConverterTLPExtension *cloned_converter = cnvI->second->clone();
             if( !cloned_converter ) {
                // basically panicking, this is not a runtime exception but an incomplete converter implementation
                ostringstream error;
                error << " TPCNVINFO: ERROR!  This extending TP converter does not define clone() method. "
                      << " Converter: " << cnvI->second->name();
                cerr << error.str() << endl;
                throw runtime_error( error.str() );
             }
             m_clonedExtendingCnvs.push_back( cloned_converter );
             cloned_converter->wasClonedFrom( cnvI->second );
             (*newCnvMap)[ cloned_converter->getTPCnvID() ] = cloned_converter;
             // this would be only necessary for writing, but we don't write old versions
             //cloned_converter->getTopLevelTPCnv()->addTPConvertersTo( this->getTopLevelTPCnv() );
          }
       }
    }
 }

◆ usingTPCnvForReading() [2/2]

void AthenaConverterTLPExtension::usingTPCnvForReading ( void * cnv )

protected

Definition at line 59 of file AthenaConverterTLPExtension.cxx.

 {
    usingTPCnvForReading( *reinterpret_cast<TopLevelTPCnvBase*>( cnv ) );
 }

◆ wasClonedFrom()

virtual void AthenaConverterTLPExtension::wasClonedFrom ( AthenaConverterTLPExtension * )

inlinevirtual

Remember the original converter that this one was cloned from.

Parameters

converter [IN] the original converter

Definition at line 75 of file AthenaConverterTLPExtension.h.

75 {}

◆ writeObject()

virtual const Token* AthenaConverterTLPExtension::writeObject	(	const std::string &	,
		const std::string &
	)

inlinevirtual

Writes the extending persistent object created by this converter Called from the EXTENDED (principal) Athena converter Implemented only in EXTENDING Athena converters.

Parameters

key	[in] StoreGet object key (in APR used to determine storage container placement) Retursn Token for the written object

Definition at line 60 of file AthenaConverterTLPExtension.h.

60 { return 0; }

Member Data Documentation

◆ m_clonedExtendingCnvs

std::vector< AthenaConverterTLPExtension* > AthenaConverterTLPExtension::m_clonedExtendingCnvs

protected

list of duplicated converters to delete at the end held in the original converter

Definition at line 151 of file AthenaConverterTLPExtension.h.

◆ m_extCnvMapMap

extCnvMapMap_t AthenaConverterTLPExtension::m_extCnvMapMap

protected

Definition at line 141 of file AthenaConverterTLPExtension.h.

◆ m_extendingConverters

extCnvMap_t AthenaConverterTLPExtension::m_extendingConverters

protected

map of Athena converters extending this one

Definition at line 136 of file AthenaConverterTLPExtension.h.

◆ m_TLCnvForReading

TopLevelTPCnvBase* AthenaConverterTLPExtension::m_TLCnvForReading

protected

additional Top Level TP converter used only for reading tells which converter is used in case of reading old versions (as different versions have different converters) NOT owned byt his class

Definition at line 147 of file AthenaConverterTLPExtension.h.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ extCnvMap_t

◆ extCnvMapMap_t

Constructor & Destructor Documentation

◆ AthenaConverterTLPExtension()

◆ ~AthenaConverterTLPExtension()

Member Function Documentation

◆ clone()

◆ deletePersistentObjects()

◆ getTopLevelTPCnv()

◆ getTopLevelTPCnvForReading()

◆ getTPCnvID()

◆ name()

◆ needsCloning()

◆ readExtendingObjects()

◆ readObject()

◆ registerExtendingCnv()

◆ resetTPCnvForReading()

◆ usingTPCnvForReading() [1/2]

◆ usingTPCnvForReading() [2/2]

◆ wasClonedFrom()

◆ writeObject()

Member Data Documentation

◆ m_clonedExtendingCnvs

◆ m_extCnvMapMap

◆ m_extendingConverters

◆ m_TLCnvForReading