| The Gaudi Framework v32r1 (f65d50dc)

Public Member Functions | Static Public Member Functions | List of all members
RootHistCnv::RDirectoryCnv Class Reference

Create persistent and transient representations of data store directories. More...

`#include <src/RDirectoryCnv.h>`

Inheritance diagram for RootHistCnv::RDirectoryCnv:
[legend]
Collaboration diagram for RootHistCnv::RDirectoryCnv:
[legend]

## Public Member Functions
StatusCode | createObj (IOpaqueAddress *pAddr, DataObject *&refpObj) override
| Create the transient representation of an object. More...
StatusCode | fillObjRefs (IOpaqueAddress *pAddr, DataObject *refpObj) override
| Update the transient object from the other representation. More...
StatusCode | createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
| Convert the transient object to the requested representation. More...
StatusCode | updateRep (IOpaqueAddress *pAddr, DataObject *pObject) override
| Convert the transient object to the requested representation. More...
| RDirectoryCnv (ISvcLocator *svc)
| Standard constructor. More...
| RDirectoryCnv (ISvcLocator *svc, const CLID &clid)
| Standard constructor. More...
Public Member Functions inherited from RootHistCnv::RConverter
StatusCode | createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
| Convert the transient object to the requested representation. More...
long | repSvcType () const override
StatusCode | error (const std::string &msg)
StatusCode | regTFile (const std::string, const TFile *)
StatusCode | findTFile (const std::string, TFile *&)
std::string | diskDirectory (const std::string &loc)
std::string | directory (const std::string &loc)
void | setDirectory (const std::string &loc)
void | setDiskDirectory (const std::string &loc)
StatusCode | createDirectory (const std::string &loc)
StatusCode | createDiskDirectory (const std::string &loc)
std::string | getDirectory ()
std::string | convertId (const std::string &) const
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 CLID & | objType () 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< IService > | service (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::string > | getInterfaceNames () const override
| Implementation of IInterface::getInterfaceNames. More...
| implements ()=default
| Default constructor. More...
| implements (const implements &)
| Copy constructor (zero the reference count) More...
implements & | operator= (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...

## Static Public Member Functions
static const CLID & | classID ()
| Inquire class type. More...
Static Public Member Functions inherited from RootHistCnv::RConverter
static long | storageType ()
| Inquire storage type. 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...
Protected Member Functions inherited from RootHistCnv::RConverter
| RConverter (const CLID &clid, ISvcLocator *svc)
| Standard constructor. More...
virtual StatusCode | readObject (IOpaqueAddress *pAddr, DataObject *&refpObj)
| Create the transient representation of an object. More...
virtual TObject * | createPersistent (DataObject *pObj)
| Create the persistent representation of an object. More...
StatusCode | createAddress (DataObject *pObject, TDirectory *pDir, TObject *pTObject, IOpaqueAddress *&refpAddr)
| Create address of the transient object according to the requested representation. More...
StatusCode | createAddress (const std::string &rzdir, const CLID &clid, long id, TObject *pTobj, IOpaqueAddress *&refpAddress)
StatusCode | createAddress (const std::string &rzdir, const CLID &clid, const std::string &title, TObject *pTobj, IOpaqueAddress *&refpAddress)
TDirectory * | changeDirectory (DataObject *pObject)
| Switch to object directory (=Parent directory) 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 inherited from implements< IConverter >
std::atomic_ulong | m_refCount
| Reference counter. More...

## Detailed Description

Create persistent and transient representations of data store directories.

Author
  Charles Leggett

Definition at line 16 of file RDirectoryCnv.h.

## Constructor & Destructor Documentation

## ◆ RDirectoryCnv() [1/2]

RootHistCnv::RDirectoryCnv::RDirectoryCnv | ( | ISvcLocator * | svc | ) |
| inline

Standard constructor.

Definition at line 29 of file RDirectoryCnv.h.

29 : RConverter( CLID_NTupleDirectory, svc ) {}
RootHistCnv::RConverter::RConverter
RConverter(const CLID &clid, ISvcLocator *svc)
Standard constructor.
Definition: RConverter.h:55

## ◆ RDirectoryCnv() [2/2]

RootHistCnv::RDirectoryCnv::RDirectoryCnv | ( | ISvcLocator * | svc,
|  | const CLID & | clid
| ) |  |
| inline

Standard constructor.

Definition at line 31 of file RDirectoryCnv.h.

31 : RConverter( clid, svc ) {}
RootHistCnv::RConverter::RConverter
RConverter(const CLID &clid, ISvcLocator *svc)
Standard constructor.
Definition: RConverter.h:55

## Member Function Documentation

## ◆ classID()

static const CLID& RootHistCnv::RDirectoryCnv::classID | ( |  | ) |
| inline static

Inquire class type.

Definition at line 27 of file RDirectoryCnv.h.

27 { return CLID_NTupleDirectory; }

## ◆ createObj()

StatusCode RootHistCnv::RDirectoryCnv::createObj | ( | IOpaqueAddress * | pAddr,
|  | DataObject *& | refpObj
| ) |  |
| override

Create the transient representation of an object.

Definition at line 36 of file RDirectoryCnv.cpp.

38 {
39 refpObject = new NTuple::Directory();
40 return StatusCode::SUCCESS;
41 }
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
NTuple::Directory
Small class representing an N tuple directory in the transient store.
Definition: NTuple.h:901

## ◆ createRep()

StatusCode RootHistCnv::RDirectoryCnv::createRep | ( | DataObject * | pObj,
|  | IOpaqueAddress *& | refpAddr
| ) |  |
| override

Convert the transient object to the requested representation.

Definition at line 44 of file RDirectoryCnv.cpp.

46 {
47 const std::string& loc = pObject->registry()->identifier();
48 if ( createDirectory( loc ).isSuccess() ) {
49 setDirectory( loc );
50 setDiskDirectory( loc );
51 // return createAddress(pObject, pObject->registry()->name(), refpAddress);
52 return createAddress( pObject, gDirectory, nullptr, refpAddress );
53 }
54 refpAddress = nullptr;
55 return StatusCode::FAILURE;
56 }
RootHistCnv::RConverter::setDirectory
void setDirectory(const std::string &loc)
Definition: RConverter.cpp:108
RootHistCnv::RConverter::createDirectory
StatusCode createDirectory(const std::string &loc)
Definition: RConverter.cpp:24
std::string
STL class.
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:86
RootHistCnv::RConverter::createAddress
StatusCode createAddress(DataObject *pObject, TDirectory *pDir, TObject *pTObject, IOpaqueAddress *&refpAddr)
Create address of the transient object according to the requested representation.
Definition: RConverter.cpp:155
RootHistCnv::RConverter::setDiskDirectory
void setDiskDirectory(const std::string &loc)
Definition: RConverter.cpp:141

## ◆ fillObjRefs()

StatusCode RootHistCnv::RDirectoryCnv::fillObjRefs | ( | IOpaqueAddress * | pAddr,
|  | DataObject * | refpObj
| ) |  |
| override

Update the transient object from the other representation.

Definition at line 71 of file RDirectoryCnv.cpp.

71 {
72 MsgStream log( msgSvc(), "RDirectoryCnv" );
73 IRegistry* pReg = pObj->registry();
74 std::string full = pReg->identifier();
75 const std::string& fname = pAddr->par()[0];
76
77 TFile* tf = nullptr;
78 findTFile( full, tf ).ignore();
79
80 // cd to TFile:
81 setDirectory( full );
82 TIter nextkey( gDirectory->GetListOfKeys() );
83 while ( TKey* key = (TKey*)nextkey() ) {
84 IOpaqueAddress* pA = nullptr;
85 TObject* obj = key->ReadObj();
86 std::string title = obj->GetTitle();
87 std::string sid = obj->GetName();
88 std::string f2 = full + "/" + sid;
89 int idh = maybe_stol( sid ).value_or( 0 );
90 // introduced by Grigori Rybkine
91 std::string clname = key->GetClassName();
92 std::string clnm = clname.substr( 0, 3 );
93 TClass* isa = obj->IsA();
94 if ( isa->InheritsFrom( "TTree" ) ) {
95 createAddress( full, CLID_ColumnWiseTuple, idh, obj, pA ).ignore();
96 TTree* tree = (TTree*)obj;
97 tree->Print();
98 log << MSG::DEBUG << "Reg CWNT \"" << obj->GetTitle() << "\" as " << f2 << endmsg;
99 title = "/" + sid;
100 } else if ( isa->InheritsFrom( "TDirectory" ) ) {
101 createAddress( full, CLID_NTupleDirectory, title, obj, pA ).ignore();
102 } else if ( isa == TProfile::Class() ) {
103 createAddress( full, CLID_ProfileH, idh, obj, pA ).ignore();
104 title = sid;
105 } else if ( isa == TProfile2D::Class() ) {
106 createAddress( full, CLID_ProfileH2, idh, obj, pA ).ignore();
107 title = sid;
108 } else if ( isa == TH1C::Class() ) {
109 createAddress( full, CLID_H1D, idh, obj, pA ).ignore();
110 title = sid;
111 } else if ( isa == TH1S::Class() ) {
112 createAddress( full, CLID_H1D, idh, obj, pA ).ignore();
113 title = sid;
114 } else if ( isa == TH1I::Class() ) {
115 createAddress( full, CLID_H1D, idh, obj, pA ).ignore();
116 title = sid;
117 } else if ( isa == TH1F::Class() ) {
118 createAddress( full, CLID_H1D, idh, obj, pA ).ignore();
119 title = sid;
120 } else if ( isa == TH1D::Class() ) {
121 createAddress( full, CLID_H1D, idh, obj, pA ).ignore();
122 title = sid;
123 } else if ( isa == TH2C::Class() ) {
124 createAddress( full, CLID_H2D, idh, obj, pA ).ignore();
125 title = sid;
126 } else if ( isa == TH2S::Class() ) {
127 createAddress( full, CLID_H2D, idh, obj, pA ).ignore();
128 title = sid;
129 } else if ( isa == TH2I::Class() ) {
130 createAddress( full, CLID_H2D, idh, obj, pA ).ignore();
131 title = sid;
132 } else if ( isa == TH2F::Class() ) {
133 createAddress( full, CLID_H2D, idh, obj, pA ).ignore();
134 title = sid;
135 } else if ( isa == TH2D::Class() ) {
136 createAddress( full, CLID_H2D, idh, obj, pA ).ignore();
137 title = sid;
138 } else if ( isa == TH3C::Class() ) {
139 createAddress( full, CLID_H3D, idh, obj, pA ).ignore();
140 title = sid;
141 } else if ( isa == TH3S::Class() ) {
142 createAddress( full, CLID_H3D, idh, obj, pA ).ignore();
143 title = sid;
144 } else if ( isa == TH3I::Class() ) {
145 createAddress( full, CLID_H3D, idh, obj, pA ).ignore();
146 title = sid;
147 } else if ( isa == TH3F::Class() ) {
148 createAddress( full, CLID_H3D, idh, obj, pA ).ignore();
149 title = sid;
150 } else if ( isa == TH3D::Class() ) {
151 createAddress( full, CLID_H3D, idh, obj, pA ).ignore();
152 title = sid;
153 } else {
154 log << MSG::ERROR << "Encountered an unknown object with key: " << obj->GetName() << " in ROOT file " << fname
155 << endmsg;
156 return StatusCode::FAILURE;
157 }
158 if ( pA ) {
159 StatusCode sc = dataManager()->registerAddress( pReg, title, pA );
160 if ( !sc.isSuccess() ) {
161 log << MSG::ERROR << "Failed to register address for " << full << endmsg;
162 return sc;
163 }
164 log << MSG::VERBOSE << "Created address for " << clnm << "'" << title << "' in " << full << endmsg;
165 }
166 }
167 return StatusCode::SUCCESS;
168 }
IOpaqueAddress::par
virtual const std::string * par() const =0
Retrieve String parameters.
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
IDataManagerSvc::registerAddress
virtual StatusCode registerAddress(std::string_view fullPath, IOpaqueAddress *pAddress)=0
Register object address with the data store.
RootHistCnv::RConverter::setDirectory
void setDirectory(const std::string &loc)
Definition: RConverter.cpp:108
MSG::DEBUG
Definition: IMessageSvc.h:15
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
RootHistCnv::RConverter::findTFile
StatusCode findTFile(const std::string, TFile *&)
Definition: RConverter.cpp:279
MSG::VERBOSE
Definition: IMessageSvc.h:15
std::string
STL class.
Converter::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
Retrieve pointer to message service.
Definition: Converter.cpp:95
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
IRegistry
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:267
Gaudi::Accumulators::atomicity::full
StatusCode::ignore
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:86
MSG::ERROR
Definition: IMessageSvc.h:15
std::string::substr
T substr(T... args)
IRegistry::identifier
virtual const id_type & identifier() const =0
Full identifier (or key)
IOpaqueAddress
Opaque address interface definition.
Definition: IOpaqueAddress.h:23
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
RootHistCnv::RConverter::createAddress
StatusCode createAddress(DataObject *pObject, TDirectory *pDir, TObject *pTObject, IOpaqueAddress *&refpAddr)
Create address of the transient object according to the requested representation.
Definition: RConverter.cpp:155
Gaudi.Configuration.log
log
Definition: Configuration.py:13
Converter::dataManager
SmartIF< IDataManagerSvc > & dataManager() const
Get Data Manager service.
Definition: Converter.cpp:71

## ◆ updateRep()

StatusCode RootHistCnv::RDirectoryCnv::updateRep | ( | IOpaqueAddress * | pAddr,
|  | DataObject * | pObject
| ) |  |
| override

Convert the transient object to the requested representation.

Definition at line 59 of file RDirectoryCnv.cpp.

61 {
62 const std::string& loc = pObject->registry()->identifier();
63 if ( createDirectory( loc ).isSuccess() ) {
64 setDirectory( loc );
65 return StatusCode::SUCCESS;
66 }
67 return StatusCode::FAILURE;
68 }
DataObject::registry
IRegistry * registry() const
Get pointer to Registry.
Definition: DataObject.h:72
RootHistCnv::RConverter::setDirectory
void setDirectory(const std::string &loc)
Definition: RConverter.cpp:108
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
RootHistCnv::RConverter::createDirectory
StatusCode createDirectory(const std::string &loc)
Definition: RConverter.cpp:24
std::string
STL class.
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:86
IRegistry::identifier
virtual const id_type & identifier() const =0
Full identifier (or key)

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

- RootHistCnv/src/RDirectoryCnv.h
- RootHistCnv/src/RDirectoryCnv.cpp