| The Gaudi Framework v28r2-patches (bc4ad17a)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
RootHistCnv::RFileCnv Class Reference

NTuple converter class definition. More...

`#include <src/RFileCnv.h>`

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

## Public Member Functions
StatusCode | initialize () override
| Initialise. More...
StatusCode | createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
| Create the transient representation of an object. More...
StatusCode | createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
| Convert the transient object to the requested representation. More...
StatusCode | updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
| Convert the transient object to the requested representation. More...
| RFileCnv (ISvcLocator *svc)
| Standard constructor. More...
| ~RFileCnv () override=default
| Standard destructor. More...
Public Member Functions inherited from RootHistCnv::RDirectoryCnv
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...
| ~RDirectoryCnv () override=default
| Standard destructor. 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...
| ~implements () override=default
| Virtual destructor. 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...
Public Member Functions inherited from extend_interfaces< Interfaces... >
| ~extend_interfaces () override=default
| Virtual destructor. More...

## Static Public Member Functions
static const CLID & | classID ()
| Inquire class type. More...
Static Public Member Functions inherited from RootHistCnv::RDirectoryCnv
static const CLID & | classID ()
| Inquire class type. More...
Static Public Member Functions inherited from RootHistCnv::RConverter
static long | storageType ()
| Inquire storage type. More...

## Protected Attributes
TFile * | rfile
| Pointer to ROOT file. More...
std::string | m_compLevel
| Compression setting, property RFileCnv.GlobalCompression. More...
Protected Attributes inherited from implements< IConverter >
std::atomic_ulong | m_refCount
| Reference counter. More...

## Additional Inherited Members
Public Types inherited from Converter
typedef Gaudi::PluginService::Factory< IConverter *, ISvcLocator * > | Factory
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...
| ~RConverter () override=default
| Standard destructor. 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
| ~Converter () override=default
| Standard Destructor. More...
SmartIF< ISvcLocator > & | serviceLocator () const
| Retrieve pointer to service locator. More...
SmartIF< IMessageSvc > & | msgSvc () const
| Retrieve pointer to message service. More...

## Detailed Description

NTuple converter class definition.

- Major cleanup and debugging for Gaudi v9
- Removal of all static storage

Author
  Charles Leggett
  Markus Frank

Definition at line 22 of file RFileCnv.h.

## Constructor & Destructor Documentation

RootHistCnv::RFileCnv::RFileCnv | ( | ISvcLocator * | svc | ) |

Standard constructor.

Definition at line 25 of file RFileCnv.cpp.

26 : RDirectoryCnv ( svc, classID() )
27 { }
RootHistCnv::RFileCnv::classID
static const CLID & classID()
Inquire class type.
Definition: RFileCnv.h:42
RootHistCnv::RDirectoryCnv::RDirectoryCnv
RDirectoryCnv(ISvcLocator *svc)
Standard constructor.
Definition: RDirectoryCnv.h:29

RootHistCnv::RFileCnv::~RFileCnv | ( |  | ) |
| override default

Standard destructor.

## Member Function Documentation

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

Inquire class type.

Definition at line 42 of file RFileCnv.h.

42 {
43 return CLID_NTupleFile;
44 }

StatusCode RootHistCnv::RFileCnv::createObj | ( | IOpaqueAddress * | pAddress,
|  | DataObject *& | refpObject
| ) |  |
| override

Create the transient representation of an object.

Definition at line 44 of file RFileCnv.cpp.

47 {
48 MsgStream log(msgSvc(), "RFileCnv");
49 unsigned long* ipar = (unsigned long*)pAddress->ipar();
50 char mode[2] = { char(ipar[1]), 0 };
51
52 std::string fname = pAddress->par()[0]; // Container name
53 std::string ooname = pAddress->par()[1]; // Object name
54
55 const std::string* spar = pAddress->par();
56 // Strip of store name to get the top level RZ directory
57 std::string oname = spar[1].substr(spar[1].find("/",1)+1);
58
59 // Protect against multiple instances of TROOT
60 if ( !gROOT ) {
61 static TROOT root("root","ROOT I/O");
62 // gDebug = 99;
63 } else {
64 log << MSG::VERBOSE << "ROOT already initialized, debug = "
65 << gDebug<< endmsg;
66 }
67
68 // Determine access mode:
69
70 if ( mode[0] == 'O' ) {
71
72 if (findTFile(ooname,rfile).isFailure()) {
73
74 log << MSG::INFO << "opening Root file \"" << fname << "\" for reading"
75 << endmsg;
76
77 rfile = TFile::Open(fname.c_str(),"READ");
78 if ( rfile && rfile->IsOpen() ) {
79 regTFile(ooname,rfile).ignore();
80
81 ipar[0] = (unsigned long)rfile;
82 NTuple::File* pFile = new NTuple::File(objType(), fname, oname);
83 pFile->setOpen(true);
84 refpObject = pFile;
85
86 return StatusCode::SUCCESS;
87
88 } else {
89 log << MSG::ERROR << "Couldn't open \"" << fname << "\" for reading"
90 << endmsg;
91 return StatusCode::FAILURE;
92 }
93
94 } else {
95 log << MSG::DEBUG << "Root file \"" << fname << "\" already opened"
96 << endmsg;
97 return StatusCode::SUCCESS;
98 }
99
100
101 } else if ( mode[0] == 'U' ) {
102
103 log << MSG::INFO << "opening Root file \"" << fname << "\" for updating"
104 << endmsg;
105
106 log << MSG::ERROR << "don't know how to do this yet. Aborting." << endmsg;
107 exit(1);
108
109 } else if ( mode[0] == 'N' ) {
110
111 log << MSG::INFO << "opening Root file \"" << fname << "\" for writing";
112 if ( !m_compLevel.empty() )
113 { log << ", CompressionLevel='" << m_compLevel << "'"; }
114 log << endmsg;
115
116 rfile = TFile::Open( fname.c_str(), "RECREATE", "Gaudi Trees" );
117 if ( ! ( rfile && rfile->IsOpen() ) ) {
118 log << MSG::ERROR << "Could not open file " << fname << " for writing"
119 << endmsg;
120 return StatusCode::FAILURE;
121 }
122 if ( !m_compLevel.empty() )
123 {
124 const RootCompressionSettings settings(m_compLevel);
125 rfile->SetCompressionSettings(settings.level());
126 }
127
128 regTFile(ooname,rfile).ignore();
129
130 log << MSG::DEBUG << "creating ROOT file " << fname << endmsg;
131
132 ipar[0] = (unsigned long)rfile;
133 NTuple::File* pFile = new NTuple::File(objType(), fname, oname);
134 pFile->setOpen(true);
135 refpObject = pFile;
136 return StatusCode::SUCCESS;
137
138 } else {
139
140 log << MSG::ERROR << "Uknown mode to access ROOT file" << endmsg;
141 return StatusCode::FAILURE;
142
143 }
144
145 return StatusCode::FAILURE;
146 }
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
StatusCode::SUCCESS
Definition: StatusCode.h:30
std::string::empty
T empty(T...args)
NTuple::File::setOpen
void setOpen(bool flag)
Set "open" flag.
Definition: NTuple.h:1140
RootHistCnv::RFileCnv::rfile
TFile * rfile
Pointer to ROOT file.
Definition: RFileCnv.h:54
StatusCode::FAILURE
Definition: StatusCode.h:29
Converter::objType
const CLID & objType() const override
Retrieve the class type of objects the converter produces.
Definition: Converter.cpp:14
MSG::DEBUG
Definition: IMessageSvc.h:18
Converter::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
Retrieve pointer to message service.
Definition: Converter.cpp:129
RootHistCnv::RConverter::regTFile
StatusCode regTFile(const std::string, const TFile *)
Definition: RConverter.cpp:271
RootHistCnv::RConverter::findTFile
StatusCode findTFile(const std::string, TFile *&)
Definition: RConverter.cpp:286
MSG::VERBOSE
Definition: IMessageSvc.h:17
IOpaqueAddress::par
virtual const std::string * par() const =0
Retrieve String parameters.
std::string
STL class.
IOpaqueAddress::ipar
virtual const unsigned long * ipar() const =0
Access to generic link parameters.
std::exit
T exit(T...args)
RootHistCnv::RFileCnv::m_compLevel
std::string m_compLevel
Compression setting, property RFileCnv.GlobalCompression.
Definition: RFileCnv.h:55
std::find
T find(T...args)
std::string::c_str
T c_str(T...args)
MSG::ERROR
Definition: IMessageSvc.h:21
std::string::substr
T substr(T...args)
gaudiComponentHelp.root
root
Definition: gaudiComponentHelp.py:14
StatusCode::ignore
void ignore() const
Definition: StatusCode.h:106
MSG::INFO
Definition: IMessageSvc.h:19
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
NTuple::File
Small class representing an N tuple file in the transient store.
Definition: NTuple.h:1088
Gaudi.Configuration.log
log
Definition: Configuration.py:13

StatusCode RootHistCnv::RFileCnv::createRep | ( | DataObject * | pObject,
|  | IOpaqueAddress *& | refpAddress
| ) |  |
| override

Convert the transient object to the requested representation.

Definition at line 149 of file RFileCnv.cpp.

152 {
153 refpAddress = pObject->registry()->address();
154 return RFileCnv::updateRep( refpAddress, pObject );
155 }
RootHistCnv::RFileCnv::updateRep
StatusCode updateRep(IOpaqueAddress *pAddress, DataObject *pObject) override
Convert the transient object to the requested representation.
Definition: RFileCnv.cpp:158
DataObject::registry
IRegistry * registry() const
Get pointer to Registry.
Definition: DataObject.h:74
IRegistry::address
virtual IOpaqueAddress * address() const =0
Retrieve opaque storage address.

StatusCode RootHistCnv::RFileCnv::initialize | ( |  | ) |
| override

Initialise.

Definition at line 30 of file RFileCnv.cpp.

31 {
32 // Set compression level property ...
33 ISvcLocator * svcLoc = Gaudi::svcLocator();
34 auto jobSvc = svcLoc->service<IJobOptionsSvc>("JobOptionsSvc");
35 auto prop = jobSvc->getClientProperty("RFileCnv", "GlobalCompression");
36 if (prop) m_compLevel = prop->toString();
37
38 // initialise base class
39 return RDirectoryCnv::initialize();
40 }
ISvcLocator
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
Converter::initialize
StatusCode initialize() override
Initialize the converter.
Definition: Converter.cpp:65
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:78
IJobOptionsSvc
Main interface for the JobOptions service.
Definition: IJobOptionsSvc.h:20
Gaudi::svcLocator
GAUDI_API ISvcLocator * svcLocator()
RootHistCnv::RFileCnv::m_compLevel
std::string m_compLevel
Compression setting, property RFileCnv.GlobalCompression.
Definition: RFileCnv.h:55
IJobOptionsSvc::getClientProperty
virtual const Gaudi::Details::PropertyBase * getClientProperty(const std::string &client, const std::string &name) const =0
Get a property for a client.

StatusCode RootHistCnv::RFileCnv::updateRep | ( | IOpaqueAddress * | pAddress,
|  | DataObject * | pObject
| ) |  |
| override

Convert the transient object to the requested representation.

Definition at line 158 of file RFileCnv.cpp.

161 {
162 MsgStream log(msgSvc(), "RFileCnv");
163 std::string ooname = pAddress->par()[1];
164
165 NTuple::File* pFile = dynamic_cast<NTuple::File*>(pObject);
166 if ( pFile && pFile->isOpen() ) {
167
168 unsigned long* ipar = (unsigned long*)pAddress->ipar();
169 if (findTFile(ooname,rfile).isFailure()) {
170 log << MSG::ERROR << "Problems closing TFile " << ooname << endmsg;
171 return StatusCode::FAILURE;
172 }
173
174 rfile->Write(nullptr,TObject::kOverwrite);
175 if ( log.level() <= MSG::INFO ) {
176 log << MSG::INFO << "dumping contents of " << ooname << endmsg;
177 rfile->Print();
178 }
179
180 /*
181 * MetaData
182 * Ana Trisovic
183 * March 2015
184 * */
185 SmartIF <IMetaDataSvc> mds;
186 mds = serviceLocator()->service("Gaudi::MetaDataSvc", false);
187 //auto mds = service<IMetaDataSvc>("MetaDataSvc", false);
188 if (mds) {
189 std::map <std::string, std::string> m_metadata = mds->getMetaDataMap();
190 if(!rfile->WriteObject(&m_metadata, "info")){
191 return StatusCode::FAILURE;
192 }
193 }
194 /* */
195
196 rfile->Close();
197 delete rfile;
198
199 ipar[0] = 0;
200 pFile->setOpen(false);
201 return StatusCode::SUCCESS;
202
203 } else {
204 log << MSG::ERROR << "TFile " << ooname << " is not open" << endmsg;
205 }
206 return StatusCode::FAILURE;
207 }
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
StatusCode::SUCCESS
Definition: StatusCode.h:30
SmartIF
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:14
NTuple::File::setOpen
void setOpen(bool flag)
Set "open" flag.
Definition: NTuple.h:1140
RootHistCnv::RFileCnv::rfile
TFile * rfile
Pointer to ROOT file.
Definition: RFileCnv.h:54
StatusCode::FAILURE
Definition: StatusCode.h:29
Converter::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
Retrieve pointer to message service.
Definition: Converter.cpp:129
RootHistCnv::RConverter::findTFile
StatusCode findTFile(const std::string, TFile *&)
Definition: RConverter.cpp:286
IOpaqueAddress::par
virtual const std::string * par() const =0
Retrieve String parameters.
std::map< std::string, std::string >
std::string
STL class.
ISvcLocator::service
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:78
IMetaDataSvc::getMetaDataMap
virtual std::map< std::string, std::string > getMetaDataMap()=0
IOpaqueAddress::ipar
virtual const unsigned long * ipar() const =0
Access to generic link parameters.
NTuple::File::isOpen
bool isOpen() const
Access "open" flag.
Definition: NTuple.h:1144
Converter::serviceLocator
SmartIF< ISvcLocator > & serviceLocator() const
Retrieve pointer to service locator.
Definition: Converter.cpp:124
MSG::ERROR
Definition: IMessageSvc.h:21
MSG::INFO
Definition: IMessageSvc.h:19
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
NTuple::File
Small class representing an N tuple file in the transient store.
Definition: NTuple.h:1088
Gaudi.Configuration.log
log
Definition: Configuration.py:13

## Member Data Documentation

std::string RootHistCnv::RFileCnv::m_compLevel
| protected

Compression setting, property RFileCnv.GlobalCompression.

Definition at line 55 of file RFileCnv.h.

TFile* RootHistCnv::RFileCnv::rfile
| protected

Pointer to ROOT file.

Definition at line 54 of file RFileCnv.h.

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

- RootHistCnv/src/RFileCnv.h
- RootHistCnv/src/RFileCnv.cpp