gtouchable.h

Go to the documentation of this file.

#pragma once
 
// gemc
#include "gbase.h"
 
// c++
#include <vector>
#include <string>
#include <memory>
 
// gtouchable
#include <CLHEP/Units/SystemOfUnits.h>
 
#include "gtouchable_options.h"
#include "gtouchableConventions.h"
 
// - readout: electronic Time Window is the discriminating factor.
//   parameters and hitBitSet determined by defineReadoutSpecs in the plugin
// - flux: track id is the discriminating factor, standard true infos variable
// - particleCounter: no other discriminating factors, standard true infos variable
// - dosimeter: track id is the discriminating factor, radiation digitization
 
 
enum GTouchableType
{
    readout,         
    flux,            
    particleCounter, 
    dosimeter        
};
 
// ------------------------------------------------------------------------
// Convert enum to string for logging / debugging.
// ------------------------------------------------------------------------
namespace gtouchable {
    inline const char* to_string(GTouchableType t) {
        switch (t) {
            case GTouchableType::readout: return "readout";
            case GTouchableType::flux: return FLUXNAME;
            case GTouchableType::particleCounter: return COUNTERNAME;
            case GTouchableType::dosimeter: return DOSIMETERNAME;
            default: return "unknown-gtouchable";
        }
    }
}
 
struct GIdentifier
{
public:
    GIdentifier(const std::string& n, int v) : idName{n}, idValue{v} {
    }
 
    bool operator==(const GIdentifier& gid) const { return this->idValue == gid.idValue; }
 
    [[nodiscard]] inline std::string getName() const { return idName; }
 
    [[nodiscard]] inline int getValue() const { return idValue; }
 
private:
    std::string idName;  
    int         idValue; 
 
    friend std::ostream& operator<<(std::ostream& stream, const GIdentifier& gidentifier);
};
 
 
class GTouchable : public GBase<GTouchable>
{
public:
    GTouchable(const GTouchable&)            = default;
    GTouchable& operator=(const GTouchable&) = default;
 
    GTouchable(const std::shared_ptr<GOptions>& gopt,
               const std::string&               digitization,
               const std::string&               gidentityString,
               const std::vector<double>&       dimensions,
               const double&                    mass);
 
    GTouchable(const std::shared_ptr<GLogger>& logger,
               const std::string&              digitization,
               const std::string&              gidentityString,
               const std::vector<double>&      dimensions,
               const double&                   mass);
 
    GTouchable(const std::shared_ptr<GTouchable>& base, int newTimeIndex)
        : GBase<GTouchable>(*base),
          gType(base->gType),
          gidentity(base->gidentity),
          trackId(base->trackId),
          eMultiplier(base->eMultiplier),
          stepTimeAtElectronicsIndex(newTimeIndex) {
        log->debug(CONSTRUCTOR, "Copy-with-time-index", gtouchable::to_string(gType), " ", getIdentityString());
    }
 
    ~GTouchable() { log->debug(DESTRUCTOR, gtouchable::to_string(gType), " ", getIdentityString()); }
 
    bool operator==(const GTouchable& gtouchable) const;
 
    inline void assignTrackId(int tid) { trackId = tid; }
 
    [[nodiscard]] inline double getEnergyMultiplier() const { return eMultiplier; }
 
    inline void assignStepTimeAtElectronicsIndex(int timeIndex) { stepTimeAtElectronicsIndex = timeIndex; }
 
    [[nodiscard]] inline int getStepTimeAtElectronicsIndex() const { return stepTimeAtElectronicsIndex; }
 
    [[nodiscard]] inline std::vector<GIdentifier> getIdentity() const { return gidentity; }
 
    [[nodiscard]] inline std::string getIdentityString() const {
        std::string idString;
        for (const auto& id : gidentity) { idString += id.getName() + ": " + std::to_string(id.getValue()) + " "; }
        return idString;
    }
 
    [[nodiscard]] inline std::vector<double> getDetectorDimensions() const { return detectorDimensions; }
 
    [[nodiscard]] inline double getMass() const { return mass; }
 
    [[nodiscard]] bool exists_in_vector(const std::vector<GTouchable>& v) const {
        for (const auto& gt : v) {
            if (*this == gt) {
                log->info(2, "GTouchable", this, " exists in vector.");
                return true;
            }
        }
        log->info(2, "GTouchable", this, " does not exist in vector.");
 
        return false;
    }
 
    static std::shared_ptr<GTouchable> create(const std::shared_ptr<GOptions>& gopt) {
        int           touchableNumber = globalGTouchableCounter.fetch_add(1, std::memory_order_relaxed);
        int           sector          = ( touchableNumber % 6 ) + 1;
        int           paddle          = ( touchableNumber % 20 ) + 1;
        std::string   identity        = "sector: " + std::to_string(sector) + ", paddle: " + std::to_string(paddle);
        const auto&   dimensions      = {10.0, 20.0, 30.0};
        const double& mass            = 100 * CLHEP::g;
 
        return std::make_shared<GTouchable>(gopt, "readout", identity, dimensions, mass);
    }
 
    static std::shared_ptr<GTouchable> create(const std::shared_ptr<GLogger>& logger) {
        int           touchableNumber = globalGTouchableCounter.fetch_add(1, std::memory_order_relaxed);
        int           sector          = ( touchableNumber % 6 ) + 1;
        int           paddle          = ( touchableNumber % 20 ) + 1;
        std::string   identity        = "sector: " + std::to_string(sector) + ", paddle: " + std::to_string(paddle);
        const auto&   dimensions      = {10.0, 20.0, 30.0};
        const double& mass            = 100 * CLHEP::g;
 
        return std::make_shared<GTouchable>(logger, "readout", identity, dimensions, mass);
    }
 
private:
    GTouchableType gType; 
    std::vector<GIdentifier> gidentity; 
    int trackId; 
    double eMultiplier; 
    int stepTimeAtElectronicsIndex; 
    std::vector<double> detectorDimensions; 
    double mass;
 
    friend std::ostream& operator<<(std::ostream& stream, const GTouchable& gtouchable);
 
    static std::atomic<int> globalGTouchableCounter;
};