EL::Detail::OutputStreamData Class Reference

all data needed to manage a given output stream More...

#include <OutputStreamData.h>

Collaboration diagram for EL::Detail::OutputStreamData:

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	OutputStreamData (const std::string &val_fileName, const std::string &mode)
	open the given file and create an output stream for it
	OutputStreamData (std::unique_ptr< TFile > val_file)
	create this output stream for a pre-opened file
	OutputStreamData (std::unique_ptr< SH::DiskWriter > val_writer)
	create this output stream for a custom writer
const std::string &	mainStreamName () const noexcept
	the name of the main stream
void	setMainStreamName (const std::string &val_mainStreamName)
TFile *	file () const noexcept
	the file we are writing to
void	saveOutput ()
	write the list of output objects to disk and clear it
void	close ()
	close this file
std::string	finalFileName () const
	the final path of the file created
void	addOutput (std::unique_ptr< TObject > outputObject)
	add the given output object to this stream
void	addClone (const TObject &prototypeObject)
	add a clone of the given object to the output
TDirectory *	makeDirectoryFor (std::string &name)
	make the directory for the object of the given name
TObject *	getOutputHist (const std::string &name) const noexcept
	get the output histogram with the given name, or nullptr if there is no histogam with such a name
TTree *	getOutputTree (const std::string &name) const noexcept
	get the output tree with the given name, or nullptr if there is no tree with such a name

Private Attributes
std::string	m_mainStreamName
	the name of the main stream
std::unique_ptr< SH::DiskWriter >	m_writer
	the writer we use
std::vector< std::unique_ptr< TObject > >	m_output
	the list of objects to write out at the end of job
std::unordered_map< std::string, TObject * >	m_outputHistMap
	the output histogram map
std::unordered_map< std::string, TTree * >	m_outputTreeMap
	the output tree map

Detailed Description

all data needed to manage a given output stream

Definition at line 29 of file OutputStreamData.h.

Constructor & Destructor Documentation

OutputStreamData() [1/3]

EL::Detail::OutputStreamData::OutputStreamData ( const std::string & val_fileName, const std::string & mode )

explicit

open the given file and create an output stream for it

Guarantee

strong

Failures

out of memory II

Definition at line 114 of file OutputStreamData.cxx.

      : OutputStreamData (checkedOpenFile (val_fileName, mode))
    {
      // no invariant used
    }

OutputStreamData() [2/3]

EL::Detail::OutputStreamData::OutputStreamData ( std::unique_ptr< TFile > val_file )

explicit

create this output stream for a pre-opened file

Guarantee

strong

Failures

out of memory II

Definition at line 123 of file OutputStreamData.cxx.

      : OutputStreamData (std::make_unique<MyWriter> (std::move (file)))
    {
      // no invariant used
    }

OutputStreamData() [3/3]

EL::Detail::OutputStreamData::OutputStreamData ( std::unique_ptr< SH::DiskWriter > val_writer )

explicit

create this output stream for a custom writer

Guarantee

strong

Failures

out of memory II

Definition at line 132 of file OutputStreamData.cxx.

      : m_writer (std::move (val_writer))
    {
      RCU_NEW_INVARIANT (this);
    }

Member Function Documentation

addClone()

void EL::Detail::OutputStreamData::addClone

(

const TObject &

prototypeObject

)

add a clone of the given object to the output

Guarantee

basic

Failures

cloning failures
out of memory II

Definition at line 260 of file OutputStreamData.cxx.

    {
      // no invariant used
 
      // Do not change the user's "current directory" during any of the
      // following...
      DirectoryReset dirReset;
 
      // Make a clone of the object, and make sure we are already in
      // the right directory if needed
      std::string name = prototypeObject.GetName();
      TDirectory *dir = makeDirectoryFor (name);
      dir->cd();
 
      std::unique_ptr<TObject> clone {prototypeObject.Clone()};
 
      // Hold on to the pointer of the tree in our internal cache.
      addOutput (std::move (clone));
    }

addOutput()

void EL::Detail::OutputStreamData::addOutput

(

std::unique_ptr< TObject >

outputObject

)

add the given output object to this stream

While the caller transfers ownership to this object, he may retain a reference to the object until saveOutput or close is called.

Guarantee

basic

Failures

out of memory II

Definition at line 223 of file OutputStreamData.cxx.

    {
      RCU_CHANGE_INVARIANT (this);
 
      TTree *const tree = dynamic_cast<TTree*> (outputObject.get());
      if (tree)
      {
        std::string name = tree->GetName();
        std::string treeName = tree->GetName();
 
        TDirectory *dir = makeDirectoryFor (treeName);
 
        // if we are in a sub-directory we need to rename the tree
        if (name != treeName)
          tree->SetName (treeName.c_str());
 
        // pass ownership of the tree to the directory
        tree->SetDirectory (dir);
        outputObject.release();
 
        m_outputTreeMap[name] = tree;
 
 
      } else
      {
        TH1 *const hist = dynamic_cast<TH1*> (outputObject.get());
 
        m_outputHistMap[outputObject->GetName()] = outputObject.get();
        m_output.emplace_back (std::move (outputObject));
        if (hist)
          hist->SetDirectory (nullptr);
      }
    }

close()

void EL::Detail::OutputStreamData::close

(

)

close this file

Guarantee

basic

Failures

i/o errors

Definition at line 172 of file OutputStreamData.cxx.

    {
      RCU_CHANGE_INVARIANT (this);
      saveOutput ();
      m_writer->close ();
    }

file()

TFile * EL::Detail::OutputStreamData::file ( ) const

noexcept

the file we are writing to

Guarantee

no-fail

Postcondition

result != nullptr

Definition at line 161 of file OutputStreamData.cxx.

    {
      RCU_READ_INVARIANT (this);
      TFile *result = m_writer->file();
      RCU_PROVIDE (result != nullptr);
      return result;
    }

finalFileName()

std::string EL::Detail::OutputStreamData::finalFileName

(

)

const

the final path of the file created

Guarantee

strong

Failures

out of memory II

Definition at line 182 of file OutputStreamData.cxx.

    {
      RCU_READ_INVARIANT (this);
      return m_writer->path ();
    }

getOutputHist()

TObject * EL::Detail::OutputStreamData::getOutputHist ( const std::string & name ) const

noexcept

get the output histogram with the given name, or nullptr if there is no histogam with such a name

Guarantee

no-fail

Definition at line 312 of file OutputStreamData.cxx.

    {
      RCU_READ_INVARIANT (this);
 
      auto iter = m_outputHistMap.find (name);
      return iter != m_outputHistMap.end() ? iter->second : nullptr;
    }

getOutputTree()

TTree * EL::Detail::OutputStreamData::getOutputTree ( const std::string & name ) const

noexcept

get the output tree with the given name, or nullptr if there is no tree with such a name

Guarantee

no-fail

Definition at line 323 of file OutputStreamData.cxx.

    {
      RCU_READ_INVARIANT (this);
 
      auto iter = m_outputTreeMap.find (name);
      return iter != m_outputTreeMap.end() ? iter->second : nullptr;
    }

mainStreamName()

const std::string & EL::Detail::OutputStreamData::mainStreamName ( ) const

noexcept

the name of the main stream

Some streams are aliases for other streams. This is the name of the main stream in this case, otherwise it is the name of this stream.

Definition at line 141 of file OutputStreamData.cxx.

    {
      RCU_READ_INVARIANT (this);
      return m_mainStreamName;
    }

makeDirectoryFor()

TDirectory * EL::Detail::OutputStreamData::makeDirectoryFor

(

std::string &

name

)

make the directory for the object of the given name

This will make sure that we pick the proper sub-directory if needed.

Guarantee

basic

Failures

directory creation failures

Definition at line 283 of file OutputStreamData.cxx.

    {
      RCU_CHANGE_INVARIANT (this);
 
      TDirectory *result = file();
      std::string::size_type split = name.rfind ("/");
      if (split == std::string::npos)
      {
        return result;
      } else
      {
        const std::string dirname = name.substr (0, split);
        name = name.substr (split + 1);
        TDirectory *subdir = dynamic_cast<TDirectory*>(result->Get (dirname.c_str()));
        if (!subdir)
        {
          result->mkdir (dirname.c_str());
          subdir = dynamic_cast<TDirectory*>(result->Get (dirname.c_str()));
          RCU_ASSERT (subdir != nullptr);
        }
        result = subdir;
        RCU_ASSERT (result != nullptr);
        return result;
      }
    }

saveOutput()

void EL::Detail::OutputStreamData::saveOutput

(

)

write the list of output objects to disk and clear it

Guarantee

basic

Failures

i/o errors

Definition at line 191 of file OutputStreamData.cxx.

    {
      RCU_CHANGE_INVARIANT (this);
      TFile *const file {m_writer->file()};
      RCU_ASSERT (file != nullptr);
      for (std::unique_ptr<TObject>& object : m_output)
      {
        std::string name = object->GetName();
        TDirectory *dir = makeDirectoryFor (name);
        if (dir != file)
        {
          TNamed *named = dynamic_cast<TNamed*>(object.get());
          if (named)
            named->SetName (name.c_str());
        }
 
        if (!RCU::SetDirectory (object.get(), dir))
        {
          dir->WriteObject (object.get(), name.c_str());
        }
        //release object which was consumed by SetDirectory or WriteObject
        //placate cppcheck using std::ignore
        std::ignore = object.release();
      }
      m_outputHistMap.clear ();
      m_outputTreeMap.clear ();
      m_output.clear ();
    }

setMainStreamName()

void EL::Detail::OutputStreamData::setMainStreamName

(

const std::string &

val_mainStreamName

)

Definition at line 150 of file OutputStreamData.cxx.

    {
      RCU_CHANGE_INVARIANT (this);
      if (!m_mainStreamName.empty())
        throw std::runtime_error ("main stream name already set");
      m_mainStreamName = val_mainStreamName;
    }

testInvariant()

void EL::Detail::OutputStreamData::testInvariant

(

)

const

test the invariant of this object

Definition at line 105 of file OutputStreamData.cxx.

    {
      RCU_INVARIANT (this != nullptr);
      RCU_INVARIANT (m_writer != nullptr);
    }

Member Data Documentation

m_mainStreamName

std::string EL::Detail::OutputStreamData::m_mainStreamName

private

the name of the main stream

Definition at line 176 of file OutputStreamData.h.

m_output

std::vector<std::unique_ptr<TObject> > EL::Detail::OutputStreamData::m_output

private

the list of objects to write out at the end of job

Definition at line 184 of file OutputStreamData.h.

m_outputHistMap

std::unordered_map<std::string,TObject*> EL::Detail::OutputStreamData::m_outputHistMap

private

the output histogram map

Definition at line 188 of file OutputStreamData.h.

m_outputTreeMap

std::unordered_map<std::string,TTree*> EL::Detail::OutputStreamData::m_outputTreeMap

private

the output tree map

Definition at line 192 of file OutputStreamData.h.

m_writer

std::unique_ptr<SH::DiskWriter> EL::Detail::OutputStreamData::m_writer

private

the writer we use

Definition at line 180 of file OutputStreamData.h.

---

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

• OutputStreamData.h
• OutputStreamData.cxx