FairSink.h

Go to the documentation of this file.

/********************************************************************************
 *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *         GNU Lesser General Public Licence version 3 (LGPL) version 3,        *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/
// Modified for ALICE O2 in 2026: parts not used by O2 were removed (see README.md in this directory).
// -----------------------------------------------------------------------------
// -----                                                                   -----
// -----                             FairSink                              -----
// -----                    Created 22.12.2017 by R. Karabowicz            -----
// -----                                                                   -----
// -----------------------------------------------------------------------------
 
#ifndef FAIRSINK_H
#define FAIRSINK_H
 
#include <Rtypes.h>
#include <TString.h>
#include <map>        // map
#include <memory>     // unique_ptr
#include <string>     // string
#include <typeinfo>   // type_info
 
#include <TFolder.h>   // rootcling needs the complete type for the dictionary
                       // (it used to arrive via the now-deleted FairFileSource)
 
class TObject;
class TTree;
 
enum Sink_Type
{
    kONLINESINK,
    kFILESINK
};
 
class FairSink
{
  public:
    FairSink();
    FairSink(const FairSink& sink);
    virtual ~FairSink();
 
    virtual Bool_t InitSink() = 0;
    virtual void Close() = 0;
    virtual void Reset() = 0;
 
    virtual Sink_Type GetSinkType() = 0;
    virtual TString GetFileName() { return ""; }
 
    void SetRunId(Int_t runId) { fRunId = runId; }
    Int_t GetRunId() const { return fRunId; }
 
    virtual void SetOutTree(TTree* fTree) = 0;
 
    virtual void Fill() = 0;
 
    virtual Int_t Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) = 0;
 
    virtual void RegisterImpl(const char*, const char*, void*) = 0;
    virtual void RegisterAny(const char* brname, const std::type_info& oi, const std::type_info& pi, void* obj) = 0;
 
    virtual void WriteFolder() = 0;
    virtual bool CreatePersistentBranchesAny() = 0;
 
    virtual void WriteObject(TObject* f, const char*, Int_t option = 0) = 0;
    virtual void WriteGeometry() = 0;
 
    virtual FairSink* CloneSink() = 0;
 
  protected:
    struct TypeAddressPair
    {
        TypeAddressPair(const std::type_info& oi, const std::type_info& pi, void* a)
            : origtypeinfo(oi)
            , persistenttypeinfo(pi)
            , ptraddr(a)
        {}
        const std::type_info& origtypeinfo;         // type_info of type addr points to
        const std::type_info& persistenttypeinfo;   // type_info of ROOT persistent branch (drops pointers)
        void* ptraddr;                              // address of a pointer (pointing to origtypeinfo);
    };
 
    Int_t fRunId;
 
    TFolder* fOutFolder;
    std::map<std::string, std::unique_ptr<TypeAddressPair const>> fPersistentBranchesMap;   
 
  public:
    ClassDef(FairSink, 1);
};
 
#endif