icarus::trigger::PlotSandbox::TFileDirectoryHelper Struct Reference

Contains both a art::TFileDirectory and the TDirectory it manages. More...

Public Member Functions
	TFileDirectoryHelper (art::TFileDirectory dir, TDirectory *ROOTdir)
template<typename RootDir >
auto	create (art::TFileDirectory parentDir, std::string const &subdir, std::string const &dirTitle) -> TFileDirectoryHelper

Static Public Member Functions
template<typename RootDir = TDirectoryFile>
static TFileDirectoryHelper	create (art::TFileDirectory parentDir, std::string const &subdir, std::string const &dirTitle="")
	Creates a helper managing a subdirectory of parentDir. More...
static TFileDirectoryHelper	create (art::TFileDirectory dir)

Public Attributes
art::TFileDirectory	fDir
TDirectory *	fROOTdir

Detailed Description

Contains both a art::TFileDirectory and the TDirectory it manages.

Definition at line 103 of file PlotSandbox.h.

Constructor & Destructor Documentation

icarus::trigger::PlotSandbox::TFileDirectoryHelper::TFileDirectoryHelper ( art::TFileDirectory  dir, TDirectory *  ROOTdir  )

inline

Definition at line 107 of file PlotSandbox.h.

      : fDir(dir), fROOTdir(ROOTdir) {}

Member Function Documentation

template<typename RootDir = TDirectoryFile>

static TFileDirectoryHelper icarus::trigger::PlotSandbox::TFileDirectoryHelper::create ( art::TFileDirectory  parentDir, std::string const &  subdir, std::string const &  dirTitle = ""  )

static

Creates a helper managing a subdirectory of parentDir.

auto icarus::trigger::PlotSandbox::TFileDirectoryHelper::create ( art::TFileDirectory  dir )

static

Definition at line 32 of file PlotSandbox.cxx.

{
  
  /*
   * Finding the ROOT directory is going to be tricky, since the interface
   * includes: `mkdir()`, `make()` and `makeAndRegister()`. Woah.
   * 
   * So the plan is:
   * 1. have `art::TFileDirectory` `make()` a new ROOT object in its directory;
   *    let that ROOT object be a `TDirectory`
   * 2. `TDirectory` is placed by default in the current directory (as usual),
   *    and it knows which its parent directory is
   * 3. after learning which that parent directory is, we delete the directory
   *    we just created; this also updates the mother directory
   */
  
  static constexpr const char* TestDirName = " PlotSandbox invalid name! ";
  
  // even if another directory with this name existed, it would not be replaced,
  // but rather another one would be created with this name:
  TDirectory* testDir = dir.make<TDirectory>(TestDirName, TestDirName);
  if (!testDir) {
    throw cet::exception("PlotSandbox") << "TFileDirectoryHelper::create() "
      "failed to figure out the ROOT directory!\n";
  }
  TDirectory* pROOTdir = testDir->GetMotherDir();
  MF_LOG_DEBUG("TFileDirectoryHelper")
    << "icarus::trigger::PlotSandbox::TFileDirectoryHelper::create(): "
    << "found parent directory: '" << pROOTdir->GetName() << "'";
  // ... and even if there are multiple directories with the same name, using
  // the pointer to the object makes this deletion affect only the object itself
  delete testDir;
  
  return { dir, pROOTdir };
} // icarus::trigger::PlotSandbox::TFileDirectoryHelper::create()

template<typename RootDir >

auto icarus::trigger::PlotSandbox::TFileDirectoryHelper::create	(	art::TFileDirectory	parentDir,
		std::string const &	subdir,
		std::string const &	dirTitle
	)		-> TFileDirectoryHelper

Definition at line 620 of file PlotSandbox.h.

{
  // NOTE: we only support a direct subdirectory of parentDir.
  // NOTE: if the directory already exists the results are undefined;
  //       we can't figure out if the direct
  
  // first we create the directory directly via ROOT,
  // but starting from the directory stored in `parentDir`
  TDirectory* pROOTdir
    = parentDir.make<RootDir>(subdir.c_str(), dirTitle.c_str());
  
  // then we create a `art::TFileDirectory` for the same directory;
  // this is the only way we can create a new `art::TFileDirectory`,
  // and it actually does not create the ROOT directory because it's lazy,
  // and it will create it only when it is needed, if not present yet.
  return { parentDir.mkdir(subdir, dirTitle), pROOTdir };
  
} // icarus::trigger::PlotSandbox::TFileDirectoryHelper::create()

Member Data Documentation

art::TFileDirectory icarus::trigger::PlotSandbox::TFileDirectoryHelper::fDir

Definition at line 104 of file PlotSandbox.h.

TDirectory* icarus::trigger::PlotSandbox::TFileDirectoryHelper::fROOTdir

Definition at line 105 of file PlotSandbox.h.

---

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

• PlotSandbox.h
• PlotSandbox.cxx