/** CbmLitEnvironment.h
 *@author A.Lebedev <alebedev@jinr.ru>
 *@since 2007
 **
 ** Class is an interface to the CBM detector classes and field.
 ** The detector geometry which is represented in the form of
 ** CbmLitDetectorLayout class constructed in this class.
 ** This class implements singleton pattern.
 **/

#ifndef CBMLITENVIRONMENT_H_
#define CBMLITENVIRONMENT_H_

#include "base/CbmLitDetectorLayout.h"
#include "parallel/muon/LitDetectorGeometryMuon.h"
#include "parallel/electron/LitDetectorGeometryElectron.h"

#include <vector>
#include <string>

class FairField;
class TGeoNode;
class TGeoMaterial;

class CbmLitEnvironment
{
public:
   /* Returns pointer to the singleton object instance. */
   static CbmLitEnvironment* Instance();

   /* Returns pointer to the magnetic field map. */
   FairField* GetField();

   /* Returns reference to the detector layout. */
   const CbmLitDetectorLayout& GetLayout();

   /* Returns reference to the MUCH detector layout. */
   const CbmLitDetectorLayout& GetMuchLayout() {return fMuchLayout;}

   /* Returns reference to the TRD detector layout. */
   const CbmLitDetectorLayout& GetTrdLayout() {return fTrdLayout;}

   /* Returns reference to the MUCH detector layout in SIMD format. */
   void GetMuchLayoutVec(lit::parallel::LitDetectorLayoutMuonVec& layout);

   /* Returns reference to the MUCH detector layout in scalar format. */
   void GetMuchLayoutScal(lit::parallel::LitDetectorLayoutMuonScal& layout);

   /* Template function that returns reference to the MUCH detector layout. */
   template<class T> void GetMuchLayout(lit::parallel::LitDetectorLayoutMuon<T>& layout);

   /* Returns reference to the TRD detector layout in SIMD format. */
   void GetTrdLayoutVec(lit::parallel::LitDetectorLayoutElectronVec& layout);

   /* Returns reference to the TRD detector layout in scalar format. */
   void GetTrdLayoutScal(lit::parallel::LitDetectorLayoutElectronScal& layout);

   /* Template function that returns reference to the TRD detector layout. */
   template<class T> void GetTrdLayout(lit::parallel::LitDetectorLayoutElectron<T>& layout);

   /* Returns reference to the MVD detector layout. */
   const CbmLitDetectorLayout& GetMvdLayout();

   /* Returns index of the material needed for the construction of the
    * simplified layout for the parallel tracking. */
   int MaterialId(
      int stationGroup,
      int station,
      int substation,
      const CbmLitDetectorLayout& layout) const;

   /* Returns index of the TRD material needed for the construction of the
    * simplified layout for the parallel tracking. */
   int TrdMaterialId(
      int stationGroup,
      int station,
      const CbmLitDetectorLayout& layout) const;

   /* Returns reference to the TOF detector layout. */
   const CbmLitDetectorLayout& GetTofLayout();

   /* Returns reference to the TOF detector layout. */
   const CbmLitStation& GetTofStation();

   /* Returns true if electron setup is used. */
   bool IsElectronSetup() const;

   /* Returns true if MVD detector exists in TGeo. */
   bool IsMvd() const;

   /* Returns true if STS detector exists in TGeo. */
   bool IsSts() const;

   /* Returns true if RICH detector exists in TGeo. */
   bool IsRich() const;

   /* Returns true if TRD detector exists in TGeo. */
   bool IsTrd() const;

   /* Returns true if MUCH detector exists in TGeo. */
   bool IsMuch() const;

   /* Returns true if TOF detector exists in TGeo. */
   bool IsTof() const;

   /* Returns true if simple TRD is simulated. */
   bool IsTrdSimple() const;

private:
   /* Constructor is protected since singleton pattern is used.
    * Pointer to the object is returned by static Instance() method. */
   CbmLitEnvironment();

   /* Destructor */
   virtual ~CbmLitEnvironment();

   /* Copy constructor */
   CbmLitEnvironment(const CbmLitEnvironment&);

   /* Assignment operator */
   const CbmLitEnvironment& operator=(const CbmLitEnvironment&);

   /* Combines MUCH and TRD layout. */
   void CombineMuchAndTrd();

   /* Constructs MUCH layout. */
   void MuchLayout();

   /* Constructs TRD layout. */
   void TrdLayout();

   /* Constructs simple TRD layout. */
   void TrdLayoutSimple();

   /* Constructs MVD layout */
   void MvdLayout();

   /* Creates detector layout out of an array stations. */
   void DetermineLayout(
      const std::vector<CbmLitStation>& stations,
      CbmLitDetectorLayout& layout);

   /* */
   std::vector<CbmLitStation> DivideToSubstations(
      const std::vector<CbmLitStation>& stations);

   /* Returns true if straw tube detector is simulated. */
   bool IsStraw() const;

   /* Returns true if segmented TRD is simulated. */
   bool IsTrdSegmented() const;

   /* Returns true if detector exists in TGeo. */
   bool CheckDetectorPresence(
      const std::string& name) const;

   CbmLitDetectorLayout fLayout; // current detector layout
   CbmLitDetectorLayout fMuchTrdLayout; // MUCH+TRD detector layout
   CbmLitDetectorLayout fMuchLayout; // MUCH detector layout
   CbmLitDetectorLayout fTrdLayout; // TRD detector layout
   CbmLitDetectorLayout fTofLayout; // TOF detector layout
   CbmLitStation fTofStation; // TOF station
   CbmLitDetectorLayout fMvdLayout; // MVD detector layout

   FairField* fField; // pointer to the magnetic field
};

#endif // CBMLITENVIRONMENT_H_