The Gaudi Framework  master (594c33fa)
Gaudi::RootStatCnv Class Reference

#include <Root/RootStatCnv.h>

Inheritance diagram for Gaudi::RootStatCnv:
Collaboration diagram for Gaudi::RootStatCnv:

Public Member Functions

 RootStatCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
 Initializing Constructor. More...
 
- Public Member Functions inherited from Gaudi::RootConverter
 RootConverter (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
 Initializing Constructor. More...
 
long repSvcType () const override
 Retrieve the class type of the data store the converter uses. More...
 
StatusCode createObj (IOpaqueAddress *pAddr, DataObject *&refpObj) override
 Converter overrides: Create transient object from persistent data. More...
 
StatusCode fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
 Resolve the references of the created transient object. More...
 
StatusCode createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
 Converter overrides: Convert the transient object to the requested representation. More...
 
StatusCode fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
 Resolve the references of the created transient object. More...
 
- Public Member Functions inherited from Converter
StatusCode initialize () override
 Initialize the converter. More...
 
StatusCode finalize () override
 Initialize the converter. More...
 
StatusCode setDataProvider (IDataProviderSvc *svc) override
 Set Data provider service. More...
 
SmartIF< IDataProviderSvc > & dataProvider () const override
 Get Data provider service. More...
 
StatusCode setConversionSvc (IConversionSvc *svc) override
 Set conversion service the converter is connected to. More...
 
SmartIF< IConversionSvc > & conversionSvc () const override
 Get conversion service the converter is connected to. More...
 
StatusCode setAddressCreator (IAddressCreator *creator) override
 Set address creator facility. More...
 
SmartIF< IAddressCreator > & addressCreator () const override
 Retrieve address creator facility. More...
 
const CLIDobjType () const override
 Retrieve the class type of objects the converter produces. More...
 
virtual long i_repSvcType () const
 Retrieve the class type of the data store the converter uses. More...
 
StatusCode createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
 Create the transient representation of an object. More...
 
StatusCode fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Resolve the references of the created transient object. More...
 
StatusCode updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
 Update the transient object from the other representation. More...
 
StatusCode updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Update the references of an updated transient object. More...
 
StatusCode createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
 Convert the transient object to the requested representation. More...
 
StatusCode fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Resolve the references of the converted object. More...
 
StatusCode updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
 Update the converted representation of a transient object. More...
 
StatusCode updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Update the references of an already converted object. More...
 
 Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
 Standard Constructor. More...
 
template<class T >
StatusCode service (const std::string &name, T *&psvc, bool createIf=false) const
 Access a service by name, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode service (const std::string &type, const std::string &name, T *&psvc) const
 Access a service by name, type creating it if it doesn't already exist. More...
 
SmartIF< IServiceservice (const std::string &name, const bool createIf=true) const
 Return a pointer to the service identified by name (or "type/name") More...
 
- Public Member Functions inherited from implements< IConverter >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 implements ()=default
 Default constructor. More...
 
 implements (const implements &)
 Copy constructor (zero the reference count) More...
 
implementsoperator= (const implements &)
 Assignment operator (do not touch the reference count). More...
 
unsigned long addRef () override
 Reference Interface instance
More...
 
unsigned long release () override
 Release Interface instance
More...
 
unsigned long refCount () const override
 Current reference count
More...
 

Protected Member Functions

MsgStreamlog () const
 Helper to use mesage logger. More...
 
StatusCode initialize () override
 Initialize converter object. More...
 
StatusCode finalize () override
 Finalize converter object. More...
 
virtual const std::string containerName (IRegistry *pDir) const
 Retrieve the name of the container a given object is placed into. More...
 
virtual const std::string fileName (IRegistry *pReg) const
 Retrieve the name of the file a given object is placed into. More...
 
virtual const std::string topLevel (IRegistry *pReg) const
 Retrieve the full path of the file a given object is placed into. More...
 
StatusCode makeError (const std::string &msg, bool throw_exception=false) const
 Helper method to issue error messages. More...
 
StatusCode saveDescription (const std::string &path, const std::string &ident, const std::string &desc, const std::string &opt, const CLID &clid)
 Save statistics object description. More...
 
- Protected Member Functions inherited from Converter
SmartIF< ISvcLocator > & serviceLocator () const
 Retrieve pointer to service locator. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 Retrieve pointer to message service. More...
 
SmartIF< IDataManagerSvc > & dataManager () const
 Get Data Manager service. More...
 

Protected Attributes

SmartIF< IDataManagerSvcm_dataMgr
 Reference to data manager service to manipulate the TES. More...
 
std::unique_ptr< MsgStreamm_log
 Reference to logger object. More...
 
- Protected Attributes inherited from Gaudi::RootConverter
RootCnvSvcm_dbMgr
 Conversion service needed for proper operation to forward requests. More...
 
- Protected Attributes inherited from implements< IConverter >
std::atomic_ulong m_refCount
 Reference counter
More...
 

Additional Inherited Members

- Public Types inherited from Converter
using Factory = Gaudi::PluginService::Factory< IConverter *(ISvcLocator *)>
 
- Public Types inherited from implements< IConverter >
using base_class = implements< Interfaces... >
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
using iids = typename extend_interfaces_base::ext_iids
 
- Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
 take union of the ext_iids of all Interfaces... More...
 

Detailed Description

Description: Base class converter for N-tuples and related classes.

Author
M.Frank
Version
1.0

Definition at line 40 of file RootStatCnv.h.

Constructor & Destructor Documentation

◆ RootStatCnv()

RootStatCnv::RootStatCnv ( long  typ,
const CLID clid,
ISvcLocator svc,
RootCnvSvc mgr 
)

Initializing Constructor.

Parameters
typ[IN] Concrete storage type of the converter
clid[IN] Class identifier of the object
svc[IN] Pointer to service locator object
Returns
Reference to RootBaseCnv object

Definition at line 34 of file RootStatCnv.cpp.

35  : RootConverter( typ, clid, svc, mgr ) {}

Member Function Documentation

◆ containerName()

const string RootStatCnv::containerName ( IRegistry pDir) const
protectedvirtual

Retrieve the name of the container a given object is placed into.

Parameters
pReg[IN] Pointer to registry entry.
Returns
Name of the container the object should be put to.

Reimplemented in Gaudi::RootDatabaseCnv.

Definition at line 56 of file RootStatCnv.cpp.

56  {
57  const string& path = pReg->identifier();
58  long loc = path.find( '/', 1 );
59  string local = "<local>";
60  // local = "";
61  if ( loc > 0 ) {
62  loc = path.find( '/', ++loc );
63  if ( loc > 0 ) { local += path.substr( loc ); }
64  }
65  // for(size_t i=0; i<local.length();++i)
66  // if ( !isalnum(local[i])) local[i] = '_';
67  return local;
68 }

◆ fileName()

const string RootStatCnv::fileName ( IRegistry pReg) const
protectedvirtual

Retrieve the name of the file a given object is placed into.

Parameters
pReg[IN] Pointer to registry entry.
Returns
Name of the file the object should be put to.

Definition at line 71 of file RootStatCnv.cpp.

71  {
72  string path = topLevel( pReg );
73  DataObject* pObj = nullptr;
74  dataProvider()->retrieveObject( path, pObj ).ignore();
75  if ( pObj ) {
76  NTuple::File* fptr = dynamic_cast<NTuple::File*>( pObj );
77  if ( fptr ) { return fptr->name(); }
78  }
79  return "";
80 }

◆ finalize()

StatusCode RootStatCnv::finalize ( )
overrideprotected

Finalize converter object.

Definition at line 49 of file RootStatCnv.cpp.

49  {
50  m_log.reset();
51  m_dataMgr.reset();
52  return RootConverter::finalize();
53 }

◆ initialize()

StatusCode RootStatCnv::initialize ( )
overrideprotected

Initialize converter object.

Definition at line 38 of file RootStatCnv.cpp.

38  {
40  if ( sc.isSuccess() ) {
42  if ( !m_dataMgr ) { return makeError( "Failed to access IDataManagerSvc interface." ); }
43  }
44  m_log.reset( new MsgStream( msgSvc(), System::typeinfoName( typeid( *this ) ) ) );
45  return sc;
46 }

◆ log()

MsgStream& Gaudi::RootStatCnv::log ( ) const
inlineprotected

Helper to use mesage logger.

Definition at line 48 of file RootStatCnv.h.

48 { return *m_log; }

◆ makeError()

StatusCode RootStatCnv::makeError ( const std::string msg,
bool  throw_exception = false 
) const
protected

Helper method to issue error messages.

Parameters
msg[IN] Text of the error message
throw_exc[IN]If true throw an exception of type std::runtime_error
Returns
Status code indicating success or failure.

Definition at line 97 of file RootStatCnv.cpp.

97  {
98  if ( m_log ) {
99  log() << MSG::ERROR << msg << endmsg;
100  } else {
101  MsgStream l( msgSvc(), "RootConverter" );
102  l << MSG::ERROR << msg << endmsg;
103  }
104  if ( throw_exc ) {}
105  return StatusCode::FAILURE;
106 }

◆ saveDescription()

StatusCode RootStatCnv::saveDescription ( const std::string path,
const std::string ident,
const std::string desc,
const std::string opt,
const CLID clid 
)
protected

Save statistics object description.

Parameters
path[IN] Path of file to save the description on.
ident[IN] Identifier of description to be saved.
desc[IN] Description
opt[IN] Optional description
guid[IN] Object giud of described object
openMode[IN] Mode of opening the file to save description
Returns
Status code indicating success or failure.

Definition at line 109 of file RootStatCnv.cpp.

110  {
111  RootDataConnection* con = nullptr;
113  if ( status.isSuccess() ) {
114  TClass* cl = gROOT->GetClass( "Gaudi::RootNTupleDescriptor", kTRUE );
115  if ( cl ) {
118  TBranch* b = con->getBranch( "##Descriptors", "GaudiStatisticsDescription", cl, ptr, 512, 0 );
119  if ( b ) {
120  dsc->description = desc;
121  dsc->optional = opt;
122  dsc->container = ident;
123  dsc->clid = clid;
124  b->SetAddress( &ptr );
125  int nb = b->Fill();
126  if ( nb > 1 ) {
127  log() << MSG::DEBUG << "Save description for " << ident << endmsg;
128  return StatusCode::SUCCESS;
129  }
130  }
131  return makeError( "Failed to access ROOT branch GaudiStatisticsDescription" );
132  }
133  return makeError( "Failed to access TClass RootNTupleDescriptor" );
134  }
135  return makeError( "Failed to access Tuple file:" + path );
136 }

◆ topLevel()

const string RootStatCnv::topLevel ( IRegistry pReg) const
protectedvirtual

Retrieve the full path of the file a given object is placed into.

Parameters
pReg[IN] Pointer to registry entry.
Returns
Name of the file the object should be put to.

Definition at line 83 of file RootStatCnv.cpp.

83  {
84  if ( pReg ) {
85  string path = pReg->identifier();
86  size_t idx = path.find( '/', 1 );
87  if ( idx != string::npos ) {
88  idx = path.find( '/', idx + 1 );
89  if ( idx != string::npos ) { path = path.substr( 0, idx ); }
90  return path;
91  }
92  }
93  return "";
94 }

Member Data Documentation

◆ m_dataMgr

SmartIF<IDataManagerSvc> Gaudi::RootStatCnv::m_dataMgr
protected

Reference to data manager service to manipulate the TES.

Definition at line 43 of file RootStatCnv.h.

◆ m_log

std::unique_ptr<MsgStream> Gaudi::RootStatCnv::m_log
protected

Reference to logger object.

Definition at line 45 of file RootStatCnv.h.


The documentation for this class was generated from the following files:
MSG::DEBUG
@ DEBUG
Definition: IMessageSvc.h:25
Converter::dataProvider
SmartIF< IDataProviderSvc > & dataProvider() const override
Get Data provider service.
Definition: Converter.cpp:78
NTuple::File
Small class representing an N tuple file in the transient store.
Definition: NTuple.h:922
GaudiAlg.HistoUtils.path
path
Definition: HistoUtils.py:960
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:314
Gaudi::RootCnvSvc::connectDatabase
StatusCode connectDatabase(const std::string &dataset, int mode, RootDataConnection **con)
Connect the output file to the service with open mode.
Definition: RootCnvSvc.cpp:210
Gaudi::RootConverter::m_dbMgr
RootCnvSvc * m_dbMgr
Conversion service needed for proper operation to forward requests.
Definition: RootConverter.h:45
Gaudi::RootNTupleDescriptor
Definition: RootRefs.h:87
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:96
GaudiMP.FdsRegistry.msg
msg
Definition: FdsRegistry.py:19
System::typeinfoName
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:313
std::unique_ptr::reset
T reset(T... args)
Gaudi::RootDataConnection
Definition: RootDataConnection.h:112
StatusCode
Definition: StatusCode.h:65
Gaudi::RootStatCnv::makeError
StatusCode makeError(const std::string &msg, bool throw_exception=false) const
Helper method to issue error messages.
Definition: RootStatCnv.cpp:97
Gaudi::RootStatCnv::m_log
std::unique_ptr< MsgStream > m_log
Reference to logger object.
Definition: RootStatCnv.h:45
Gaudi::IDataConnection::UPDATE
@ UPDATE
Definition: IIODataManager.h:49
Gaudi::RootConverter::RootConverter
RootConverter(long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
Initializing Constructor.
Definition: RootConverter.h:55
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:203
MsgStream
Definition: MsgStream.h:34
Gaudi::RootStatCnv::log
MsgStream & log() const
Helper to use mesage logger.
Definition: RootStatCnv.h:48
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:100
gaudirun.l
dictionary l
Definition: gaudirun.py:581
NTuple::File::name
const std::string & name() const
Retrun physical file name.
Definition: NTuple.h:948
Gaudi::RootStatCnv::topLevel
virtual const std::string topLevel(IRegistry *pReg) const
Retrieve the full path of the file a given object is placed into.
Definition: RootStatCnv.cpp:83
MSG::ERROR
@ ERROR
Definition: IMessageSvc.h:25
Gaudi::RootStatCnv::m_dataMgr
SmartIF< IDataManagerSvc > m_dataMgr
Reference to data manager service to manipulate the TES.
Definition: RootStatCnv.h:43
IRegistry::identifier
virtual const id_type & identifier() const =0
Full identifier (or key)
DataObject
Definition: DataObject.h:36
GaudiConfig2.semantics.ident
ident
Definition: semantics.py:198
Converter::initialize
StatusCode initialize() override
Initialize the converter.
Definition: Converter.cpp:53
Converter::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
Retrieve pointer to message service.
Definition: Converter.cpp:105
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:101
Gaudi::RootDataConnection::getBranch
TBranch * getBranch(std::string_view section, std::string_view branch_name)
Access data branch by name: Get existing branch in read only mode.
Definition: RootDataConnection.h:326
std::unique_ptr
STL class.
Converter::finalize
StatusCode finalize() override
Initialize the converter.
Definition: Converter.cpp:60