feat: Start with FairRunSim::ls()

ChristianTackeGSI · ChristianTackeGSI · commit 850f7aa322ea · 2023-09-14T16:21:18.000+02:00
Allow to list the object hierarchy under a FairRunSim.
diff --git a/examples/advanced/Tutorial3/macro/run_sim.C b/examples/advanced/Tutorial3/macro/run_sim.C
@@ -6,6 +6,19 @@
  *                  copied verbatim in the file "LICENSE"                       *
  ********************************************************************************/
 
+#if !defined(__CLING__) || defined(__ROOTCLING__)
+#include "FairBoxGenerator.h"
+#include "FairCave.h"
+#include "FairConstField.h"
+#include "FairMagnet.h"
+#include "FairParRootFileIo.h"
+#include "FairPrimaryGenerator.h"
+#include "FairRootFileSink.h"
+#include "FairRunSim.h"
+#include "FairSystemInfo.h"
+#include "FairTestDetector.h"
+#endif
+
 #include <TStopwatch.h>
 #include <TString.h>
 #include <TSystem.h>
@@ -132,6 +145,7 @@ void run_sim(Int_t nEvents = 100, TString mcEngine = "TGeant4")
     run.CreateGeometryFile(geoFile);
 
     // -----   Finish   -------------------------------------------------------
+    run.ls();
 
     cout << endl << endl;
 
diff --git a/fairroot/base/sim/FairMCApplication.cxx b/fairroot/base/sim/FairMCApplication.cxx
@@ -1311,3 +1311,20 @@ void FairMCApplication::UndoGeometryModifications()
 
     gGeoManager->ClearPhysicalNodes(kFALSE);
 }
+
+void FairMCApplication::ls(Option_t* option) const
+{
+    TVirtualMCApplication::ls(option);
+    TROOT::IncreaseDirLevel();
+    if (fMC) {
+        fMC->ls(option);
+    }
+    if (fStack) {
+        fStack->ls(option);
+    }
+    // fTrajFilter->ls(option);
+    // fRadLenMan->ls(option);
+    // fRadMapMan->ls(option);
+    // fRadGridMan->ls(option);
+    TROOT::DecreaseDirLevel();
+}
diff --git a/fairroot/base/sim/FairMCApplication.h b/fairroot/base/sim/FairMCApplication.h
@@ -233,6 +233,8 @@ class FairMCApplication : public TVirtualMCApplication
      */
     auto GetIsMT() { return fMC ? fMC->IsMT() : false; }
 
+    void ls(Option_t* option = "") const override;
+
   private:
     // methods
     Int_t GetIonPdg(Int_t z, Int_t a) const;
diff --git a/fairroot/base/sim/FairPrimaryGenerator.cxx b/fairroot/base/sim/FairPrimaryGenerator.cxx
@@ -18,6 +18,7 @@
 #include <TMath.h>          // for Sqrt
 #include <TObject.h>        // for TObject
 #include <TParticlePDG.h>   // for TParticlePDG
+#include <TROOT.h>          //
 #include <TRandom.h>        // for TRandom, gRandom
 #include <iostream>         // for operator<<, basic_ostream, etc
 
@@ -63,6 +64,7 @@ FairPrimaryGenerator::FairPrimaryGenerator()
     , fEventNr(0)
 {
     fTargetZ[0] = 0.;
+    fGenList->SetName("fGenList");
 }
 
 FairPrimaryGenerator::FairPrimaryGenerator(const char *name, const char *title)
@@ -101,6 +103,7 @@ FairPrimaryGenerator::FairPrimaryGenerator(const char *name, const char *title)
     , fEventNr(0)
 {
     fTargetZ[0] = 0.;
+    fGenList->SetName("fGenList");
 }
 
 FairPrimaryGenerator::FairPrimaryGenerator(const FairPrimaryGenerator &rhs)
@@ -139,6 +142,7 @@ FairPrimaryGenerator::FairPrimaryGenerator(const FairPrimaryGenerator &rhs)
     , fEventNr(rhs.fEventNr)
 {
     fTargetZ[0] = rhs.fTargetZ[0];
+    fGenList->SetName("fGenList");
 }
 
 Bool_t FairPrimaryGenerator::Init()
@@ -549,3 +553,11 @@ void FairPrimaryGenerator::SmearGausVertexXY(Bool_t flag)
         fSmearVertexXY = kFALSE;
     }
 }
+
+void FairPrimaryGenerator::ls(Option_t* option) const
+{
+    TNamed::ls(option);
+    TROOT::IncreaseDirLevel();
+    fGenList->ls();
+    TROOT::DecreaseDirLevel();
+}
diff --git a/fairroot/base/sim/FairPrimaryGenerator.h b/fairroot/base/sim/FairPrimaryGenerator.h
@@ -158,6 +158,8 @@ class FairPrimaryGenerator : public TNamed
 
     Int_t GetTotPrimary() { return fTotPrim; }
 
+    void ls(Option_t* option = "") const override;
+
   protected:
     /**  Copy constructor */
     FairPrimaryGenerator(const FairPrimaryGenerator &);
diff --git a/fairroot/base/sink/FairSink.cxx b/fairroot/base/sink/FairSink.cxx
@@ -15,7 +15,9 @@
 #include "FairSink.h"
 
 #include <TFolder.h>
+#include <TROOT.h>
 #include <TTree.h>
+#include <iostream>
 
 FairSink::FairSink()
     : fRunId(0)
@@ -28,3 +30,14 @@ FairSink::FairSink(const FairSink& sink)
 {}
 
 FairSink::~FairSink() {}
+
+void FairSink::ls(Option_t*) const
+{
+    TROOT::IndentLevel();
+    std::cout << "OBJ: " << IsA()->GetName() << "\n";
+    TROOT::IncreaseDirLevel();
+    if (fOutFolder) {
+        fOutFolder->ls();
+    }
+    TROOT::DecreaseDirLevel();
+}
diff --git a/fairroot/base/sink/FairSink.h b/fairroot/base/sink/FairSink.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ * Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *         GNU Lesser General Public Licence version 3 (LGPL) version 3,        *
@@ -66,6 +66,8 @@ class FairSink
 
     virtual FairSink* CloneSink() = 0;
 
+    virtual void ls(Option_t* option = "") const;
+
   protected:
     struct TypeAddressPair
     {
diff --git a/fairroot/base/steer/FairRun.cxx b/fairroot/base/steer/FairRun.cxx
@@ -259,3 +259,25 @@ void FairRun::SetSource(FairSource* othersource)
     fRootManager->SetSource(othersource);
     fSource.reset(othersource);
 }
+
+void FairRun::ls(Option_t* option) const
+{
+    TNamed::ls(option);
+    TROOT::IncreaseDirLevel();
+    fRootManager->ls(option);
+    fRtdb->ls(option);
+    if (fSource) {
+        fSource->ls(option);
+    }
+    if (fSink) {
+        fSink->ls(option);
+    }
+    if (fEvtHeader) {
+        fEvtHeader->ls(option);
+    }
+    if (fTask) {
+        fTask->ls();
+    }
+    fLinkManager.ls(option);
+    TROOT::DecreaseDirLevel();
+}
diff --git a/fairroot/base/steer/FairRun.h b/fairroot/base/steer/FairRun.h
@@ -204,6 +204,8 @@ class FairRun : public TNamed
     FairRootManager& GetRootManager() { return *fRootManager; }
     FairRootManager const& GetRootManager() const { return *fRootManager; }
 
+    void ls(Option_t* option = "") const override;
+
   private:
     FairRun(const FairRun& M);
     FairRun& operator=(const FairRun&) { return *this; }
diff --git a/fairroot/base/steer/FairRunSim.cxx b/fairroot/base/steer/FairRunSim.cxx
@@ -34,6 +34,7 @@
 #include <TList.h>         // for TList
 #include <TObjString.h>    // for TObjString
 #include <TObject.h>       // for TObject
+#include <TROOT.h>         //
 #include <TRandom.h>       // for gRandom
 #include <TSystem.h>       // for TSystem, gSystem
 #include <iostream>        // for cout, endl, ostream
@@ -72,6 +73,9 @@ FairRunSim::FairRunSim(Bool_t isMaster)
     fginstance = this;
     fRunId = 0;
     fAna = kFALSE;
+    fIons->SetName("fIons");
+    fParticles->SetName("fParticles");
+    ListOfModules->SetName("ListOfModules");
 }
 #pragma GCC diagnostic pop
 
@@ -381,4 +385,32 @@ FairMCEventHeader* FairRunSim::GetMCEventHeader()
     return fMCEvHead;
 }
 
+void FairRunSim::ls(Option_t* option) const
+{
+    FairRun::ls(option);
+    TROOT::IncreaseDirLevel();
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+    if (fGen) {
+        fGen->ls(option);
+    }
+#pragma GCC diagnostic pop
+    if (fField) {
+        fField->ls(option);
+    }
+    // if (fSimulationConfig) {
+    //     fSimulationConfig->ls(option);
+    // }
+    ListOfModules->ls();
+    fParticles->ls();
+    fIons->ls();
+    if (fMCEvHead) {
+        fMCEvHead->ls(option);
+    }
+    if (fApp) {
+        fApp->ls(option);
+    }
+    TROOT::DecreaseDirLevel();
+}
+
 TMCThreadLocal FairRunSim* FairRunSim::fginstance = nullptr;
diff --git a/fairroot/base/steer/FairRunSim.h b/fairroot/base/steer/FairRunSim.h
@@ -213,6 +213,8 @@ class FairRunSim : public FairRun
      */
     auto GetMCApplication() { return fApp; }
 
+    void ls(Option_t* option = "") const override;
+
   private:
     FairRunSim(const FairRunSim& M);
     FairRunSim& operator=(const FairRunSim&) { return *this; }
diff --git a/fairroot/parbase/FairContFact.cxx b/fairroot/parbase/FairContFact.cxx
@@ -22,6 +22,7 @@
 
 #include <TCollection.h>   // for TIter
 #include <TObjString.h>
+#include <TROOT.h>
 #include <cstring>   // for strlen
 #include <fairlogger/Logger.h>
 #include <iostream>   // for operator<<, ostream, cout, etc
@@ -145,11 +146,14 @@ const char* FairContainer::getContext()
 
 FairContFact::FairContFact()
     : TNamed()
-{}
+{
+    containers->SetName("containers");
+}
 
 FairContFact::FairContFact(const char* name, const char* title)
     : TNamed(name, title)
 {
+    containers->SetName("containers");
     FairRuntimeDb::instance()->addContFactory(this);
 }
 
@@ -234,3 +238,11 @@ Bool_t FairContFact::AddContainer(FairContainer* cont)
     containers->Add(cont);
     return kTRUE;
 }
+
+void FairContFact::ls(Option_t* option) const
+{
+    TNamed::ls(option);
+    TROOT::IncreaseDirLevel();
+    containers->ls();
+    TROOT::DecreaseDirLevel();
+}
diff --git a/fairroot/parbase/FairContFact.h b/fairroot/parbase/FairContFact.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2014-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -56,6 +56,8 @@ class FairContFact : public TNamed
     /// @param[in] container Transfers ownership if return value is true
     Bool_t AddContainer(FairContainer*);
 
+    void ls(Option_t* option = "") const override;
+
   protected:
     TList* containers{new TList};   // all parameter containers managed by this factory
     const char* getActualContext(const char* name)
diff --git a/fairroot/parbase/FairRtdbRun.cxx b/fairroot/parbase/FairRtdbRun.cxx
@@ -27,6 +27,7 @@
 
 #include <TCollection.h>   // for TIter
 #include <TList.h>         // for TList
+#include <TROOT.h>         // for TROOT
 #include <fstream>         // for fstream
 #include <iomanip>         // for setw, operator<<
 #include <iostream>        // for cout
@@ -54,6 +55,7 @@ FairRtdbRun::FairRtdbRun(const Text_t* name, const Text_t* refName)
     // constructor with the run id and reference run as strings
     //  parVersions=new TList();
     //  refRun=refName;
+    parVersions->SetName("parVersions");
 }
 
 FairRtdbRun::FairRtdbRun(Int_t r, Int_t rr)
@@ -62,6 +64,7 @@ FairRtdbRun::FairRtdbRun(Int_t r, Int_t rr)
     , parVersions(new TList())
     , refRun("")
 {
+    parVersions->SetName("parVersions");
     char name[255];
     sprintf(name, "%i", r);
     SetName(name);
@@ -74,6 +77,7 @@ FairRtdbRun::FairRtdbRun(FairRtdbRun& run)
     , refRun(run.refRun)
 {
     // copy constructor
+    parVersions->SetName("parVersions");
     TList* lv = run.getParVersions();
     TIter next(lv);
     FairParVersion* pv;
@@ -162,3 +166,13 @@ void FairRtdbRun::write(std::fstream& fout)
              << v->getRootVersion() << '\n';
     }
 }
+
+void FairRtdbRun::ls(Option_t* option) const
+{
+    TNamed::ls(option);
+    TROOT::IncreaseDirLevel();
+    if (parVersions) {
+        parVersions->ls();
+    }
+    TROOT::DecreaseDirLevel();
+}
diff --git a/fairroot/parbase/FairRtdbRun.h b/fairroot/parbase/FairRtdbRun.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2014-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -79,6 +79,8 @@ class FairRtdbRun : public TNamed
     void print();
     void write(std::fstream&);
 
+    void ls(Option_t* option = "") const override;
+
   private:
     FairRtdbRun& operator=(const FairRtdbRun&);
 
diff --git a/fairroot/parbase/FairRuntimeDb.cxx b/fairroot/parbase/FairRuntimeDb.cxx
diff --git a/fairroot/parbase/FairRuntimeDb.h b/fairroot/parbase/FairRuntimeDb.h

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`#include <TMath.h> // for Sqrt`
`19`	`19`	`#include <TObject.h> // for TObject`
`20`	`20`	`#include <TParticlePDG.h> // for TParticlePDG`
	`21`	`+#include <TROOT.h> //`
`21`	`22`	`#include <TRandom.h> // for TRandom, gRandom`
`22`	`23`	`#include <iostream> // for operator<<, basic_ostream, etc`
`23`	`24`
`@@ -63,6 +64,7 @@ FairPrimaryGenerator::FairPrimaryGenerator()`
`63`	`64`	`, fEventNr(0)`
`64`	`65`	`{`
`65`	`66`	`fTargetZ[0] = 0.;`
	`67`	`+ fGenList->SetName("fGenList");`
`66`	`68`	`}`
`67`	`69`
`68`	`70`	`FairPrimaryGenerator::FairPrimaryGenerator(const char name, const char title)`
`@@ -101,6 +103,7 @@ FairPrimaryGenerator::FairPrimaryGenerator(const char name, const char title)`
`101`	`103`	`, fEventNr(0)`
`102`	`104`	`{`
`103`	`105`	`fTargetZ[0] = 0.;`
	`106`	`+ fGenList->SetName("fGenList");`
`104`	`107`	`}`
`105`	`108`
`106`	`109`	`FairPrimaryGenerator::FairPrimaryGenerator(const FairPrimaryGenerator &rhs)`
`@@ -139,6 +142,7 @@ FairPrimaryGenerator::FairPrimaryGenerator(const FairPrimaryGenerator &rhs)`
`139`	`142`	`, fEventNr(rhs.fEventNr)`
`140`	`143`	`{`
`141`	`144`	`fTargetZ[0] = rhs.fTargetZ[0];`
	`145`	`+ fGenList->SetName("fGenList");`
`142`	`146`	`}`
`143`	`147`
`144`	`148`	`Bool_t FairPrimaryGenerator::Init()`
`@@ -549,3 +553,11 @@ void FairPrimaryGenerator::SmearGausVertexXY(Bool_t flag)`
`549`	`553`	`fSmearVertexXY = kFALSE;`
`550`	`554`	`}`
`551`	`555`	`}`
	`556`	`+`
	`557`	`+void FairPrimaryGenerator::ls(Option_t* option) const`
	`558`	`+{`
	`559`	`+ TNamed::ls(option);`
	`560`	`+ TROOT::IncreaseDirLevel();`
	`561`	`+ fGenList->ls();`
	`562`	`+ TROOT::DecreaseDirLevel();`
	`563`	`+}`