Gaudi::NTuple::FileHolder< Base > Struct Template Reference

Small class wrapping an algorithm and adding management of a Root File via the FileSvc. More...

#include </builds/gaudi/Gaudi/GaudiUtils/include/Gaudi/NTuple/Writer.h>

Inheritance diagram for Gaudi::NTuple::FileHolder< Base >:

Collaboration diagram for Gaudi::NTuple::FileHolder< Base >:

Public Member Functions
TFile *	file ()
virtual StatusCode	initialize () override

Private Attributes
Gaudi::Property< std::string >	m_fileId { this, "OutputFile", "NTuple", "Identifier for the TFile to write to." }
ServiceHandle< Gaudi::Interfaces::IFileSvc >	m_fileSvc { this, "FileSvc", "FileSvc" }
std::shared_ptr< TFile >	m_file = nullptr

Detailed Description

template<typename Base>
struct Gaudi::NTuple::FileHolder< Base >

Small class wrapping an algorithm and adding management of a Root File via the FileSvc.

The file to be used is identified via Property OutputFile Can typically be used in conjunction with Wrapper to add support for NTuples in a given algorithm For simple cases (single NTuple), prefer to inherit directly from SimpleWriter or Writer (in case a single entry per event is required)

Definition at line 119 of file Writer.h.

Member Function Documentation

file()

template<typename Base>

TFile * Gaudi::NTuple::FileHolder< Base >::file ( )

inline

Definition at line 121 of file Writer.h.

{ return m_file.get(); }

initialize()

template<typename Base>

virtual StatusCode Gaudi::NTuple::FileHolder< Base >::initialize ( )

inlineoverridevirtual

Reimplemented in Gaudi::NTuple::SimpleWriter< std::tuple< OUTPUTs... >(const INPUTs &...), Traits_ >.

Definition at line 123 of file Writer.h.

                                             {
      return Base::initialize().andThen( [this]() {
        m_file = m_fileSvc->getFile( m_fileId );
        if ( !m_file ) {
          this->error() << "Failed to retrieve TFile." << endmsg;
          return StatusCode::FAILURE;
        }
        return StatusCode::SUCCESS;
      } );
    }

Member Data Documentation

m_file

template<typename Base>

std::shared_ptr<TFile> Gaudi::NTuple::FileHolder< Base >::m_file = nullptr

private

Definition at line 137 of file Writer.h.

m_fileId

template<typename Base>

Gaudi::Property<std::string> Gaudi::NTuple::FileHolder< Base >::m_fileId { this, "OutputFile", "NTuple", "Identifier for the TFile to write to." }

private

Definition at line 135 of file Writer.h.

{ this, "OutputFile", "NTuple", "Identifier for the TFile to write to." };

m_fileSvc

template<typename Base>

ServiceHandle<Gaudi::Interfaces::IFileSvc> Gaudi::NTuple::FileHolder< Base >::m_fileSvc { this, "FileSvc", "FileSvc" }

private

Definition at line 136 of file Writer.h.

{ this, "FileSvc", "FileSvc" };

---

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

• GaudiUtils/include/Gaudi/NTuple/Writer.h