#include <TPConverter.h>

Inherits TPConverterBase< TRANS, PERS >.

Collaboration diagram for TPConverterConstBase< TRANS, PERS >:

Public Types
using	base_class = TPConverterConstBase

typedef TRANS	Trans_t

typedef PERS	Pers_t

typedef PERS	PersBase_t

typedef TRANS	TransBase_t

typedef ITPConverterFor< TRANS >	PolyCnvBase_t

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

Public Member Functions
virtual void	persToTrans (const PERS persObj, TRANS transObj, MsgStream &log) const =0
	Convert persistent representation to transient one. More...

virtual void	transToPers (const TRANS transObj, PERS persObj, MsgStream &log) const =0
	Convert transient representation to persistent one. More...

virtual void	persToTrans (const PERS persObj, TRANS transObj, MsgStream &log) override final
	Convert persistent representation to transient one. More...

virtual void	transToPers (const TRANS transObj, PERS persObj, MsgStream &log) override final
	Convert transient representation to persistent one. More...

virtual TRANS *	createTransientConst (const PERS *persObj, MsgStream &log) const

virtual PERS *	createPersistentConst (const TRANS *transObj, MsgStream &log) const

virtual TPObjRef	virt_toPersistent (const TRANS *trans, MsgStream &log)
	Internal interface method that is used to invoke the real conversion method (toPersistent_impl) in the derived converter. More...

virtual TPObjRef	virt_toPersistentWithKey (const TRANS *trans, const std::string &key, MsgStream &log)
	Internal interface method that is used to invoke the real conversion method (toPersistent_impl) in the derived converter. More...

virtual void	pstoreToTrans (unsigned index, TRANS *trans, MsgStream &log)
	Convert persistent representation stored in the storage vector of the top-level object to transient. More...

virtual TRANS *	createTransient (const PERS *persObj, MsgStream &log)
	Create transient representation of a persistent object. More...

virtual TRANS *	createTransientWithKey (const PERS *persObj, const std::string &key, MsgStream &log)
	Create transient representation of a persistent object, with SG key. More...

virtual TRANS *	virt_createTransFromPStore (unsigned index, MsgStream &log)
	Internal interface method that is used to invoke the real conversion method (createTransient) More...

virtual TRANS *	virt_createTransFromPStoreWithKey (unsigned index, const std::string &key, MsgStream &log)
	Internal interface method that is used to invoke the real conversion method (createTransient) More...

virtual void	persToTransWithKey (const PERS persObj, TRANS transObj, const std::string &, MsgStream &log)
	Convert persistent representation to transient one. More...

virtual void	transToPersWithKey (const TRANS transObj, PERS persObj, const std::string &, MsgStream &log)
	Convert transient representation to persistent one. More...

virtual void	persToTransUntyped (const void pers, void trans, MsgStream &log)
	Convert persistent object representation to transient. More...

virtual void	transToPersUntyped (const void trans, void pers, MsgStream &log)
	Convert transient object representation to persistent. More...

virtual void	persToTransWithKeyUntyped (const void pers, void trans, const std::string &key, MsgStream &log)
	Convert persistent object representation to transient. More...

virtual void	transToPersWithKeyUntyped (const void trans, void pers, const std::string &key, MsgStream &log)
	Convert transient object representation to persistent. More...

virtual PERS *	createPersistent (const TRANS *transObj, MsgStream &log)
	Create persistent representation of a transient object. More...

virtual PERS *	createPersistentWithKey (const TRANS *transObj, const std::string &key, MsgStream &log)
	Create persistent representation of a transient object, with SG key. More...

TPObjRef	toPersistentWithKey_impl (const TRANS *trans, const std::string &key, MsgStream &log)
	Convert transient object to persistent representation. More...

virtual const std::type_info &	transientTInfo () const
	return C++ type id of the transient class this converter is for More...

virtual const std::type_info &	transientTInfo () const
	return C++ type id of the transient class this converter is for More...

virtual const std::type_info &	persistentTInfo () const
	return C++ type id of the persistent class this converter is for More...

virtual const std::type_info &	persistentTInfo () const =0
	return C++ type id of the persistent class this converter is for More...

void	setPStorage (std::vector< PERS > *storage)
	Tell this converter which storage vector it should use to store or retrieve persistent representations. More...

void	setRecursive (bool flag=true)
	Tell the converter if it should work in recursive mode slower but it can safely handle recursion. More...

void	ignoreRecursion (bool flag=false)
	Tell the converter to ignore recursion (do not throw errors) even when recurion is detected. More...

virtual void	reservePStorage (size_t size)
	Reserve 'size' elements for persistent storage. More...

template<class CNV >
CNV *	converterForType (CNV *cnv, const std::type_info &t_info, MsgStream &log) const
	Find converter for a given C++ type ID, that is or ihnerits from CNV type. More...

template<class CNV >
CNV *	converterForRef (CNV *cnv, const TPObjRef &ref, MsgStream &log) const
	Find converter for a TP type ID (passed in a TP Ref), that is or ihnerits from CNV type. More...

template<class CNV >
TPObjRef	baseToPersistent (CNV *cnv, const typename CNV::Trans_t transObj, MsgStream &log) const
	Persistify bass class of a given object and store the persistent represenation in the storage vector of the top-level persistent object. More...

template<class CNV >
TPObjRef	toPersistent (CNV *cnv, const typename CNV::TransBase_t transObj, MsgStream &log) const
	Persistify an object and store the persistent represenation in the storage vector of the top-level persistent object. More...

template<class CNV , class TRANS_T >
void	fillTransFromPStore (CNV *cnv, const TPObjRef &ref, TRANS_T trans, MsgStream &log) const
	Convert persistent object, stored in the the top-level persistent object and referenced by the TP Ref, to transient representation. More...

template<class CNV >
CNV::Trans_t *	createTransFromPStore (CNV **cnv, const TPObjRef &ref, MsgStream &log) const
	Create transient representation of a persistent object, stored in the the top-level persistent object and referenced by the TP Ref. More...

virtual void	initPrivateConverters (TopLevelTPCnvBase *)

virtual TopLevelTPCnvBase *	topConverter ()
	return the top-level converter for this elemental TP converter More...

virtual const TopLevelTPCnvBase *	topConverter () const
	return the top-level converter for this elemental TP converter More...

const std::type_info &	transBaseTInfo () const
	return C++ type id of the common base transient type for all converters for a group of polymorphic types More...

virtual const TPObjRef::typeID_t &	typeID () const
	Return TP typeID for persistent objects produced by this converter. More...

unsigned	typeIDvalue () const
	inlined non-virtual version to get the typeID value fast More...

virtual void	setRuntimeTopConverter (TopLevelTPCnvBase *topConverter)
	Set runtime top-level converter - usually it is the owning TL converter, but in case of extended objects it will be the TL converter of the extended object. More...

virtual void	setTopConverter (TopLevelTPCnvBase *topConverter, const TPObjRef::typeID_t &TPtypeID)
	Set which top-level converter owns this elemental converter, and what TPtypeID was assigned to the persistent objects it produces. More...

void	setReadingFlag ()

void	clearReadingFlag ()

bool	wasUsedForReading ()

virtual void	converterNotFound (const std::type_info &converterType, ITPConverter *c, const std::string &typeName, MsgStream &log) const
	method called when the right TP converter was not found during writing More...

virtual void	converterNotFound (unsigned typeID, ITPConverter *c, const std::string &typeName, MsgStream &log) const
	method called when the right TP converter was not found during reading More...

Protected Attributes
std::vector< PERS > *	m_pStorage
	the address of the storage vector for persistent representations More...

int	m_curRecLevel
	count recursive invocations, to detect recursion More...

bool	m_recursive
	if true, work in recursion-safe way (slower) More...

bool	m_ignoreRecursion
	if true, do not throw errors in case of recursion. More...

TPObjRef::typeID_t	m_pStorageTID
	TP Ref typeID for the persistent objects this converter is creating. More...

unsigned	m_pStorageTIDvalue
	m_pStorageTID converted to integer value More...

TopLevelTPCnvBase *	m_topConverter
	top level converter that owns this elemental TP converter it also holds the storage object More...

TopLevelTPCnvBase *	m_topConverterRuntime
	top level converter "owning" this TP converter at runtime (different from m_topConverter in case the top-level converter and object have extensions) More...

bool	m_wasUsedForReading
	flag set when using this converter for reading triggers search for a new converter before writing, to prevent possible use of old version More...

Detailed Description

template<class TRANS, class PERS>
class TPConverterConstBase< TRANS, PERS >

TP Converter template for a "regular" type. In contrast to TPConverterBase, this calls const methods to do the conversion.

Definition at line 774 of file TPConverter.h.

Member Typedef Documentation

◆ base_class

template<class TRANS , class PERS >

using TPConverterConstBase< TRANS, PERS >::base_class = TPConverterConstBase

Definition at line 779 of file TPConverter.h.

◆ Factory

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

inherited

Definition at line 26 of file ITPCnvBase.h.

◆ Pers_t

typedef PERS TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::Pers_t

inherited

Definition at line 335 of file TPConverter.h.

◆ PersBase_t

typedef PERS TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::PersBase_t

inherited

Definition at line 336 of file TPConverter.h.

◆ PolyCnvBase_t

template<class TRANS >

typedef ITPConverterFor< TRANS > ITPConverterFor< TRANS >::PolyCnvBase_t

inherited

Definition at line 41 of file TPConverter.h.

◆ Trans_t

typedef TRANS TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::Trans_t

inherited

Definition at line 334 of file TPConverter.h.

◆ TransBase_t

template<class TRANS >

typedef TRANS ITPConverterFor< TRANS >::TransBase_t

inherited

Definition at line 39 of file TPConverter.h.

Member Function Documentation

◆ baseToPersistent()

template<class TRANS >

template<class CNV >

TPObjRef ITPConverterFor< TRANS >::baseToPersistent	(	CNV **	cnv,
		const typename CNV::Trans_t *	transObj,
		MsgStream &	log
	)		const

inlineinherited

Persistify bass class of a given object and store the persistent represenation in the storage vector of the top-level persistent object.

The converter is located using the transient type from the CNV parameter, not from the object itself (because we need the base type, not the actual type)

Parameters

cnv	[IN/OUT] type of this parameter decides which converter will be used. Once the converter is found, this pointer will be set so the search is done only once
transObj	[IN] transient object
log	[IN] output message stream

Returns: TPObjRef TP reference to the persistent representation stored in the storage vector of the top-level persistent object

Definition at line 97 of file TPConverter.h.

                                                                                            {
      if( !*cnv || (*cnv)->wasUsedForReading() ) {
         // don't trust the converter if it was used for reading, find again
     *cnv = converterForType( *cnv, typeid(typename CNV::Trans_t), log );
     if( !*cnv )  return TPObjRef();
         (*cnv)->clearReadingFlag();
      }
 //     return (**cnv).toPersistent_impl(transObj, log); 
      return (**cnv).virt_toPersistent(transObj, log); 
   }

◆ clearReadingFlag()

template<class TRANS >

void ITPConverterFor< TRANS >::clearReadingFlag ( )

inlineinherited

Definition at line 235 of file TPConverter.h.

235 { m_wasUsedForReading = false; }

◆ converterForRef()

template<class TRANS >

template<class CNV >

CNV* ITPConverterFor< TRANS >::converterForRef	(	CNV *	cnv,
		const TPObjRef &	ref,
		MsgStream &	log
	)		const

inlineinherited

Find converter for a TP type ID (passed in a TP Ref), that is or ihnerits from CNV type.

Parameters

cnv	[IN] parameter specifying the converter type
ref	[IN] TP Ref to an object for which a converter is sought
log	[IN] output message stream

Returns: CNV* pointer to the converter, if found

Definition at line 74 of file TPConverter.h.

                                                                          {
      ITPConverter *c = m_topConverterRuntime->converterForRef( ref );
      cnv = dynamic_cast<CNV*>(c);
      if( !cnv )
         this->converterNotFound( ref.typeID(), c, typeid(CNV).name(), log );
      return cnv;
   }

◆ converterForType()

template<class TRANS >

template<class CNV >

CNV* ITPConverterFor< TRANS >::converterForType	(	CNV *	cnv,
		const std::type_info &	t_info,
		MsgStream &	log
	)		const

inlineinherited

Find converter for a given C++ type ID, that is or ihnerits from CNV type.

Parameters

cnv	[IN] parameter specifying the converter type
t_info	[IN] C++ type id for which a converter is sought
log	[IN] output message stream

Returns: CNV* pointer to the converter, if found

Definition at line 58 of file TPConverter.h.

                                                                                  {
      ITPConverter *c = m_topConverterRuntime->converterForType( t_info );
      cnv = dynamic_cast< CNV* >( c );
      if( !cnv )
     this->converterNotFound( typeid(CNV), c, t_info.name(), log );
      return cnv;
   }

◆ converterNotFound() [1/2]

void ITPConverter::converterNotFound	(	const std::type_info &	converterType,
		ITPConverter *	c,
		const std::string &	typeName,
		MsgStream &	log
	)		const

virtualinherited

method called when the right TP converter was not found during writing

useful as a debugging hook, prints a detailed error message

Parameters

converterType	[IN] converterType that was requested
c	[IN] converter that was actually found (0 if not)
typeName	[IN] the C++ type name of the type for which converter was searched for
log	[IN] output message stream

Definition at line 22 of file ITPConverter.cxx.

 {
    log << MSG::ERROR << ">>>>>> in parent TP converter " << typeid(*this).name()
        << ": could not find matching TP converter for type " << typeName << endmsg;
    if( c ) {
       log << MSG::ERROR << " - found incompatible converter of type "
       << typeid(*c).name() << endmsg;
    }
    log << MSG::ERROR << "  Converter handle type was " << converterType.name() << endmsg;
    errorHandler();
 }

◆ converterNotFound() [2/2]

void ITPConverter::converterNotFound	(	unsigned	typeID,
		ITPConverter *	c,
		const std::string &	typeName,
		MsgStream &	log
	)		const

virtualinherited

method called when the right TP converter was not found during reading

useful as a debugging hook, prints a detailed error message

Parameters

typeID	[IN] converter ID that was requested
c	[IN] converter that was actually found (0 if not)
typeName	[IN] the C++ type name of the type for which converter was searched for
log	[IN] output message stream

Definition at line 40 of file ITPConverter.cxx.

 {
    log << MSG::ERROR << ">>>>>> in parent TP converter " <<  typeid(*this).name()
        << "   requested TP converter for TP type ID " << typeID << " not found " << endmsg;
    if( c ) {
       log << MSG::ERROR << " - found converter " <<  typeid(*c).name()
           << " for " << c->transientTInfo().name()
           << " with an incompatible base type " << c->transBaseTInfo().name()
           << endmsg;
    }
    log << MSG::ERROR << "  Converter handle type was " << reqCnvTypeName <<  endmsg;
    errorHandler();
 }

◆ createPersistent()

virtual PERS* TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::createPersistent	(	const TRANS *	transObj,
		MsgStream &	log
	)

virtualinherited

Create persistent representation of a transient object.

Simply creates a new persistent object and calls transToPers()

Parameters

transObj	[IN] transient object
log	[IN] output message stream

Returns: the created persistent representation

◆ createPersistentConst()

template<class TRANS , class PERS >

virtual PERS* TPConverterConstBase< TRANS, PERS >::createPersistentConst	(	const TRANS *	transObj,
		MsgStream &	log
	)		const

virtual

◆ createPersistentWithKey()

virtual PERS* TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::createPersistentWithKey	(	const TRANS *	transObj,
		const std::string &	key,
		MsgStream &	log
	)

virtualinherited

Create persistent representation of a transient object, with SG key.

Simply creates a new persistent object and calls transToPersWithKey()

Parameters

transObj	[IN] transient object
key	[IN] SG key of object being written
log	[IN] output message stream

Returns: the created persistent representation

◆ createTransFromPStore()

template<class TRANS >

template<class CNV >

CNV::Trans_t* ITPConverterFor< TRANS >::createTransFromPStore	(	CNV **	cnv,
		const TPObjRef &	ref,
		MsgStream &	log
	)		const

inlineinherited

Create transient representation of a persistent object, stored in the the top-level persistent object and referenced by the TP Ref.

If a TP converter is not specified, it will be found based on the Ref type.

Parameters

cnv	[IN][OUT] pointer to the converter, usually 0 at the start. Once the right converter is found, this pointer will be set so the search is done only once
ref	[IN] TP Ref to the persistent object to be converted
log	[IN] output message stream

Returns: pointer to the created transient represention

Definition at line 172 of file TPConverter.h.

                                                                                {
      if( ref.isNull() )  return 0;
      CNV *temp_cnv_p = 0;
      if( !cnv ) cnv = &temp_cnv_p;
      // see if we already have a converter and if it is the right one
      if( !*cnv || (*cnv)->typeID().value() != ref.typeID() ) {
         // we don't - find the right converter for ref.typeID()
     *cnv = converterForRef( *cnv, ref, log );
     if( !*cnv ) return 0;
         (*cnv)->setReadingFlag();
      }
      return (**cnv).virt_createTransFromPStore( ref.index(), log );
   }

◆ createTransient()

virtual TRANS* TPPolyCnvBase< TRANS , TRANS, PERS >::createTransient	(	const PERS *	persObj,
		MsgStream &	log
	)

virtualinherited

Create transient representation of a persistent object.

Simply creates a new transient object and calls persToTrans()

Parameters

persObj	[IN] persistent object
log	[IN] output message stream

Returns: the created transient object

◆ createTransientConst()

template<class TRANS , class PERS >

virtual TRANS* TPConverterConstBase< TRANS, PERS >::createTransientConst	(	const PERS *	persObj,
		MsgStream &	log
	)		const

virtual

◆ createTransientWithKey()

virtual TRANS* TPPolyCnvBase< TRANS , TRANS, PERS >::createTransientWithKey	(	const PERS *	persObj,
		const std::string &	key,
		MsgStream &	log
	)

virtualinherited

Create transient representation of a persistent object, with SG key.

Simply creates a new transient object and calls persToTransWithKey()

Parameters

persObj	[IN] persistent object
key	[IN] SG key of object being read
log	[IN] output message stream

Returns: the created transient object

◆ fillTransFromPStore()

template<class TRANS >

template<class CNV , class TRANS_T >

void ITPConverterFor< TRANS >::fillTransFromPStore	(	CNV **	cnv,
		const TPObjRef &	ref,
		TRANS_T *	trans,
		MsgStream &	log
	)		const

inlineinherited

Convert persistent object, stored in the the top-level persistent object and referenced by the TP Ref, to transient representation.

An empty transient object to be filled in is provided. If converter is not given, it will be found based on the Ref type.

Parameters

cnv	[IN][OUT] pointer to the converter, usually 0 at the start. Once the right converter is found, this pointer will be set so the search is done only once
ref	[IN] TP Ref to the persistent object to be converted
trans	[IN] pointer to the empty transient object
log	[IN] output message stream

Definition at line 145 of file TPConverter.h.

                                                                                                     {
     if( ref.isNull() )  return;
     CNV *temp_cnv_p = 0;
     if( !cnv ) cnv = &temp_cnv_p;
     // see if we already have a converter and if it is the right one
     if( !*cnv || (*cnv)->typeID().value() != ref.typeID() ) {
        // we don't - find the right converter for ref.typeID()
        *cnv = converterForRef( *cnv, ref, log );
        if( !*cnv ) return;
        (*cnv)->setReadingFlag();
      }
     (**cnv).pstoreToTrans( ref.index(), trans, log );
   }

◆ ignoreRecursion()

void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::ignoreRecursion ( bool flag = false )

inlineinherited

Tell the converter to ignore recursion (do not throw errors) even when recurion is detected.

UNSAFE! use only if you are sure you preallocated enough persistent storage

Definition at line 568 of file TPConverter.h.

                                            {
      m_ignoreRecursion = flag;
   }

◆ initPrivateConverters()

template<class TRANS >

virtual void ITPConverterFor< TRANS >::initPrivateConverters ( TopLevelTPCnvBase * )

inlinevirtualinherited

Reimplemented in JetConverterBase< Jet_p5 >, JetConverterBase< Jet_p6 >, JetCnv_p4, TauPi0DetailsCnv_p2, TauPi0ClusterCnv_p1, TauPi0DetailsCnv_p1, TauPi0CandidateCnv_p1, TrackParticleBaseCnv_p1, TrigVertexCnv_p1, TrigVertexCnv_p2, TrigInDetTrackCollectionCnv_p1, MeasuredNeutralAtaSurfaceCnv_p1< SURFACE_CNV, ATA_SURFACE >, MeasuredNeutralAtaSurfaceCnv_p1< NeutralAtaStraightLineCnv_p1, Trk::NeutralAtaStraightLine >, MeasuredNeutralAtaSurfaceCnv_p1< NeutralAtaPlaneCnv_p1, Trk::NeutralAtaPlane >, MeasuredNeutralAtaSurfaceCnv_p1< NeutralAtaDiscCnv_p1, Trk::NeutralAtaDisc >, MeasuredNeutralAtaSurfaceCnv_p1< NeutralAtaCylinderCnv_p1, Trk::NeutralAtaCylinder >, SegmentCnv_p1, VxCandidateCnv_p1, MeasuredAtaSurfaceCnv_p1< SURFACE_CNV, ATA_SURFACE >, TrackCnv_p3, MeasuredAtaSurfaceCnv_p1< AtaDiscCnv_p1, Trk::AtaDisc >, MeasuredAtaSurfaceCnv_p1< AtaPlaneCnv_p1, Trk::AtaPlane >, MeasuredAtaSurfaceCnv_p1< AtaCylinderCnv_p1, Trk::AtaCylinder >, MeasuredAtaSurfaceCnv_p1< CurvilinearParametersCnv_p1, Trk::CurvilinearParameters >, MeasuredAtaSurfaceCnv_p1< AtaStraightLineCnv_p1, Trk::AtaStraightLine >, TrackParticleCnv_p2, TrackCnv_p1, TrackCnv_p2, TrackCnv_p4, TrackCnv_p12, V0CandidateCnv_p1, VxCandidateCnv_p2, and TrackParticleCnv_p3.

Definition at line 187 of file TPConverter.h.

187 {}

◆ persistentTInfo() [1/2]

virtual const std::type_info& TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::persistentTInfo ( ) const

inlinevirtualinherited

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

Returns: std::type_info&

Definition at line 482 of file TPConverter.h.

482 { return typeid(PERS); }

◆ persistentTInfo() [2/2]

virtual const std::type_info& ITPCnvBase::persistentTInfo ( ) const

pure virtualinherited

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

Returns: std::type_info&

Implemented in TopLevelTPConverter< MAIN_CNV, TL_PERS >, TPAbstractPolyCnvBase< TRANS_BASE, TRANS, PERS >, and DummyDetElementSurfaceCnv_p1.

◆ persToTrans() [1/2]

template<class TRANS , class PERS >

virtual void TPConverterConstBase< TRANS, PERS >::persToTrans	(	const PERS *	persObj,
		TRANS *	transObj,
		MsgStream &	log
	)		const

pure virtual

Convert persistent representation to transient one.

Copies data members from persistent object to an existing transient one. Needs to be implemented by the developer on the actual converter.

Parameters

persObj	[IN] persistent object
transObj	[IN] transient object
log	[IN] output message stream

◆ persToTrans() [2/2]

template<class TRANS , class PERS >

virtual void TPConverterConstBase< TRANS, PERS >::persToTrans	(	const PERS *	persObj,
		TRANS *	transObj,
		MsgStream &	log
	)

inlinefinaloverridevirtual

Convert persistent representation to transient one.

Copies data members from persistent object to an existing transient one. Needs to be implemented by the developer on the actual converter.

Parameters

persObj	[IN] persistent object
transObj	[IN] transient object
log	[IN] output message stream

Implements TPAbstractPolyCnvBase< TRANS, TRANS, PERS >.

Definition at line 807 of file TPConverter.h.

   {
     return const_cast<const TPConverterConstBase*>(this)->persToTrans (persObj, transObj, log);
   }

◆ persToTransUntyped()

virtual void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::persToTransUntyped	(	const void *	pers,
		void *	trans,
		MsgStream &	log
	)

inlinevirtualinherited

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 400 of file TPConverter.h.

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

◆ persToTransWithKey()

virtual void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::persToTransWithKey	(	const PERS *	persObj,
		TRANS *	transObj,
		const std::string &	,
		MsgStream &	log
	)

inlinevirtualinherited

Convert persistent representation to transient one.

Copies data members from persistent object to an existing transient one. Needs to be implemented by the developer on the actual converter.

Parameters

persObj	[IN] persistent object
transObj	[IN] transient object
log	[IN] output message stream

Reimplemented in TPConverterWithKeyBase< TRANS, PERS >.

Definition at line 376 of file TPConverter.h.

   {
     return persToTrans (persObj, transObj, log);
   }

◆ persToTransWithKeyUntyped()

virtual void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::persToTransWithKeyUntyped	(	const void *	pers,
		void *	trans,
		const std::string &	key,
		MsgStream &	log
	)

inlinevirtualinherited

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 420 of file TPConverter.h.

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

◆ pstoreToTrans()

template<class TRANS , class PERS >

virtual void TPConverterBase< TRANS, PERS >::pstoreToTrans	(	unsigned	index,
		TRANS *	trans,
		MsgStream &	log
	)

inlinevirtualinherited

Convert persistent representation stored in the storage vector of the top-level object to transient.

Internal.

Parameters

index	[IN] index of the persistent representation in the storage vector
trans	[IN] empty transient object
log	[IN] output message stream

Reimplemented from TPAbstractPolyCnvBase< TRANS, TRANS, PERS >.

Definition at line 760 of file TPConverter.h.

                                                                               {
      assert (index < this->m_pStorage->size());
      this->persToTrans( &(*this->m_pStorage)[index], trans, log );
   }

◆ reservePStorage()

virtual void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::reservePStorage ( size_t size )

inlinevirtualinherited

Reserve 'size' elements for persistent storage.

Implements ITPConverter.

Definition at line 573 of file TPConverter.h.

                                                {
      m_pStorage->reserve( size );
   }

◆ setPStorage()

void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::setPStorage ( std::vector< PERS > * storage )

inlineinherited

Tell this converter which storage vector it should use to store or retrieve persistent representations.

Parameters

storage [IN] the address of the storage vector

Definition at line 551 of file TPConverter.h.

                                                   {
      m_pStorage = storage;
      m_curRecLevel = 0;
   }

◆ setReadingFlag()

template<class TRANS >

void ITPConverterFor< TRANS >::setReadingFlag ( )

inlineinherited

Definition at line 234 of file TPConverter.h.

234 { m_wasUsedForReading = true; }

◆ setRecursive()

void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::setRecursive ( bool flag = true )

inlineinherited

Tell the converter if it should work in recursive mode slower but it can safely handle recursion.

Definition at line 559 of file TPConverter.h.

                                        {
      m_recursive = flag;
   }

◆ setRuntimeTopConverter()

template<class TRANS >

virtual void ITPConverterFor< TRANS >::setRuntimeTopConverter ( TopLevelTPCnvBase * topConverter )

inlinevirtualinherited

Set runtime top-level converter - usually it is the owning TL converter, but in case of extended objects it will be the TL converter of the extended object.

Parameters

topConverter [IN] runtime top-level converter for this converter

Implements ITPConverter.

Definition at line 215 of file TPConverter.h.

                                                                           {
      m_topConverterRuntime = topConverter;
      initPrivateConverters( topConverter );
   }

◆ setTopConverter()

template<class TRANS >

virtual void ITPConverterFor< TRANS >::setTopConverter	(	TopLevelTPCnvBase *	topConverter,
		const TPObjRef::typeID_t &	TPtypeID
	)

inlinevirtualinherited

Set which top-level converter owns this elemental converter, and what TPtypeID was assigned to the persistent objects it produces.

Parameters

topConverter	[IN] the top-level converter owning this converter
TPtypeID	[IN] TP type id for persistent objects (used in TP refs)

Implements ITPConverter.

Definition at line 221 of file TPConverter.h.

   {
      m_topConverter = m_topConverterRuntime = topConverter;
      m_pStorageTID = TPtypeID;
      m_pStorageTIDvalue = TPtypeID.value();
      initPrivateConverters( topConverter );
   }

◆ topConverter() [1/2]

template<class TRANS >

virtual TopLevelTPCnvBase* ITPConverterFor< TRANS >::topConverter ( )

inlinevirtualinherited

return the top-level converter for this elemental TP converter

Returns: TopLevelTPCnvBas

Reimplemented from ITPConverter.

Definition at line 191 of file TPConverter.h.

                                                {
      return m_topConverter;
   }

◆ topConverter() [2/2]

template<class TRANS >

virtual const TopLevelTPCnvBase* ITPConverterFor< TRANS >::topConverter ( ) const

inlinevirtualinherited

return the top-level converter for this elemental TP converter

Returns: TopLevelTPCnvBas

Reimplemented from ITPConverter.

Definition at line 196 of file TPConverter.h.

                                                          {
      return m_topConverter;
   }

◆ toPersistent()

template<class TRANS >

template<class CNV >

TPObjRef ITPConverterFor< TRANS >::toPersistent	(	CNV **	cnv,
		const typename CNV::TransBase_t *	transObj,
		MsgStream &	log
	)		const

inlineinherited

Persistify an object and store the persistent represenation in the storage vector of the top-level persistent object.

The correct converter is located using the actual object type.

Parameters

cnv	[IN/OUT] pointer to the converter, usually 0 at the start. Once the right converter is found, this pointer will be set so the search is done only once
transObj	[IN] transient object
log	[IN] output message stream

Returns: TPObjRef TP reference to the persistent representation stored in the storage vector of the top-level persistent object

Definition at line 119 of file TPConverter.h.

                                                                                                    {
      if( !transObj ) return TPObjRef();
      CNV *temp_cnv_p = 0;
      if( !cnv ) cnv = &temp_cnv_p;
      if( !*cnv || (*cnv)->wasUsedForReading() ) {
         // don't trust the converter if it was used for reading, find again
     *cnv = converterForType( *cnv, typeid(*transObj), log );
     if( !*cnv )  return TPObjRef();
         (*cnv)->clearReadingFlag();
      }
      return (**cnv).virt_toPersistent(transObj, log);
   }

◆ toPersistentWithKey_impl()

TPObjRef TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::toPersistentWithKey_impl	(	const TRANS *	trans,
		const std::string &	key,
		MsgStream &	log
	)

inherited

Convert transient object to persistent representation.

Stores the result in the storage vector of the top-level object and returns a TP Ref to it.

Parameters

trans	[IN] transient object
key	[IN] SG key of object being converted
log	[IN] output message stream

Returns: TP reference to the persistent representation

◆ transBaseTInfo()

template<class TRANS >

const std::type_info& ITPConverterFor< TRANS >::transBaseTInfo ( ) const

inlinevirtualinherited

return C++ type id of the common base transient type for all converters for a group of polymorphic types

Returns: std::type_info& this method is not overwritten in the subclasses like transientTInfo()

Implements ITPConverter.

Definition at line 205 of file TPConverter.h.

205 { return typeid(TRANS); }

◆ transientTInfo() [1/2]

template<class TRANS >

virtual const std::type_info& ITPConverterFor< TRANS >::transientTInfo ( ) const

inlinevirtualinherited

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

Returns: std::type_info&

Implements ITPCnvBase.

Definition at line 201 of file TPConverter.h.

201 { return typeid(TRANS); }

◆ transientTInfo() [2/2]

virtual const std::type_info& TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::transientTInfo ( ) const

inlinevirtualinherited

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

Returns: std::type_info&

Definition at line 479 of file TPConverter.h.

479 { return typeid(TRANS); }

◆ transToPers() [1/2]

template<class TRANS , class PERS >

virtual void TPConverterConstBase< TRANS, PERS >::transToPers	(	const TRANS *	transObj,
		PERS *	persObj,
		MsgStream &	log
	)		const

pure virtual

Convert transient representation to persistent one.

Copies data members from transient object to an existing persistent one. Needs to be implemented by the developer on the actual converter.

Parameters

transObj	[IN] transient object
persObj	[IN] persistent object
log	[IN] output message stream

◆ transToPers() [2/2]

template<class TRANS , class PERS >

virtual void TPConverterConstBase< TRANS, PERS >::transToPers	(	const TRANS *	transObj,
		PERS *	persObj,
		MsgStream &	log
	)

inlinefinaloverridevirtual

Convert transient representation to persistent one.

Copies data members from transient object to an existing persistent one. Needs to be implemented by the developer on the actual converter.

Parameters

transObj	[IN] transient object
persObj	[IN] persistent object
log	[IN] output message stream

Implements TPAbstractPolyCnvBase< TRANS, TRANS, PERS >.

Definition at line 815 of file TPConverter.h.

   {
     return const_cast<const TPConverterConstBase*>(this)->transToPers (transObj, persObj, log);
   }

◆ transToPersUntyped()

virtual void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::transToPersUntyped	(	const void *	trans,
		void *	pers,
		MsgStream &	log
	)

inlinevirtualinherited

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 410 of file TPConverter.h.

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

◆ transToPersWithKey()

virtual void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::transToPersWithKey	(	const TRANS *	transObj,
		PERS *	persObj,
		const std::string &	,
		MsgStream &	log
	)

inlinevirtualinherited

Convert transient representation to persistent one.

Copies data members from transient object to an existing persistent one. Needs to be implemented by the developer on the actual converter.

Parameters

transObj	[IN] transient object
persObj	[IN] persistent object
key	[IN] SG key of object being written.
log	[IN] output message stream

Reimplemented in TPConverterWithKeyBase< TRANS, PERS >.

Definition at line 392 of file TPConverter.h.

   {
     return transToPers (transObj, persObj, log);
   }

◆ transToPersWithKeyUntyped()

virtual void TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::transToPersWithKeyUntyped	(	const void *	trans,
		void *	pers,
		const std::string &	key,
		MsgStream &	log
	)

inlinevirtualinherited

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 432 of file TPConverter.h.

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

◆ typeID()

template<class TRANS >

virtual const TPObjRef::typeID_t& ITPConverterFor< TRANS >::typeID ( ) const

inlinevirtualinherited

Return TP typeID for persistent objects produced by this converter.

Returns: TPObjRef::typeID_t&

Implements ITPConverter.

Definition at line 208 of file TPConverter.h.

208 { return m_pStorageTID; }

◆ typeIDvalue()

template<class TRANS >

unsigned ITPConverterFor< TRANS >::typeIDvalue ( ) const

inlineinherited

inlined non-virtual version to get the typeID value fast

Definition at line 211 of file TPConverter.h.

211 { return m_pStorageTIDvalue; }

◆ virt_createTransFromPStore()

virtual TRANS* TPPolyCnvBase< TRANS , TRANS, PERS >::virt_createTransFromPStore	(	unsigned	index,
		MsgStream &	log
	)

inlinevirtualinherited

Internal interface method that is used to invoke the real conversion method (createTransient)

Parameters

index	[IN] index of the persistent object in the storage vector
log	[IN] output message stream

Returns: Created transient object (by pointer)

Reimplemented from TPAbstractPolyCnvBase< TRANS, TRANS, PERS >.

Definition at line 706 of file TPConverter.h.

                                                                                {
      assert (index < this->m_pStorage->size());
      return createTransient( &(*this->m_pStorage)[index], log );
   }

◆ virt_createTransFromPStoreWithKey()

virtual TRANS* TPPolyCnvBase< TRANS , TRANS, PERS >::virt_createTransFromPStoreWithKey	(	unsigned	index,
		const std::string &	key,
		MsgStream &	log
	)

inlinevirtualinherited

Internal interface method that is used to invoke the real conversion method (createTransient)

Parameters

index	[IN] index of the persistent object in the storage vector
key	[IN] SG key of the object being converted
log	[IN] output message stream

Returns: Created transient object (by pointer)

Reimplemented from TPAbstractPolyCnvBase< TRANS, TRANS, PERS >.

Definition at line 718 of file TPConverter.h.

   {
      assert (index < this->m_pStorage->size());
      return createTransientWithKey( &(*this->m_pStorage)[index], key, log );
   }

◆ virt_toPersistent()

template<class TRANS , class PERS >

virtual TPObjRef TPConverterBase< TRANS, PERS >::virt_toPersistent	(	const TRANS *	trans,
		MsgStream &	log
	)

inlinevirtualinherited

Internal interface method that is used to invoke the real conversion method (toPersistent_impl) in the derived converter.

Parameters

trans	[IN] transient object
log	[IN] output message stream

Returns: TPObjRef TP reference to the persistent representation stored in the storage vector of the top-level persistent object Here toPersistent_impl is invoked with the dynamic cast of the transient type pointer to it's actual type

Reimplemented from TPAbstractPolyCnvBase< TRANS, TRANS, PERS >.

Definition at line 747 of file TPConverter.h.

                                                                            {
     return this->toPersistentWithKey_impl( trans, "", log);
   }

◆ virt_toPersistentWithKey()

template<class TRANS , class PERS >

virtual TPObjRef TPConverterBase< TRANS, PERS >::virt_toPersistentWithKey	(	const TRANS *	trans,
		const std::string &	key,
		MsgStream &	log
	)

inlinevirtualinherited

Internal interface method that is used to invoke the real conversion method (toPersistent_impl) in the derived converter.

Parameters

trans	[IN] transient object
key	[IN] SG key of the object being converted.
log	[IN] output message stream

Returns: TPObjRef TP reference to the persistent representation stored in the storage vector of the top-level persistent object Here toPersistentWithKey_impl is invoked with the dynamic cast of the transient type pointer to it's actual type

Reimplemented from TPAbstractPolyCnvBase< TRANS, TRANS, PERS >.

Definition at line 752 of file TPConverter.h.

   {
      return this->toPersistentWithKey_impl( trans, key, log);
   }

◆ wasUsedForReading()

template<class TRANS >

bool ITPConverterFor< TRANS >::wasUsedForReading ( )

inlineinherited

Definition at line 236 of file TPConverter.h.

236 { return m_wasUsedForReading; }

Member Data Documentation

◆ m_curRecLevel

int TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::m_curRecLevel

protectedinherited

count recursive invocations, to detect recursion

Definition at line 582 of file TPConverter.h.

◆ m_ignoreRecursion

bool TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::m_ignoreRecursion

protectedinherited

if true, do not throw errors in case of recursion.

Definition at line 588 of file TPConverter.h.

◆ m_pStorage

std::vector< PERS >* TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::m_pStorage

protectedinherited

the address of the storage vector for persistent representations

Definition at line 579 of file TPConverter.h.

◆ m_pStorageTID

template<class TRANS >

TPObjRef::typeID_t ITPConverterFor< TRANS >::m_pStorageTID

protectedinherited

TP Ref typeID for the persistent objects this converter is creating.

Definition at line 292 of file TPConverter.h.

◆ m_pStorageTIDvalue

template<class TRANS >

unsigned ITPConverterFor< TRANS >::m_pStorageTIDvalue

protectedinherited

m_pStorageTID converted to integer value

Definition at line 295 of file TPConverter.h.

◆ m_recursive

bool TPAbstractPolyCnvBase< TRANS , TRANS, PERS >::m_recursive

protectedinherited

if true, work in recursion-safe way (slower)

Definition at line 585 of file TPConverter.h.

◆ m_topConverter

template<class TRANS >

TopLevelTPCnvBase* ITPConverterFor< TRANS >::m_topConverter

protectedinherited

top level converter that owns this elemental TP converter it also holds the storage object

Definition at line 299 of file TPConverter.h.

◆ m_topConverterRuntime

template<class TRANS >

TopLevelTPCnvBase* ITPConverterFor< TRANS >::m_topConverterRuntime

protectedinherited

top level converter "owning" this TP converter at runtime (different from m_topConverter in case the top-level converter and object have extensions)

Definition at line 302 of file TPConverter.h.

◆ m_wasUsedForReading

template<class TRANS >

bool ITPConverterFor< TRANS >::m_wasUsedForReading

protectedinherited

flag set when using this converter for reading triggers search for a new converter before writing, to prevent possible use of old version

Definition at line 306 of file TPConverter.h.

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

TPConverter.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class TRANS, class PERS> class TPConverterConstBase< TRANS, PERS >

Member Typedef Documentation

◆ base_class

◆ Factory

◆ Pers_t

◆ PersBase_t

◆ PolyCnvBase_t

◆ Trans_t

◆ TransBase_t

Member Function Documentation

◆ baseToPersistent()

◆ clearReadingFlag()

◆ converterForRef()

◆ converterForType()

◆ converterNotFound() [1/2]

◆ converterNotFound() [2/2]

◆ createPersistent()

◆ createPersistentConst()

◆ createPersistentWithKey()

◆ createTransFromPStore()

◆ createTransient()

◆ createTransientConst()

◆ createTransientWithKey()

◆ fillTransFromPStore()

◆ ignoreRecursion()

◆ initPrivateConverters()

◆ persistentTInfo() [1/2]

◆ persistentTInfo() [2/2]

◆ persToTrans() [1/2]

◆ persToTrans() [2/2]

◆ persToTransUntyped()

◆ persToTransWithKey()

◆ persToTransWithKeyUntyped()

◆ pstoreToTrans()

◆ reservePStorage()

◆ setPStorage()

◆ setReadingFlag()

◆ setRecursive()

◆ setRuntimeTopConverter()

◆ setTopConverter()

◆ topConverter() [1/2]

◆ topConverter() [2/2]

◆ toPersistent()

◆ toPersistentWithKey_impl()

◆ transBaseTInfo()

◆ transientTInfo() [1/2]

◆ transientTInfo() [2/2]

◆ transToPers() [1/2]

◆ transToPers() [2/2]

◆ transToPersUntyped()

◆ transToPersWithKey()

◆ transToPersWithKeyUntyped()

◆ typeID()

◆ typeIDvalue()

◆ virt_createTransFromPStore()

◆ virt_createTransFromPStoreWithKey()

◆ virt_toPersistent()

◆ virt_toPersistentWithKey()

◆ wasUsedForReading()

Member Data Documentation

◆ m_curRecLevel

◆ m_ignoreRecursion

◆ m_pStorage

◆ m_pStorageTID

◆ m_pStorageTIDvalue

◆ m_recursive

◆ m_topConverter

◆ m_topConverterRuntime

◆ m_wasUsedForReading

template<class TRANS, class PERS>
class TPConverterConstBase< TRANS, PERS >