SimpleVariableRecorder Class Reference

Class to write collected variables into a root file, Used by VXDQETrainingDataCollectorModule. More...

#include <SimpleVariableRecorder.h>

Public Member Functions
	SimpleVariableRecorder (const std::function< void(TTree &)> &setBranches, const std::string &rootFileName, const std::string &treeName="recorded_tree")
	Construct the Recorder opening the given ROOT file and create the underlying TTree and add let the given function setup branches.
	SimpleVariableRecorder (std::vector< TrackingUtilities::Named< float * > > &namedVariables, const std::string &fileName, const std::string &treeName)
	Construct the Recorder opening the given ROOT file and create the underlying TTree and add let the given function setup branches.
	~SimpleVariableRecorder ()
	Destructor that closes used TTrees and TFiles.
	SimpleVariableRecorder (SimpleVariableRecorder &)=delete
	copy constructor needs to be implemented if needed as class has dynamic memory/resource allocation (as pointed out by cppcheck)
SimpleVariableRecorder &	operator= (SimpleVariableRecorder &)=delete
	assignment operator ("=") needs to be implemented if needed as class has dynamic memory/resource allocation (as pointed out by cppcheck)
void	record ()
	Record variables by filling the TTree.
void	write ()
	Write out TFile to root file.

Protected Attributes
TFile *	m_tFile
	ROOT file to which should be written.
StoreObjPtr< RootMergeable< TTree > >	m_tTree
	TTree that contains recorded variables.

Detailed Description

Class to write collected variables into a root file, Used by VXDQETrainingDataCollectorModule.

Definition at line 32 of file SimpleVariableRecorder.h.

Constructor & Destructor Documentation

SimpleVariableRecorder() [1/2]

SimpleVariableRecorder ( const std::function< void(TTree &)> & setBranches, const std::string & rootFileName, const std::string & treeName = "recorded_tree" )

inline

Construct the Recorder opening the given ROOT file and create the underlying TTree and add let the given function setup branches.

Parameters

setBranches	Function invoked with the underlying TTree as argument which is supposed create Branches and provide the value addresses.
rootFileName	Name of ROOT file to which should be written.
treeName	Name of the TTree in the ROOT file.

Definition at line 45 of file SimpleVariableRecorder.h.

                                                                        :
      m_tFile(nullptr),
      m_tTree(treeName, DataStore::c_Persistent)
    {
      TDirectory* ptrSavedCurrentTDirectory = gDirectory;
 
      m_tFile = new TFile(rootFileName.c_str(), "RECREATE");
      m_tFile->cd();
 
      m_tTree.registerInDataStore(DataStore::c_DontWriteOut | DataStore::c_ErrorIfAlreadyRegistered);
      m_tTree.construct(treeName.c_str(), treeName.c_str());
      if (m_tTree) {
        setBranches(m_tTree->get());
      }
 
      if (ptrSavedCurrentTDirectory) {
        ptrSavedCurrentTDirectory->cd();
      } else {
        gROOT->cd();
      }
    }

SimpleVariableRecorder() [2/2]

SimpleVariableRecorder ( std::vector< TrackingUtilities::Named< float * > > & namedVariables, const std::string & fileName, const std::string & treeName )

inline

Construct the Recorder opening the given ROOT file and create the underlying TTree and add let the given function setup branches.

Parameters

namedVariables	Vector of collected named variables to be turned into Branches in a TTree
fileName	Name of ROOT file to which should be written.
treeName	Name of the TTree in the ROOT file.

Definition at line 77 of file SimpleVariableRecorder.h.

                                                      :
      SimpleVariableRecorder([ & namedVariables](TTree & tree)
    {
      for (auto& variable : namedVariables) {
        tree.Branch(variable.getName().c_str(), variable.getValue());
      }
    }, fileName, treeName)
    { }

~SimpleVariableRecorder()

~SimpleVariableRecorder ( )

inline

Destructor that closes used TTrees and TFiles.

Definition at line 88 of file SimpleVariableRecorder.h.

    {
      if (!ProcHandler::parallelProcessingUsed() or ProcHandler::isOutputProcess()) {
        if (m_tTree) {
          m_tTree->get().SetDirectory(nullptr);
        }
        if (m_tFile) {
          m_tFile->Close();
        }
      }
    }

Member Function Documentation

record()

void record ( )

inline

Record variables by filling the TTree.

Definition at line 109 of file SimpleVariableRecorder.h.

{ m_tTree->get().Fill();}

write()

void write ( )

inline

Write out TFile to root file.

Definition at line 112 of file SimpleVariableRecorder.h.

    {
      if (!ProcHandler::parallelProcessingUsed() or ProcHandler::isOutputProcess()) {
        if (m_tTree) {
          // Due to some weird behaviour we  have to cd to the file of the TTree
          // before saving in order to have the tree in the correct file.
          TDirectory* tmpDirectory = gDirectory;
 
          TFile* tFile = m_tTree->get().GetCurrentFile();
          if (tFile) {
            // We still own the TFile.
            tFile->cd();
            m_tTree->get().Write("", TObject::kOverwrite);
            m_tTree->get().SetDirectory(nullptr);
          }
          // return to previous directory
          if (tmpDirectory) {
            tmpDirectory->cd();
          } else {
            gROOT->cd();
          }
 
        }
      }
    }

Member Data Documentation

m_tFile

TFile* m_tFile

protected

ROOT file to which should be written.

Definition at line 140 of file SimpleVariableRecorder.h.

m_tTree

StoreObjPtr<RootMergeable<TTree> > m_tTree

protected

TTree that contains recorded variables.

Definition at line 142 of file SimpleVariableRecorder.h.

---

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

• tracking/trackFindingVXD/variableExtractors/include/SimpleVariableRecorder.h