RootHistCnv::RDirectoryCnv Class Reference

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

#include <src/RDirectoryCnv.h>

Inheritance diagram for RootHistCnv::RDirectoryCnv:
Collaboration diagram for RootHistCnv::RDirectoryCnv:

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...
 
 ~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 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...
 
 ~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 CLIDclassID ()
 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
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...
 
- 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

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

Standard constructor.

Definition at line 29 of file RDirectoryCnv.h.

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

Standard constructor.

Definition at line 31 of file RDirectoryCnv.h.

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

Standard destructor.

Member Function Documentation

static const CLID& RootHistCnv::RDirectoryCnv::classID ( )
inlinestatic

Inquire class type.

Definition at line 27 of file RDirectoryCnv.h.

27 { return CLID_NTupleDirectory; }
StatusCode RootHistCnv::RDirectoryCnv::createObj ( IOpaqueAddress pAddr,
DataObject *&  refpObj 
)
override

Create the transient representation of an object.

Definition at line 39 of file RDirectoryCnv.cpp.

42 {
43  refpObject = new NTuple::Directory();
44  return StatusCode::SUCCESS;
45 }
Small class representing an N tuple directory in the transient store.
Definition: NTuple.h:1068
StatusCode RootHistCnv::RDirectoryCnv::createRep ( DataObject pObj,
IOpaqueAddress *&  refpAddr 
)
override

Convert the transient object to the requested representation.

Definition at line 49 of file RDirectoryCnv.cpp.

52 {
53  const std::string& loc = pObject->registry()->identifier();
54  if ( createDirectory(loc).isSuccess() ) {
55  setDirectory(loc);
56  setDiskDirectory(loc);
57 // return createAddress(pObject, pObject->registry()->name(), refpAddress);
58  return createAddress(pObject, gDirectory, nullptr, refpAddress);
59  }
60  refpAddress = nullptr;
61  return StatusCode::FAILURE;
62 }
void setDirectory(const std::string &loc)
Definition: RConverter.cpp:113
StatusCode createDirectory(const std::string &loc)
Definition: RConverter.cpp:25
STL class.
StatusCode createAddress(DataObject *pObject, TDirectory *pDir, TObject *pTObject, IOpaqueAddress *&refpAddr)
Create address of the transient object according to the requested representation. ...
Definition: RConverter.cpp:160
void setDiskDirectory(const std::string &loc)
Definition: RConverter.cpp:146
StatusCode RootHistCnv::RDirectoryCnv::fillObjRefs ( IOpaqueAddress pAddr,
DataObject refpObj 
)
override

Update the transient object from the other representation.

Definition at line 81 of file RDirectoryCnv.cpp.

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

Convert the transient object to the requested representation.

Definition at line 66 of file RDirectoryCnv.cpp.

69 {
70  const std::string& loc = pObject->registry()->identifier();
71  if ( createDirectory(loc).isSuccess() ) {
72  setDirectory(loc);
73  return StatusCode::SUCCESS;
74  }
75  return StatusCode::FAILURE;
76 }
void setDirectory(const std::string &loc)
Definition: RConverter.cpp:113
StatusCode createDirectory(const std::string &loc)
Definition: RConverter.cpp:25
IRegistry * registry() const
Get pointer to Registry.
Definition: DataObject.h:74
STL class.
virtual const id_type & identifier() const =0
Full identifier (or key)

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