AthenaRootStreamerSvc Class Reference

This class provides the manager for ROOT custom streamers. More...

#include <AthenaRootStreamerSvc.h>

Inheritance diagram for AthenaRootStreamerSvc:

Collaboration diagram for AthenaRootStreamerSvc:

Public Member Functions
	AthenaRootStreamerSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Standard Service Constructor. More...
virtual	~AthenaRootStreamerSvc ()
	Destructor. More...
virtual StatusCode	initialize ()
	Required of all Gaudi services: More...
virtual StatusCode	finalize ()
	Required of all Gaudi services: More...
virtual const InterfaceID &	type () const
	Service type. More...
virtual StatusCode	AddStreamer (const std::string &converter_classname, bool adopt=true)
virtual StatusCode	AddStreamer (T_AthenaRootConverterBase *converter, bool adopt=true)
virtual StatusCode	AdoptStreamerForClass (const std::string &class_name)
virtual StatusCode	AdoptAllStreamers ()

Private Types
typedef std::map< std::string, AthenaRootStreamer * >	StreamerMap
	map of streamers for given class names More...
typedef std::pair< RootType, void * >	ConverterPair_t
	vector of converters created by the service, (as Reflex Objects) kept so they can be deleted at the end More...
typedef std::vector< ConverterPair_t >	ConverterVector_t

Private Attributes
StringArrayProperty	m_streamerClassNames
StreamerMap	m_streamerMap
ConverterVector_t	m_createdConverters

Detailed Description

This class provides the manager for ROOT custom streamers.

Author

Marcin Nowak

Definition at line 29 of file AthenaRootStreamerSvc.h.

Member Typedef Documentation

ConverterPair_t

typedef std::pair<RootType, void*> AthenaRootStreamerSvc::ConverterPair_t

private

vector of converters created by the service, (as Reflex Objects) kept so they can be deleted at the end

Definition at line 65 of file AthenaRootStreamerSvc.h.

ConverterVector_t

typedef std::vector< ConverterPair_t > AthenaRootStreamerSvc::ConverterVector_t

private

Definition at line 66 of file AthenaRootStreamerSvc.h.

StreamerMap

typedef std::map<std::string, AthenaRootStreamer*> AthenaRootStreamerSvc::StreamerMap

private

map of streamers for given class names

Definition at line 60 of file AthenaRootStreamerSvc.h.

Constructor & Destructor Documentation

AthenaRootStreamerSvc()

AthenaRootStreamerSvc::AthenaRootStreamerSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Standard Service Constructor.

Definition at line 28 of file AthenaRootStreamerSvc.cxx.

      : base_class(name, pSvcLocator),
    m_streamerMap()
{
   declareProperty( "Streamers", m_streamerClassNames );
}

~AthenaRootStreamerSvc()

AthenaRootStreamerSvc::~AthenaRootStreamerSvc ( )

virtual

Destructor.

Definition at line 36 of file AthenaRootStreamerSvc.cxx.

{
}

Member Function Documentation

AddStreamer() [1/2]

StatusCode AthenaRootStreamerSvc::AddStreamer ( const std::string &  converter_classname, bool  adopt = true  )

virtual

Definition at line 97 of file AthenaRootStreamerSvc.cxx.

{
   RootType streamer_class( converter_classname );
   if( !streamer_class ) {
 
      // Enable library auto-loading. Only once per job.
      static std::once_flag libLoadFlag;
      std::call_once( libLoadFlag, []( TInterpreter& interpreter ) {
 
         // Enable library auto-loading.
         TClass::ReadRules();
         interpreter.LoadLibraryMap();
         interpreter.SetClassAutoloading( true );
 
      }, *gInterpreter );
 
      // int ntypesBefore = Reflex::Type::TypeSize();
      gInterpreter->AutoLoad( converter_classname.c_str() );
 
      MsgStream log(msgSvc(), name());
      streamer_class = RootType( converter_classname );
      if( ! streamer_class ) {
         ATH_MSG_ERROR ( "Could not find <" << converter_classname
                         << "> in the dictionary, and autoloading failed" );
         return(StatusCode::FAILURE);
      }
      log << MSG::DEBUG << "Loaded dictionary for class " << converter_classname
 //         << " ntypes before load " << ntypesBefore
 //         << " ntypes loaded " << Reflex::Type::TypeSize() - ntypesBefore
          << endmsg;
   }
   void* obj = streamer_class.Construct();
   m_createdConverters.emplace_back( streamer_class, obj );
   return AddStreamer( (T_AthenaRootConverterBase*)obj, adopt); 
}

AddStreamer() [2/2]

StatusCode AthenaRootStreamerSvc::AddStreamer ( T_AthenaRootConverterBase *  converter, bool  adopt = true  )

virtual

Definition at line 134 of file AthenaRootStreamerSvc.cxx.

{
   const std::string    &classname = converter->ClassName();
   AthenaRootStreamer* & streamer = m_streamerMap[classname];
   if (!streamer) {
      // no streamer for this class yet
      streamer = new AthenaRootStreamer(classname, this);
   }
   auto convH = std::make_unique<AthenaRootConverterHandle>(converter);
   if( streamer->AddConverter(std::move(convH)).isFailure() ) {
      ATH_MSG_ERROR ( "ROOT Streamer for "  << classname
                      << " already has a converter for checksum = "
                      << converter->StreamerChecksum() );
      return(StatusCode::FAILURE);
   }
   ATH_MSG_INFO ( "ROOT Streamer for " << classname
                  << " added converter for checksum = "
                  << converter->StreamerChecksum() );
 
   if( adopt ) {
      return AdoptStreamerForClass( classname );
   }
   return(StatusCode::SUCCESS);
}

AdoptAllStreamers()

StatusCode AthenaRootStreamerSvc::AdoptAllStreamers ( )

virtual

Definition at line 178 of file AthenaRootStreamerSvc.cxx.

{
   StatusCode   sc = StatusCode::SUCCESS;
   for (auto& p : m_streamerMap) {
      if( p.second->Adopt().isFailure() ) {
         ATH_MSG_INFO ( "Failed to adopt streamer for class " << p.first );
     sc = StatusCode::FAILURE;
      }
   }
   return sc; 
}

AdoptStreamerForClass()

StatusCode AthenaRootStreamerSvc::AdoptStreamerForClass ( const std::string &  class_name )

virtual

Definition at line 161 of file AthenaRootStreamerSvc.cxx.

                                                                                   {
   if (m_streamerMap.find(class_name) == m_streamerMap.end()) {
      ATH_MSG_ERROR ( "Attemt to adopt streamer for "
                      << class_name
                      << " with has no converters defined" );
      return(StatusCode::FAILURE);
   }
   if (m_streamerMap[class_name]->Adopt().isSuccess()) {
     ATH_MSG_INFO ( "Adopted streamer for class " << class_name );
     return(StatusCode::SUCCESS);
   }
   ATH_MSG_ERROR ( "Failed to adopt streamer for " << class_name );
   return(StatusCode::FAILURE);
}

finalize()

StatusCode AthenaRootStreamerSvc::finalize ( )

virtual

Required of all Gaudi services:

Definition at line 75 of file AthenaRootStreamerSvc.cxx.

{
   // Destroy converter Objects created by the service
   for (auto& p : m_createdConverters)
   {
     p.first.Destruct (p.second);
   }
   m_createdConverters.clear();
   
   // do NOT delete the streamers created by the service - they are owned by TClass
   m_streamerMap.clear();
 
   return AthService::finalize(); 
}

initialize()

StatusCode AthenaRootStreamerSvc::initialize ( )

virtual

Required of all Gaudi services:

Definition at line 41 of file AthenaRootStreamerSvc.cxx.

{
   ATH_CHECK( AthService::initialize() );
 
   pool::DbSession  session;
   // initialize the session
   // using NULL context, hopefully not a problem
   pool::DbStatus       rc = session.open();
   // create ROOT-type database object -
   // this loads the ROOT storage service plugin and
   // initializes POOL/ROOT class loader needed by GetClass()
   if( rc != pool::DbStatus::Success || ! session.db(pool::ROOT_StorageType) ) {
      ATH_MSG_ERROR ( "Failed to open POOL/ROOT session" );
      return StatusCode::FAILURE;
   }
   ATH_MSG_INFO ( "POOL/ROOT class loader initialized" );
   session.close();
   
   StatusCode status = StatusCode::SUCCESS;
   if( m_streamerClassNames.value().size() ) {
      ATH_MSG_INFO ( m_streamerClassNames.value().size() << " ROOT streamers declared" );
 
      std::vector< std::string >::const_iterator i = m_streamerClassNames.value().begin();
      while( i !=  m_streamerClassNames.value().end() ) {
         ATH_MSG_INFO ( "  - Streamer name:" << *i );
     if( AddStreamer( *i++ ).isFailure() )
        status = StatusCode::FAILURE; 
      }
   }
 
   return status;
}

type()

const InterfaceID & AthenaRootStreamerSvc::type ( ) const

virtual

Service type.

Definition at line 91 of file AthenaRootStreamerSvc.cxx.

{ 
    return IAthenaRootStreamerSvc::interfaceID();
}

Member Data Documentation

m_createdConverters

ConverterVector_t AthenaRootStreamerSvc::m_createdConverters

private

Definition at line 67 of file AthenaRootStreamerSvc.h.

m_streamerClassNames

StringArrayProperty AthenaRootStreamerSvc::m_streamerClassNames

private

Definition at line 57 of file AthenaRootStreamerSvc.h.

m_streamerMap

StreamerMap AthenaRootStreamerSvc::m_streamerMap

private

Definition at line 61 of file AthenaRootStreamerSvc.h.

---

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

• AthenaRootStreamerSvc.h
• AthenaRootStreamerSvc.cxx