TFileDirectory Class Reference

#include <TFileDirectory.h>

Inheritance diagram for TFileDirectory:

Public Member Functions
bool	cd () const
std::string	fullPath () const
	return the full path of the stored histograms More...
TDirectory *	getBareDirectory (const std::string &subdir="") const
template<typename T >
T *	getObject (const std::string &objname, const std::string &subdir="")
template<typename T , typename... Args>
T *	make (const Args &...args) const
	make new ROOT object More...
TFileDirectory	mkdir (const std::string &dir, const std::string &descr="")
	create a new subdirectory More...
	TFileDirectory ()
virtual	~TFileDirectory ()
	descructor More...

Private Member Functions
TDirectory *	_cd (const std::string &subdir="", bool createNeededDirectories=true) const
TObject *	_getObj (const std::string &objname, const std::string &subdir="") const
TDirectory *	_mkdir (TDirectory *dirPtr, const std::string &dir, const std::string &description) const
	TFileDirectory (const std::string &dir, const std::string &descr, TFile *file, const std::string &path)

Private Attributes
std::string	descr_
std::string	dir_
TFile *	file_
std::string	path_

Friends
class	fwlite::TFileService
class	TFileService
	Output file. More...

Detailed Description

Definition at line 24 of file TFileDirectory.h.

Constructor & Destructor Documentation

TFileDirectory() [1/2]

TFileDirectory::TFileDirectory ( )

inline

Definition at line 26 of file TFileDirectory.h.

: file_(nullptr), dir_(), descr_(), path_() {}

~TFileDirectory()

virtual TFileDirectory::~TFileDirectory ( )

inlinevirtual

descructor

Definition at line 29 of file TFileDirectory.h.

{}

TFileDirectory() [2/2]

TFileDirectory::TFileDirectory ( const std::string &  dir, const std::string &  descr, TFile *  file, const std::string &  path  )

inlineprivate

Definition at line 81 of file TFileDirectory.h.

      : file_(file), dir_(dir), descr_(descr), path_(path) {}

Member Function Documentation

_cd()

TDirectory * TFileDirectory::_cd ( const std::string &  subdir = "", bool  createNeededDirectories = true  ) const

private

Definition at line 17 of file TFileDirectory.cc.

References gather_cfg::cout, DeadROC_duringRun::dir, sistrip::dir_, Exception, contentValuesFiles::fullPath, convertSQLiteXML::ok, path_, and mkLumiAveragedPlots::subdir.

Referenced by make().

                                                                                        {
  string fpath = fullPath();
  if (subdir.length()) {
    // not empty, we need to append it to path
    if (fpath.length()) {
      // path is also not empty, so add a slash and let's get going.
      fpath += "/" + subdir;
    } else {
      // path doesn't exist, so just use subdir
      fpath = subdir;
    }
  }
  TDirectory *dir = file_->GetDirectory(fpath.c_str());
  if (dir == nullptr) {
    // we didn't find the directory
    //
    // If we're not supposed to create the diretory, then we should
    // complain now that it doesn't exist.
    if (!createNeededDirectories) {
      cout << "here " << fpath << endl;
      throw cms::Exception("InvalidDirectory") << "directory " << fpath << " doesn't exist.";
    }
    if (!path_.empty()) {
      dir = file_->GetDirectory(path_.c_str());
      if (dir == nullptr) {
        throw cms::Exception("InvalidDirectory") << "Can't change directory to path: " << path_;
      }
    } else {
      // the base path 'path_' is empty, so just use the pointer to
      // the file.
      dir = file_;
    }
    // if a subdirectory was passed in, then this directory better
    // already exist (since you shoudln't be cd'ing into a directory
    // before making it and the cd with a subdir is only used to get
    // histograms that are already made).
    if (subdir.length()) {
      throw cms::Exception("InvalidDirectory") << "directory " << fpath << " doesn't exist.";
    }
    // if we're here, then that means that this is the first time
    // that we are calling cd() on this directory AND cd() has not
    // been called with a subdirectory, so go ahead and make the
    // directory.
    dir = _mkdir(dir, dir_, descr_);
  }
  bool ok = file_->cd(fpath.c_str());
  if (!ok) {
    throw cms::Exception("InvalidDirectory") << "Can't change directory to path: " << fpath;
  }
  return dir;
}

_getObj()

TObject * TFileDirectory::_getObj ( const std::string &  objname, const std::string &  subdir = ""  ) const

private

Definition at line 97 of file TFileDirectory.cc.

References Exception, and mkLumiAveragedPlots::subdir.

Referenced by getObject().

                                                                                  {
  TObject *objPtr = getBareDirectory(subdir)->Get(objname.c_str());
  if (!objPtr) {
    // no histogram found by that name.  Sorry dude.
    if (subdir.length()) {
      throw cms::Exception("ObjectNotFound") << "Can not find object named " << objname << " in subdir " << subdir;
    } else {
      throw cms::Exception("ObjectNotFound") << "Can not find object named " << objname;
    }
  }  // if nothing found
  return objPtr;
}

_mkdir()

TDirectory * TFileDirectory::_mkdir ( TDirectory *  dirPtr, const std::string &  dir, const std::string &  description  ) const

private

Definition at line 69 of file TFileDirectory.cc.

References makeListRunsInFiles::description, sistrip::dir_, Exception, oniaPATMuonsWithTrigger_cff::matches, and path_.

                                                                                                                {
  // do we have this one already
  TDirectory *subdirPtr = dirPtr->GetDirectory(subdirName.c_str());
  if (subdirPtr) {
    subdirPtr->cd();
    return subdirPtr;
  }
  // if we're here, then this directory doesn't exist.  Is this
  // directory a subdirectory?
  const boost::regex subdirRE("(.+?)/([^/]+)");
  boost::smatch matches;
  TDirectory *parentDir = nullptr;
  string useName = subdirName;
  if (boost::regex_match(subdirName, matches, subdirRE)) {
    parentDir = _mkdir(dirPtr, matches[1], description);
    useName = matches[2];
  } else {
    // This is not a subdirectory, so we're golden
    parentDir = dirPtr;
  }
  subdirPtr = parentDir->mkdir(useName.c_str());
  if (!subdirPtr) {
    throw cms::Exception("InvalidDirectory") << "Can't create directory " << dir_ << " in path: " << path_;
  }
  subdirPtr->cd();
  return subdirPtr;
}

cd()

bool TFileDirectory::cd

(

)

const

Definition at line 12 of file TFileDirectory.cc.

Referenced by TFileService::cd(), dqm_interfaces.DQMcommunicator::get_root_objects_list_recursive(), dqm_interfaces.DQMcommunicator::get_root_objects_names_list_recursive(), dqm_interfaces.DQMcommunicator::get_root_objects_recursive(), and dqm_interfaces.DirWalkerFile::walk().

                              {
  _cd("", false);
  return true;
}

fullPath()

std::string TFileDirectory::fullPath

(

)

const

return the full path of the stored histograms

Definition at line 110 of file TFileDirectory.cc.

References sistrip::dir_, path_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by TFileService::fullPath().

{ return string(path_.empty() ? dir_ : path_ + "/" + dir_); }

getBareDirectory()

TDirectory * TFileDirectory::getBareDirectory

(

const std::string &

subdir = ""

)

const

Definition at line 10 of file TFileDirectory.cc.

References mkLumiAveragedPlots::subdir.

Referenced by TFileService::getBareDirectory().

{ return _cd(subdir, false); }

getObject()

template<typename T >

T* TFileDirectory::getObject ( const std::string &  objname, const std::string &  subdir = ""  )

inline

Definition at line 40 of file TFileDirectory.h.

References _getObj(), Exception, and mkLumiAveragedPlots::subdir.

Referenced by TFileService::getObject().

                                                                       {
    TObject *objPtr = _getObj(objname, subdir);
    // Ok, we've got it.  Let's see if it's a histogram
    T *retval = dynamic_cast<T *>(objPtr);
    if (!retval) {
      // object isn't a of class T
      throw cms::Exception("ObjectNotCorrectlyTyped") << "Object named " << objname << " is not of correct type";
    }
    return retval;
  }

make()

template<typename T , typename... Args>

T* TFileDirectory::make ( const Args &...  args ) const

inline

make new ROOT object

Definition at line 53 of file TFileDirectory.h.

References _cd(), writedatasetfile::args, HLT_2022v15_cff::Class, ztail::d, EcalMonitorTask_cff::func, and submitPVValidationJobs::t.

Referenced by cms::SiPixelCondObjOfflineReader::analyze(), cms::SiPixelCondObjReader::analyze(), cms::SiPixelCondObjAllPayloadsReader::analyze(), cms::SiPixelCondObjForHLTReader::analyze(), HFPMTHitAnalyzer::beginJob(), L1GctValidation::beginJob(), l1t::L1TGlobalAnalyzer::beginJob(), NearbyPixelClustersAnalyzer::beginJob(), PrimaryVertexValidation::beginJob(), SplitVertexResolution::beginJob(), HistoParams< T >::beginRun(), HistoParams< TH2F >::beginRun(), HistoParams< TProfile2D >::beginRun(), BigEventsDebugger< T >::BigEventsDebugger(), AlignmentMonitorSurvey::book(), DigiBXCorrHistogramMaker< EventWithHistory >::book(), VertexHistogramMaker::book(), BSvsPVHistogramMaker::book(), AlignmentMonitorMuonResiduals::book(), AlignmentMonitorBase::book1D(), AlignmentMonitorBase::book2D(), tmtt::Histos::bookEtaPhiSectors(), L1GtDataEmulAnalyzer::bookHistograms(), tmtt::Histos::bookInputData(), AlignmentMonitorBase::bookProfile(), ApeEstimator::bookSectorHistsForAnalyzerMode(), ApeEstimator::bookSectorHistsForApeCalculation(), tmtt::Histos::bookTrackCands(), tmtt::Histos::bookTrackFitting(), ApeEstimator::bookTrackHists(), ECalSD::ECalSD(), TrackerTreeGenerator::endJob(), PrimaryVertexValidation::endJob(), SplitVertexResolution::endJob(), DMRChecker::endJob(), GctErrorAnalyzer::GctErrorAnalyzer(), HCalSD::HCalSD(), HFGflash::HFGflash(), HFShowerParam::HFShowerParam(), main(), TFileService::make(), tmtt::Histos::makeEfficiencyPlot(), MultiplicityTimeCorrelations::MultiplicityTimeCorrelations(), GctErrorAnalyzer::plotEGErrors(), GctErrorAnalyzer::plotHFErrors(), GctErrorAnalyzer::plotJetErrors(), GctErrorAnalyzer::plotMissingEErrors(), GctErrorAnalyzer::plotTotalEErrors(), TestPythiaDecays::TestPythiaDecays(), tmtt::Histos::trackerGeometryAnalysis(), and TrackerGeometryCompare::TrackerGeometryCompare().

                                     {
    TDirectory *d = _cd();
    T *t = new T(args...);
    ROOT::DirAutoAdd_t func = T::Class()->GetDirectoryAutoAdd();
    if (func) {
      TH1AddDirectorySentry sentry;
      func(t, d);
    } else {
      d->Append(t);
    }
    return t;
  }

mkdir()

TFileDirectory TFileDirectory::mkdir	(	const std::string &	dir,
		const std::string &	descr = ""
	)

create a new subdirectory

Definition at line 112 of file TFileDirectory.cc.

References DeadROC_duringRun::dir, and contentValuesFiles::fullPath.

Referenced by l1t::L1TStage2CaloAnalyzer::analyze(), SiStripSpyDisplayModule::analyze(), fwlite::AnalyzerWrapper< T >::AnalyzerWrapper(), DigiInvestigatorHistogramMaker::book(), DigiVtxPosCorrHistogramMaker::book(), DigiPileupCorrHistogramMaker::book(), DigiVertexCorrHistogramMaker::book(), DigiLumiCorrHistogramMaker::book(), ApeEstimator::bookSectorHistsForApeCalculation(), VariablePlotter::fill(), GctErrorAnalyzer::GctErrorAnalyzer(), TFileService::mkdir(), and batchmanager.BatchManager::PrepareJob().

                                                                                 {
  TH1AddDirectorySentry sentry;
  _cd();
  return TFileDirectory(dir, descr, file_, fullPath());
}

Friends And Related Function Documentation

fwlite::TFileService

friend class fwlite::TFileService

friend

Definition at line 84 of file TFileDirectory.h.

TFileService

friend class TFileService

friend

Output file.

Definition at line 83 of file TFileDirectory.h.

Member Data Documentation

descr_

std::string TFileDirectory::descr_

private

Definition at line 86 of file TFileDirectory.h.

Referenced by TFileService::setDirectoryName().

dir_

std::string TFileDirectory::dir_

private

Definition at line 86 of file TFileDirectory.h.

Referenced by TFileService::setDirectoryName().

file_

TFile* TFileDirectory::file_

private

Definition at line 85 of file TFileDirectory.h.

Referenced by TFileService::setDirectoryName(), and TFileService::TFileService().

path_

std::string TFileDirectory::path_

private

Definition at line 86 of file TFileDirectory.h.