Class managing ConstDataVector objects in transient memory. More...

#include <TCDVHolderT.h>

Inheritance diagram for xAOD::TCDVHolderT< T >:

Collaboration diagram for xAOD::TCDVHolderT< T >:

Public Types
typedef ConstDataVector< T >	Object_t
	Type of the managed object.
enum	TypeKind { OTHER , DATAVECTOR , AUXELEMENT }
	Type of the object held by this one. More...

Public Member Functions
	TCDVHolderT (ConstDataVector< T > *object, const std::type_info &type, ::Bool_t owner=kTRUE)
	Constructor with the object, and its type.
virtual void	set (void *obj)
	Replace the managed object.
virtual void *	getAs (const std::type_info &tid, ::Bool_t silent=kFALSE) const
	Return the object as a specific pointer.
virtual const void *	getAsConst (const std::type_info &tid, ::Bool_t silent=kFALSE) const
	Return the object as a specific, constant pointer.
const void *	get () const
	Return a typeless const pointer to the held object.
void *	get ()
	Return a typeless pointer to the held object.
void **	getPtr ()
	Return a typeless pointer to the held object's pointer.
::Bool_t	isOwner () const
	Check whether the holder owns its object.
void	setOwner (::Bool_t state=kTRUE)
	Set whether the holder should own its object.
::Bool_t	isConst () const
	Check if the object is const.
void	setConst ()
	Mark the object as const.
void	renew ()
	Renew the object in memory.
TypeKind	typeKind () const
	Return the type of the object held by this one.

const ::TClass *	getClass () const
::TClass *	getClass ()
const std::type_info *	getTypeInfo () const

Protected Member Functions
void	deleteObject ()
	Internal function used to delete the managed object from memory.
void *	getImpl (const std::type_info &tid, ::Bool_t silent=kFALSE) const
	Internal function to get an object.

Protected Attributes
void *	m_object
	Typeless pointer to the object in memory.
::TClass *	m_type
	Concrete type of the object being held on to.
const std::type_info *	m_typeInfo
	Concrete type of the object, if it doesn't have a dictionary.
::Bool_t	m_owner
	A flag for whether the object owns what it points to.
TypeKind	m_typeKind
	Type of the object held.
::Bool_t	m_const
	Is the held object const?

Private Attributes
ConstDataVector< T > *	m_cdvObject
	Type specific pointer to the managed object.
THolder	m_holderHelper
	Helper object managing the inheritance tree of the underlying DataVector type.

Detailed Description

template<class T>
class xAOD::TCDVHolderT< T >

Class managing ConstDataVector objects in transient memory.

In order to be able to record ConstDataVector objects into the transient store, and be able to retrieve them as "const DataVector", we need to use a specialised holder type. Very much like how we use a specialised SG::DataBucket for this type in Athena's StoreGate.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 28 of file TCDVHolderT.h.

Member Typedef Documentation

◆ Object_t

template<class T>

typedef ConstDataVector< T > xAOD::TCDVHolderT< T >::Object_t

Type of the managed object.

Definition at line 32 of file TCDVHolderT.h.

Member Enumeration Documentation

◆ TypeKind

enum xAOD::THolder::TypeKind

inherited

Type of the object held by this one.

Enumerator
OTHER	Some non-specified type.
DATAVECTOR	A DataVector container.
AUXELEMENT	A type inheriting from `SG::AuxElement`.

Definition at line 103 of file THolder.h.

                    {
        OTHER,      
        DATAVECTOR, 
        AUXELEMENT  
      }; // enum TypeKind

Constructor & Destructor Documentation

◆ TCDVHolderT()

template<class T>

xAOD::TCDVHolderT< T >::TCDVHolderT	(	ConstDataVector< T > *	object,
		const std::type_info &	type,
		::Bool_t	owner = kTRUE )

Constructor with the object, and its type.

Member Function Documentation

◆ deleteObject()

void xAOD::THolder::deleteObject ( )

protectedinherited

Internal function used to delete the managed object from memory.

Definition at line 438 of file THolder.cxx.

                              {
 
      // Check if we even have an object:
      if( ! m_object ) {
         return;
      }
 
      // Delete the object then:
      if( m_type ) {
         if( m_type->IsLoaded() ) {
            m_type->Destructor( m_object );
         }
         // In certain situations it can happen that the memory cleanup for a
         // particular TEvent object happens after ROOT already started to
         // unload libraries from memory. In this case, since the application
         // is anyway on its final leg, let's not bother the user with
         // additional warnings about not being able to clean up after the
         // managed object.
      } else if( m_typeInfo ) {
         const TVirtualDestructor* d =
            TDestructorRegistry::instance().get( *m_typeInfo );
         if( d ) {
            d->destruct( m_object );
         } else {
            ::Error( "xAOD::THolder::deleteObject",
                     XAOD_MESSAGE( "Couldn't delete managed object" ) );
         }
      } else {
         ::Error( "xAOD::THolder::deleteObject",
                  XAOD_MESSAGE( "Couldn't delete managed object" ) );
      }
 
      return;
   }

◆ get() [1/2]

void * xAOD::THolder::get ( )

inherited

Return a typeless pointer to the held object.

Definition at line 221 of file THolder.cxx.

                      {
 
      return m_object;
   }

◆ get() [2/2]

const void * xAOD::THolder::get ( ) const

inherited

Return a typeless const pointer to the held object.

Definition at line 216 of file THolder.cxx.

                                  {
 
      return m_object;
   }

◆ getAs()

template<class T>

virtual void * xAOD::TCDVHolderT< T >::getAs	(	const std::type_info &	tid,
		::Bool_t	silent = kFALSE ) const

virtual

Return the object as a specific pointer.

Reimplemented from xAOD::THolder.

◆ getAsConst()

template<class T>

virtual const void * xAOD::TCDVHolderT< T >::getAsConst	(	const std::type_info &	tid,
		::Bool_t	silent = kFALSE ) const

virtual

Return the object as a specific, constant pointer.

Reimplemented from xAOD::THolder.

◆ getClass() [1/2]

TClass * xAOD::THolder::getClass ( )

inherited

Definition at line 407 of file THolder.cxx.

                             {
 
      return m_type;
   }

◆ getClass() [2/2]

const::TClass * xAOD::THolder::getClass ( ) const

inherited

Return the concrete type of the object

Definition at line 402 of file THolder.cxx.

                                         {
 
      return m_type;
   }

◆ getImpl()

void * xAOD::THolder::getImpl	(	const std::type_info &	tid,
		::Bool_t	silent = kFALSE ) const

protectedinherited

Internal function to get an object.

Internal helper or getAs and getAsConst.

Parameters

tid	The type as which the object is to be retrieved
silent	When `kTRUE`, the call will fail silently when unsuccessful

Returns: A pointer that can be cast to the requested type

Definition at line 297 of file THolder.cxx.

                                                 {
 
      // If there is no dictionary for the object, then the logic is pretty
      // simple:
      if( ! m_type ) {
         // Check if the user asked for the right type. Remember that in this
         // case we can't return an object as its base type.
         if( tid != *m_typeInfo ) {
            if( ! silent ) {
               const std::string heldType =
                  SG::normalizedTypeinfoName( *m_typeInfo );
               const std::string reqType =
                  SG::normalizedTypeinfoName( tid );
               ::Warning( "xAOD::THolder::getAs",
                          "Trying to retrieve %s object with a %s pointer",
                          heldType.c_str(), reqType.c_str() );
            }
            return 0;
         }
         // The user did ask for the correct type:
         return m_object;
      }
 
      // Check if we already know about this type:
      auto userClass = Internal::THolderCache::instance().getClass( tid );
      // If not, look for it now:
      if( ! userClass.first ) {
         userClass.second = ::TClass::GetClass( tid );
         Internal::THolderCache::instance().addClass( tid, userClass.second );
      }
 
      // If we still don't have a dictionary, that's an issue:
      if( ! userClass.second ) {
         if( ! silent ) {
            ::Error( "xAOD::THolder::getAs",
                     XAOD_MESSAGE( "Couldn't access the dictionary for user "
                                   "type: %s" ),
                     SG::normalizedTypeinfoName( tid ).c_str() );
         }
         return 0;
      }
 
      // Check if the user requested a valid base class for the held type.
      //
      // Calling GetBaseClassOffset is in general not thread-safe as it could
      // trigger the loading and parsing of StreamerInfo. However, we assume
      // that this has already been done once we get here.
      TClass* cl ATLAS_THREAD_SAFE = m_type;
      const Int_t offset = cl->GetBaseClassOffset( userClass.second );
      if( offset < 0 ) {
         if( ! silent ) {
            ::Warning( "xAOD::THolder::getAs",
                       "User class \"%s\" is not a valid base "
                       "of \"%s\"",
                       SG::normalizedTypeinfoName( tid ).c_str(),
                       m_type->GetName() );
         }
         return 0;
      }
 
      // If all is fine, do the cast:
      return ( static_cast< char* >( m_object ) + offset );
   }

◆ getPtr()

void ** xAOD::THolder::getPtr ( )

inherited

Return a typeless pointer to the held object's pointer.

Definition at line 226 of file THolder.cxx.

                          {
 
      return &m_object;
   }

◆ getTypeInfo()

const std::type_info * xAOD::THolder::getTypeInfo ( ) const

inherited

Definition at line 412 of file THolder.cxx.

                                                  {
 
      return m_typeInfo;
   }

◆ isConst()

Bool_t xAOD::THolder::isConst ( ) const

inherited

Check if the object is const.

Definition at line 280 of file THolder.cxx.

                                 {
 
      return m_const;
   }

◆ isOwner()

Bool_t xAOD::THolder::isOwner ( ) const

inherited

Check whether the holder owns its object.

Definition at line 253 of file THolder.cxx.

                                 {
 
      return m_owner;
   }

◆ renew()

void xAOD::THolder::renew ( )

inherited

Renew the object in memory.

This function is mostly used in "Athena access mode", to delete the managed objects from memory between events, and recreate them from scratch.

Definition at line 421 of file THolder.cxx.

                       {
 
      // Delete the object using its dictionary:
      if( m_object && m_owner &&
          ( ! Internal::THolderCache::instance().decRef( m_object ) ) ) {
         deleteObject();
      }
 
      // Create a new object:
      m_owner = kTRUE;
      m_object = m_type->New();
      Internal::THolderCache::instance().incRef( m_object );
 
      // Return gracefuly:
      return;
   }

◆ set()

template<class T>

virtual void xAOD::TCDVHolderT< T >::set ( void * obj )

virtual

Replace the managed object.

Reimplemented from xAOD::THolder.

◆ setConst()

void xAOD::THolder::setConst ( )

inherited

Mark the object as const.

Definition at line 285 of file THolder.cxx.

                          {
 
      m_const = kTRUE;
   }

◆ setOwner()

void xAOD::THolder::setOwner ( ::Bool_t state = kTRUE )

inherited

Set whether the holder should own its object.

Definition at line 258 of file THolder.cxx.

                                        {
 
      // Check if anything needs to be done:
      if( state == m_owner ) return;
 
      if( m_object && m_owner &&
          ( ! Internal::THolderCache::instance().decRef( m_object ) ) ) {
         ::Warning( "xAOD::THolder::setOwner",
                    "Deleting object %p no longer held by any owner",
                    m_object );
         deleteObject();
      }
 
      m_owner = state;
 
      if( m_object && m_owner ) {
         Internal::THolderCache::instance().incRef( m_object );
      }
 
      return;
   }

◆ typeKind()

TypeKind xAOD::THolder::typeKind ( ) const

inlineinherited

Return the type of the object held by this one.

Definition at line 110 of file THolder.h.

                                {
         return m_typeKind;
      }

Member Data Documentation

◆ m_cdvObject

template<class T>

ConstDataVector< T >* xAOD::TCDVHolderT< T >::m_cdvObject

private

Type specific pointer to the managed object.

Definition at line 51 of file TCDVHolderT.h.

◆ m_const

::Bool_t xAOD::THolder::m_const

protectedinherited

Is the held object const?

Definition at line 133 of file THolder.h.

◆ m_holderHelper

template<class T>

THolder xAOD::TCDVHolderT< T >::m_holderHelper

private

Helper object managing the inheritance tree of the underlying DataVector type.

Definition at line 54 of file TCDVHolderT.h.

◆ m_object

void* xAOD::THolder::m_object

protectedinherited

Typeless pointer to the object in memory.

Definition at line 123 of file THolder.h.

◆ m_owner

::Bool_t xAOD::THolder::m_owner

protectedinherited

A flag for whether the object owns what it points to.

Definition at line 129 of file THolder.h.

◆ m_type

::TClass* xAOD::THolder::m_type

protectedinherited

Concrete type of the object being held on to.

Definition at line 125 of file THolder.h.

◆ m_typeInfo

const std::type_info* xAOD::THolder::m_typeInfo

protectedinherited

Concrete type of the object, if it doesn't have a dictionary.

Definition at line 127 of file THolder.h.

◆ m_typeKind

TypeKind xAOD::THolder::m_typeKind

protectedinherited

Type of the object held.

Definition at line 131 of file THolder.h.

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

TCDVHolderT.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Object_t

Member Enumeration Documentation

◆ TypeKind

Constructor & Destructor Documentation

◆ TCDVHolderT()

Member Function Documentation

◆ deleteObject()

◆ get() [1/2]

◆ get() [2/2]

◆ getAs()

◆ getAsConst()

◆ getClass() [1/2]

◆ getClass() [2/2]

◆ getImpl()

◆ getPtr()

◆ getTypeInfo()

◆ isConst()

◆ isOwner()

◆ renew()

◆ set()

◆ setConst()

◆ setOwner()

◆ typeKind()

Member Data Documentation

◆ m_cdvObject

◆ m_const

◆ m_holderHelper

◆ m_object

◆ m_owner

◆ m_type

◆ m_typeInfo

◆ m_typeKind