FairFileSourceBase.h

/********************************************************************************
 * Copyright (C) 2022-2024 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public Licence (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/

#ifndef __FAIRROOT__FairFileSourceBase__
#define __FAIRROOT__FairFileSourceBase__

#include "FairMemory.h"
#include "FairSource.h"

#include <TFile.h>
#include <TObjArray.h>
#include <TTree.h>
#include <list>
#include <map>

/**
 * \brief Internal base class for FairFileSource and FairMixedSource
 */
class FairFileSourceBase : public FairSource
{
    friend class FairFileSource;
    friend class FairMixedSource;

  public:
    ~FairFileSourceBase() override;
    void Reset() override {}
    Source_Type GetSourceType() override { return kFILE; }
    void SetParUnpackers() override {}
    Bool_t InitUnpackers() override { return kTRUE; }
    Bool_t ReInitUnpackers() override { return kTRUE; }

    TFile* GetInFile() { return fRootFile.get(); }
    const TFile* GetRootFile() { return fRootFile.get(); }

    TObjArray* GetListOfFolders() { return &fListFolder; }
    Bool_t CompareBranchList(TFile* fileHandle, TString inputLevel);

  protected:
    FairFileSourceBase() = default;
    FairFileSourceBase(fairroot::detail::maybe_owning_ptr<TFile> file);

    std::map<TString, std::list<TString>> fCheckInputBranches{};   //!

    static bool ActivateObjectAnyImpl(TTree* source, void** obj, const std::type_info& info, const char* brname);

  private:
    /**ROOT file*/
    fairroot::detail::maybe_owning_ptr<TFile> fRootFile;   //!
    /** list of folders from all input (and friends) files*/
    TObjArray fListFolder{16};   //!

    // private virtual methods:
    void Close() override
    {
        if (fRootFile != nullptr) {
            fRootFile->Close();
        }
    }

    ClassDefOverride(FairFileSourceBase, 0);
};

#endif