edm::DataBucket Class Reference

Codify and simplify access to a ROOT TFolder. More...

#include <DataBucket.h>

List of all members.

Public Member Functions
	DataBucket (TFolder *top)
template<class T>
int	Get (const char *path, std::vector< const T * > &v) const
template<class T>
T *	Put (const T &obj, const char *path, int opt=kFixedSizeObject)
template<class T>
int	PutArray (const T *obj, const char *path, int nObj, int opt=kFixedSizeObject)
template<class T>
int	PutVector (const std::vector< T * > &obj, const char *path, int opt=kFixedSizeObject)
void	List (const char *opt="*") const
TFolder *	GetFolder (const char *path) const
TClonesArray *	GetClonesArray (const char *path) const
TObjArray *	GetObjArray (const char *path) const
void	ClearArrays (const TFolder *f=0)
TFolder *	MakeFolder (const char *path)
int	MakeFolders (const char *dirs[])
int	Remove (const char *path)
Static Public Attributes
const int	kFixedSizeObject = 0x01
	Obsolete for ROOT>5.00.
const int	kVariableSizeObject = 0x02
	Obsolete for ROOT>5.00.
Private Member Functions
TClonesArray *	NewClonesArray (const char *path, const char *classname)
TObjArray *	NewObjArray (const char *path, const char *classname)
Static Private Member Functions
void	ListFolder (const TFolder &f, int lvl)
void	Split (const char *path, char *dir, char *base)
Private Attributes
TFolder *	fTopFolder
	Folder managed. Not owned.

---

Detailed Description

Codify and simplify access to a ROOT TFolder.

Definition at line 22 of file DataBucket.h.

---

Constructor & Destructor Documentation

edm::DataBucket::DataBucket (  TFolder *  top  )

Construct a data bucket to manage the folder "top" Parameters: top  : the ROOT TFolder to manage Definition at line 23 of file DataBucket.cxx. : fTopFolder(f) { }

---

Member Function Documentation

void edm::DataBucket::ClearArrays (  const TFolder *  f = 0  )

Clear the contents of all containers located at and below a folder. Parameters: f  : pointer of folder to clear ClearArrays will clear all arrays located at the level of folder f and will recursively descend into all subfolders of f and clear those also. Definition at line 262 of file DataBucket.cxx. Referenced by edm::Event::Clear(), and edm::EventHandle::~EventHandle(). { if (f==0) f = fTopFolder; TCollection* folders = f->GetListOfFolders(); TIterator* iter = folders->MakeIterator(); TObject* obj = 0; TFolder* fobj = 0; TClonesArray* carr = 0; TObjArray* oarr = 0; while ( (obj=iter->Next())!=0) { fobj = dynamic_cast<TFolder*>(obj); carr = dynamic_cast<TClonesArray*>(obj); oarr = dynamic_cast<TObjArray*>(obj); if (fobj) this->ClearArrays(fobj); if (carr) carr->Delete(); if (oarr) oarr->Delete(); } delete iter; }

template<class T> int edm::DataBucket::Get (  const char *  path, std::vector< const T * > &  v )  const

Retrieve all objects located in the bucket at a specific path. Parameters: path  : Unix-style path name to collection v  : On return, vector of pointers to the objects retrieved Returns: Count of number of objects correctly read Exceptions: edm::Exception  if path is invalid or type-conversion from objects found to requested objects fails The path variable can be used in one of two ways: either to 1) specify a folder name where the collection may be found or 2) to specify the collection exactly. In the first case, the collection name is guessed based on the class name. So for example, a Get(path,v) where v is a vector of objects of type 'DataObject' and "path=./directory" will retrieve the collection "./directory/DataObjects". This is the simplest method if no casting of object type is required. A code fragement for this example follows: 0000 std::vector<const DataObject*> v; 0001 dataBucket.Get("./directory",v"); In the second case, the user specifies the collection name exactly. In this case, the objects located in the data bucket are case to the type specified by the user. So, for example, if a class DataObject is derived from a base class DataObjectBase one may attempt a Get(path,v) where v is a collection of pointers to DataObjectBase objects and the path might be something like "./directory/DataObjects". In this case, the DataObjects retreived will be cast to their base class DataObjectBase. If the cast fails, an exception is thrown. A code fragment for this example follows: 0000 std::vector<const DataObjectBase*> v; 0001 dataBucket.Get("./directory/DataObjects",v); Definition at line 104 of file DataBucket.h. References edm::COLLECTION_NOT_FOUND, GetClonesArray(), GetObjArray(), and edm::TYPE_MISMATCH. Referenced by main(). { // Try to find exactly the collection names by // user. eg. "./dir/Objects" If that fails, assume the user gave // only a directory. Guess the collection name based on the class // type static std::string newPath; register int i; TObjArray* c = 0; if (c==0) c = this->GetClonesArray(path); if (c==0) c = this->GetObjArray(path); if (c==0) { T tmpItem; newPath = path; newPath += "/"; newPath += tmpItem.ClassName(); newPath += "s"; // Object array names are plural. if (c==0) c = this->GetClonesArray(newPath.c_str()); if (c==0) c = this->GetObjArray(newPath.c_str()); } // By this time we need to have a collection in order to proceed if (c==0) { // std::cerr << "edm::DataBucket: Couldn't locate collection at " // << path << std::endl; throw Exception(__FILE__,__LINE__,COLLECTION_NOT_FOUND); return 0; } const T* cc = 0; int nitem = c->GetEntries(); int ntot_size = nitem+v.size(); if (ntot_size>(int)v.capacity()) v.reserve(ntot_size); for (i = 0; i<nitem; ++i) { cc = dynamic_cast<const T*>(c->At(i)); if (cc==0) { std::cerr << "Failed to convert objects in array " << c->GetName() << " to requested type."; throw Exception(__FILE__,__LINE__,TYPE_MISMATCH); assert(cc); } v.push_back(cc); } return nitem; }

TClonesArray * edm::DataBucket::GetClonesArray (  const char *  path  )  const

Return the object array stored at 'path' Parameters: path  : Location where to look for collection Returns: Pointer to TClonesArray if one is found. 0 on failure. Definition at line 99 of file DataBucket.cxx. References GetFolder(), and Split(). Referenced by Get(), Put(), PutArray(), and PutVector(). { char pathto [strlen(path)+1]; char objarray[strlen(path)+1]; edm::DataBucket::Split(path, pathto, objarray); TFolder* f = this->GetFolder(pathto); if (f==0) return 0; TObject* obj = f->FindObjectAny(objarray); TClonesArray* carray = dynamic_cast<TClonesArray*>(obj); return carray; }

TFolder * edm::DataBucket::GetFolder (  const char *  path  )  const

Return the TFolder stored at 'path' Parameters: path  : Location where to look for collection Returns: Pointer to TFolder if one is found. 0 on failure. Definition at line 143 of file DataBucket.cxx. References Split(). Referenced by GetClonesArray(), GetObjArray(), MakeFolder(), NewClonesArray(), and NewObjArray(). { // Check if we've been asked for the top folder if (strcmp("", path) == 0) { return fTopFolder; } if (strcmp(".", path) == 0) { return fTopFolder; } if (strcmp("/", path) == 0) { return fTopFolder; } char pathto[strlen(path)+1]; char folder[strlen(path)+1]; edm::DataBucket::Split(path, pathto, folder); TFolder* f1 = this->GetFolder(pathto); if (f1==0) return 0; TFolder* f2 = dynamic_cast<TFolder*>(f1->FindObjectAny(folder)); return f2; }

TObjArray * edm::DataBucket::GetObjArray (  const char *  path  )  const

Return the object array stored at 'path' Parameters: path  : Location where to look for collection Returns: Pointer to TObjArray if one is found. 0 on failure. Definition at line 121 of file DataBucket.cxx. References GetFolder(), and Split(). Referenced by Get(), Put(), PutArray(), and PutVector(). { char pathto[strlen(path)]; char objarray[strlen(path)]; edm::DataBucket::Split(path, pathto, objarray); TFolder* f = this->GetFolder(pathto); if (f==0) return 0; TObject* obj = f->FindObjectAny(objarray); TObjArray* oarray = dynamic_cast<TObjArray*>(obj); return oarray; }

void edm::DataBucket::List (  const char *  opt = "*"  )  const

List the entire contents of the data bucket on the screen. Parameters: opt  : Unused place holder for options. Definition at line 246 of file DataBucket.cxx. References fTopFolder, and ListFolder(). Referenced by main(), and edm::Event::Print(). { if (!opt) std::cout << "Listing folder with no option." << std::endl; edm::DataBucket::ListFolder(*fTopFolder, 1); }

void edm::DataBucket::ListFolder (  const TFolder &  f, int  lvl )  [static, private]

Print the contents of the folder to the screen Parameters: f  : the Folder who's contents to print lvl  : depth of this folder. Used for indentation level. Definition at line 211 of file DataBucket.cxx. Referenced by List(). { std::string pad; for (int i=0; i<lvl-1; ++i) pad += " "; if (lvl>0) pad += "|-"; pad += "* "; TCollection* folders = f.GetListOfFolders(); TIterator* iter = folders->MakeIterator(); TObject* obj = 0; TFolder* fobj = 0; TObjArray* aobj = 0; while ( (obj=iter->Next())!=0) { fobj = dynamic_cast<TFolder*>(obj); aobj = dynamic_cast<TObjArray*>(obj); if (fobj) { std::string pad2(pad); pad2 += fobj->GetName(); std::cout << pad2 << "\n"; edm::DataBucket::ListFolder(*fobj, lvl+1); } if (aobj) { std::cout << pad << obj->GetName() << "[" << aobj->GetEntries() << "]\n"; } } delete iter; }

TFolder * edm::DataBucket::MakeFolder (  const char *  path  )

Create ad configure a new folder at the absolute path name "path". Parameters: path  : location of new folder Returns: Pointer to new folder. 0 on failure Exceptions: none  Definition at line 34 of file DataBucket.cxx. References GetFolder(), and Split(). Referenced by main(), and MakeFolders(). { if (!path) return 0; TFolder* f = 0; f = this->GetFolder(path); if (f!=0) return f; char pathto[strlen(path)+1]; char newdir[strlen(path)+1]; edm::DataBucket::Split(path, pathto, newdir); // Find the mother folder and add the daughter f = this->GetFolder(pathto); if (f==0) return 0; f->SetOwner(kTRUE); TFolder* newFolder = f->AddFolder(newdir, newdir, 0); newFolder->SetOwner(kTRUE); return newFolder; }

int edm::DataBucket::MakeFolders (  const char *  dirs[]  )

Make a collection of folders all at once given a list of names. Parameters: dirs  : list of directories to be made. End with '0' Returns: Number of folders successfully created. Exceptions: none  Example: 0000 const char dirs={"./A","./A/B1","./A/B2",0}; 0001 dataBucket.MakeFolders(dirs); Definition at line 70 of file DataBucket.cxx. References MakeFolder(). Referenced by main(). { int n = 0; for (int i=0; dirs[i]!=0; ++i) { TFolder* f = this->MakeFolder(dirs[i]); if (f!=0) ++n; } return n; }

TClonesArray * edm::DataBucket::NewClonesArray (  const char *  path, const char *  classname )  [private]

Create a new TClonesArray at a specific location Parameters: path  : Folder where to create the array classname  : Name of objects to be stored in the array. Returns: Pointer to TClonesArray created. 0 otherwise. Definition at line 169 of file DataBucket.cxx. References GetFolder(). Referenced by Put(), PutArray(), and PutVector(). { TFolder* f = this->GetFolder(path); if (f==0) return 0; TClonesArray* c = new TClonesArray(classname); f->Add(c); return c; }

TObjArray * edm::DataBucket::NewObjArray (  const char *  path, const char *  classname )  [private]

Create a new TObjArray at a specific location Parameters: path  : Folder where to create the array classname  : Name of objects to be stored in the array. Returns: Pointer to TObjArray created. 0 otherwise. Definition at line 189 of file DataBucket.cxx. References GetFolder(). Referenced by Put(), PutArray(), and PutVector(). { TFolder* f = this->GetFolder(path); if (f==0) return 0; std::string name; name = classname; name += "s"; TObjArray* c = new TObjArray(100,0); c->SetOwner(); c->SetName(name.c_str()); f->Add(c); return c; }

template<class T> T * edm::DataBucket::Put (  const T &  obj, const char *  path, int  opt = kFixedSizeObject )

Place a copy of an object into the data store Parameters: obj  : Object to be stored path  : Location to place object opt  : Storage options. Obsolete in ROOT versions after (at least) 5.00 Returns: Pointer to object created in the data store. 0 on failure. Exceptions: edm::Exception  if requested location is invalid "Put" places a copy of the object obj into the data bucket, appending it to the collection of object located at path. If no collection exists, a new one is made. So for example, 0000 DataObject obj; 0001 dataBucket.Put(obj,"./directory"); Will create a copy of the object "obj" and append it to the end of the collection "./directory/DataObjects". The optional argument "opt" is used to specify whether the object is of fixed or variable size. This distinction was required by the implementation of TClonesArray in ROOT versions prior to 5.00. In modern ROOT versions this argument is obsolete. Definition at line 178 of file DataBucket.h. References GetClonesArray(), GetObjArray(), NewClonesArray(), NewObjArray(), and edm::NO_FOLDER_FOUND. Referenced by main(). { static std::string collectName; static std::string fullPath; int indx; collectName = obj.ClassName(); fullPath = path; fullPath += "/"; fullPath += collectName; fullPath += "s"; if (opt & kFixedSizeObject) { TClonesArray *c = this->GetClonesArray(fullPath.c_str()); if (c == 0) { // No collection of this type of object. Make a new collection if ((c = this->NewClonesArray(path, collectName.c_str())) == 0) { std::cerr << "edm::DataBucket: no folder " << path << " found" << std::endl; throw Exception(__FILE__,__LINE__,NO_FOLDER_FOUND); } } // Create new object of type T in event store. The "new with // placement" is a signature of the TClonesArray container assert(c!=0); // By this time we must have a home for the object indx = c->GetLast()+1; T* t = new ((*c)[indx]) T(obj); return t; // Add OK } if (opt & kVariableSizeObject) { TObjArray* c = this->GetObjArray(fullPath.c_str()); if (c == 0) { // No collection of this type of object. Make a new collection if ((c = this->NewObjArray(path, collectName.c_str())) == 0) { std::cerr << "edm::DataBucket: no folder " << path << " found" << std::endl; throw Exception(__FILE__,__LINE__,NO_FOLDER_FOUND); } } // Create new object of type T in event store. assert(c!=0); // By this time we must have a home for the object T* t = new T(obj); c->AddLast(t); return t; // Add OK } return 0; }

template<class T> int edm::DataBucket::PutArray (  const T *  obj, const char *  path, int  nObj, int  opt = kFixedSizeObject )

Place an array of objects into the data store. Parameters: obj  : Array of pointers to objects to be stored path  : Location in store where objects are to be placed nObj  : size of obj array opt  : Now obsolete Returns: Number of objects sucessfully stored Exceptions: edm::Exception  See also: Put() This is simply a convenient and more efficient version of Put() above. Definition at line 244 of file DataBucket.h. References GetClonesArray(), GetObjArray(), NewClonesArray(), NewObjArray(), and edm::NO_FOLDER_FOUND. { static std::string collectName; static std::string fullPath; int indx; register int i; collectName = obj[0].ClassName(); fullPath = path; fullPath += "/"; fullPath += collectName; fullPath += "s"; if (opt & kFixedSizeObject) { TClonesArray *c = this->GetClonesArray(fullPath.c_str()); if (c == 0) { // No collection of this type of object. Make a new collection if ((c = this->NewClonesArray(path, collectName.c_str())) == 0) { std::cerr << "edm::DataBucket: no folder " << path << " found" << std::endl; throw Exception(__FILE__,__LINE__,NO_FOLDER_FOUND); } } // Create new object of type T in event store. The "new with // placement" is a signature of the TClonesArray container assert(c != 0); // By this time we must have a home for the object indx = c->GetLast() + 1; const T* objPtr = obj; for (i = 0; i < nObj; ++i) { new ((*c)[indx++]) T(*objPtr++); } return indx; // Add OK } if (opt & kVariableSizeObject) { TObjArray* c = this->GetObjArray(fullPath.c_str()); if (c == 0) { // No collection of this type of object. Make a new collection if ((c = this->NewObjArray(path, collectName.c_str())) == 0) { std::cerr << "edm::DataBucket: no folder " << path << " found" << std::endl; throw Exception(__FILE__,__LINE__,NO_FOLDER_FOUND); } } // Create new object of type T in event store. assert(c!=0); // By this time we must have a home for the object for (i = 0; i < nObj; ++i) { c->AddLast(new T(obj[i])); } return c->GetLast(); // Add OK } return 0; }

template<class T> int edm::DataBucket::PutVector (  const std::vector< T * > &  vec, const char *  path, int  opt = kFixedSizeObject )

Place a vector of objects into the data store. Parameters: obj  : vector of pointers to objects to be stored path  : Location in store where objects are to be placed opt  : Now obsolete Returns: Number of objects sucessfully stored Exceptions: edm::Exception  See also: Put() This is simply a convenient and more efficient version of Put() above. Definition at line 315 of file DataBucket.h. References GetClonesArray(), GetObjArray(), NewClonesArray(), NewObjArray(), and edm::NO_FOLDER_FOUND. { static std::string collectName; static std::string fullPath; int indx; if (vec.empty()) return 0; unsigned int vecSize = vec.size(); // This doesn't seem to work for some reason... // std::vector<const T*>::const_iterator itr(vec.begin()); // std::vector<const T*>::const_iterator itrEnd(vec.end()); collectName = vec[0]->ClassName(); fullPath = path; fullPath += "/"; fullPath += collectName; fullPath += "s"; if (opt & kFixedSizeObject) { TClonesArray *c = this->GetClonesArray(fullPath.c_str()); if (c == 0) { // No collection of this type of object. Make a new collection if ((c = this->NewClonesArray(path, collectName.c_str())) == 0) { std::cerr << "edm::DataBucket: no folder " << path << " found" << std::endl; throw Exception(__FILE__,__LINE__,NO_FOLDER_FOUND); } } // Create new object of type T in event store. The "new with // placement" is a signature of the TClonesArray container assert(c != 0); // By this time we must have a home for the object indx = c->GetLast() + 1; for (unsigned int i = 0; i < vecSize; ++i) {// ; itr != itrEnd; ++itr) { new ((*c)[indx++]) T(*vec[i]); } return indx; // Add OK } if (opt & kVariableSizeObject) { TObjArray* c = this->GetObjArray(fullPath.c_str()); if (c == 0) { // No collection of this type of object. Make a new collection if ((c = this->NewObjArray(path, collectName.c_str())) == 0) { std::cerr << "edm::DataBucket: no folder " << path << " found" << std::endl; throw Exception(__FILE__,__LINE__,NO_FOLDER_FOUND); } } // Create new object of type T in event store. assert(c!=0); // By this time we must have a home for the object for (unsigned int i = 0; i < vecSize; ++i) {//; itr != itrEnd; ++itr) c->AddLast(new T(*vec[i])); } return c->GetLast(); // Add OK } return 0; }

int edm::DataBucket::Remove (  const char *  path  )

Remove the collection and/or folder indicated by path Todo: Not implemented. Definition at line 86 of file DataBucket.cxx. { if (path==0) return 0; else return 0; }

void edm::DataBucket::Split (  const char *  fullpath, char *  pathto, char *  obj )  [static, private]

Split a complete path name into two pieces, the target and the path to the target: /full/path/to/target -> /full/path/to, target Parameters: fullpath  : Input complete path pathto  : Path piece of the full path obj  : Target piece of the full path Definition at line 291 of file DataBucket.cxx. Referenced by GetClonesArray(), GetFolder(), GetObjArray(), and MakeFolder(). { char cpy1[strlen(fullpath)+1]; strcpy(cpy1,fullpath); strcpy(pathto, dirname(cpy1)); char cpy2[strlen(fullpath)+1]; strcpy(cpy2,fullpath); strcpy(obj, basename(cpy2)); }

---

Member Data Documentation

TFolder* edm::DataBucket::fTopFolder [private]

Folder managed. Not owned. Definition at line 59 of file DataBucket.h. Referenced by List().

const int edm::DataBucket::kFixedSizeObject = 0x01 [static]

Obsolete for ROOT>5.00. Definition at line 24 of file DataBucket.h.

const int edm::DataBucket::kVariableSizeObject = 0x02 [static]

Obsolete for ROOT>5.00. Definition at line 25 of file DataBucket.h.

---

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

• DataBucket.h
• DataBucket.cxx

---