Base class for top-level TP converters. More...

#include <TopLevelTPCnvBase.h>

Collaboration diagram for TopLevelTPCnvBase:

Public Member Functions
	TopLevelTPCnvBase ()
virtual	~TopLevelTPCnvBase ()
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 bool	hasTLPersObject () const =0
	Returns `true` if the converter has a persistent object.
virtual void *	getTLPersObjectAsVoid ()=0
virtual const void *	getTLPersObjectAsVoid () const =0
virtual void	createTLPersObject ()=0
	Create persistent object - the converter keeps it.
virtual void	deleteTLPersObject ()=0
	Delete the persistent object owned by the converter.
virtual void	clearTLPersObject ()=0
	Discard the persistent object.
virtual void	setTLPersObject (void *persObj)=0
	Take ownership of the persistent object.
virtual TPCnvTokenList_p1 *	getTokenListVar ()=0
	Return the list of tokens to the objects extending the object owned by this converter.
virtual TPCnvTokenList_p1 *	getTokenListVarFrom (void *persObj)=0
	Return the list of tokens to the objects extending the object NOT owned by this converter.
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
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

Base class for top-level TP converters.

Base (not templated) class for all top-level TP converters. Provides:

handling of elemental TP converters
typeless interface to access the persistent object being converted by this top-level converter

Definition at line 31 of file TopLevelTPCnvBase.h.

Member Typedef Documentation

◆ convIdMap_t

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

protected

Definition at line 174 of file TopLevelTPCnvBase.h.

Constructor & Destructor Documentation

◆ TopLevelTPCnvBase()

TopLevelTPCnvBase::TopLevelTPCnvBase ( )

inline

Definition at line 34 of file TopLevelTPCnvBase.h.

34: m_typeIDCount(0) { }

TopLevelTPCnvBase::m_typeIDCount

unsigned m_typeIDCount

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

Definition TopLevelTPCnvBase.h:187

◆ ~TopLevelTPCnvBase()

virtual TopLevelTPCnvBase::~TopLevelTPCnvBase ( )

inlinevirtual

Definition at line 36 of file TopLevelTPCnvBase.h.

36{ }

Member Function Documentation

◆ addExtTPConverterForReading()

void TopLevelTPCnvBase::addExtTPConverterForReading ( ITPConverter * cnv )

virtual

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 )

virtual

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 )

virtual

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 )

privatevirtual

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 )

virtual

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 )

virtual

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

virtual void TopLevelTPCnvBase::clearTLPersObject ( )

pure virtual

Discard the persistent object.

◆ converterForRef()

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

inline

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

inline

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

virtual void TopLevelTPCnvBase::createTLPersObject ( )

pure virtual

Create persistent object - the converter keeps it.

◆ deleteTLPersObject()

virtual void TopLevelTPCnvBase::deleteTLPersObject ( )

pure virtual

Delete the persistent object owned by the converter.

◆ getConverterID()

virtual unsigned short TopLevelTPCnvBase::getConverterID ( )

pure virtual

Returns: ID of the converter

◆ getTLPersObjectAsVoid() [1/2]

virtual const void * TopLevelTPCnvBase::getTLPersObjectAsVoid ( ) const

pure virtual

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

Implemented in TopLevelTPCnvBaseP< TL_PERS >.

◆ getTLPersObjectAsVoid() [2/2]

virtual void * TopLevelTPCnvBase::getTLPersObjectAsVoid ( )

pure virtual

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

◆ getTokenListVar()

virtual TPCnvTokenList_p1 * TopLevelTPCnvBase::getTokenListVar ( )

pure virtual

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

◆ getTokenListVarFrom()

virtual TPCnvTokenList_p1 * TopLevelTPCnvBase::getTokenListVarFrom ( void * persObj )

pure virtual

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

◆ hasConvertersFrom()

bool TopLevelTPCnvBase::hasConvertersFrom ( TopLevelTPCnvBase * cnv )

inlineprotected

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

virtual bool TopLevelTPCnvBase::hasTLPersObject ( ) const

pure virtual

Returns true if the converter has a persistent object.

◆ rememberConverter()

void TopLevelTPCnvBase::rememberConverter ( TopLevelTPCnvBase * cnv )

inlineprotected

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

◆ setTLPersObject()

virtual void TopLevelTPCnvBase::setTLPersObject ( void * persObj )

pure virtual

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*

Member Data Documentation

◆ m_converters

TPConverterTypeMap< ITPConverter > TopLevelTPCnvBase::m_converters

protected

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

protected

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

protected

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

Definition at line 184 of file TopLevelTPCnvBase.h.

◆ m_typeIDCount

unsigned TopLevelTPCnvBase::m_typeIDCount

protected

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 files:

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ convIdMap_t

Constructor & Destructor Documentation

◆ TopLevelTPCnvBase()

◆ ~TopLevelTPCnvBase()

Member Function Documentation

◆ addExtTPConverterForReading()

◆ addTPConverter()

◆ addTPConverterForReading()

◆ addTPConverterForWriting()

◆ addTPConvertersForReadingTo()

◆ addTPConvertersTo()

◆ clearTLPersObject()

◆ converterForRef()

◆ converterForType()

◆ createTLPersObject()

◆ deleteTLPersObject()

◆ getConverterID()

◆ getTLPersObjectAsVoid() [1/2]

◆ getTLPersObjectAsVoid() [2/2]

◆ getTokenListVar()

◆ getTokenListVarFrom()

◆ hasConvertersFrom()

◆ hasTLPersObject()

◆ rememberConverter()

◆ setTLPersObject()

Member Data Documentation

◆ m_converters

◆ m_convIdMap

◆ m_registeredTLConverters

◆ m_typeIDCount