geant4/source/digits_hits/digits/include/G4TDigiCollection.hh

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// G4TDigiCollection & G4DigiCollection
//
// Class description:
//
// This is a template class of digi collection and parametrised by
// The concrete class of G4VDigi. This is a uniform collection for
// a particular concrete digi class objects.
// An intermediate layer class G4DigiCollection appeared in this
// header file is used just for G4Allocator, because G4Allocator
// cannot be instantiated with a template class. Thus G4DigiCollection
// class MUST NOT be directly used by the user.
//
// Author: Makoto Asai
// --------------------------------------------------------------------
#ifndef G4TDigiCollection_h
#define G4TDigiCollection_h 1

#include "G4Allocator.hh"
#include "G4VDigiCollection.hh"
#include "globals.hh"

#include <vector>

class G4DigiCollection : public G4VDigiCollection
{
  public:

    using G4VDigiCollection::G4VDigiCollection;
    ~G4DigiCollection() override = default;

    G4bool operator==(const G4DigiCollection& right) const { return (this == &right); }

  protected:

    void* theCollection = nullptr;
};

#if defined G4DIGI_ALLOC_EXPORT
extern G4DLLEXPORT G4Allocator<G4DigiCollection>*& aDCAllocator_G4MT_TLS_();
#else
extern G4DLLIMPORT G4Allocator<G4DigiCollection>*& aDCAllocator_G4MT_TLS_();
#endif

template <class T>
class G4TDigiCollection : public G4DigiCollection
{
  public:

    G4TDigiCollection();
    G4TDigiCollection(const G4String& detName, const G4String& colNam);
    ~G4TDigiCollection() override;

    G4bool operator==(const G4TDigiCollection& right) const;

    inline void* operator new(std::size_t);
    inline void operator delete(void* aDC);

    // Invoke Draw() method on all stored digit objects in collection
    void DrawAllDigi() override;

    // Invoke Print() method on all stored digit objects in collection
    void PrintAllDigi() override;

    // Returns pointer to the concrete digi object at index i
    // Not bounds checked
    inline T* operator[](std::size_t i) const { return (*((std::vector<T*>*)theCollection))[i]; }

    // Returns pointer to stored collection vector.
    inline std::vector<T*>* GetVector() const { return (std::vector<T*>*)theCollection; }

    // Insert a digit object in the collection, taking ownership
    // Returns the total number of digi objects stored after insertion
    inline std::size_t insert(T* aHit)
    {
      auto theDigiCollection = (std::vector<T*>*)theCollection;
      theDigiCollection->push_back(aHit);
      return theDigiCollection->size();
    }

    // Returns the number of digi objects stored in this collection.
    inline std::size_t entries() const
    {
      auto theDigiCollection = (std::vector<T*>*)theCollection;
      return theDigiCollection->size();
    }

    G4VDigi* GetDigi(std::size_t i) const override { return (*((std::vector<T*>*)theCollection))[i]; }

    std::size_t GetSize() const override { return ((std::vector<T*>*)theCollection)->size(); }
};

template <class T>
inline void* G4TDigiCollection<T>::operator new(std::size_t)
{
  if (aDCAllocator_G4MT_TLS_() == nullptr) {
    aDCAllocator_G4MT_TLS_() = new G4Allocator<G4DigiCollection>;
  }
  return (void*)aDCAllocator_G4MT_TLS_()->MallocSingle();
}

template <class T>
inline void G4TDigiCollection<T>::operator delete(void* aDC)
{
  aDCAllocator_G4MT_TLS_()->FreeSingle((G4DigiCollection*)aDC);
}

template <class T>
G4TDigiCollection<T>::G4TDigiCollection()
{
  auto theDigiCollection = new std::vector<T*>;
  theCollection = (void*)theDigiCollection;
}

template <class T>
G4TDigiCollection<T>::G4TDigiCollection(const G4String& detName, const G4String& colNam)
  : G4DigiCollection(detName, colNam)
{
  auto theDigiCollection = new std::vector<T*>;
  theCollection = (void*)theDigiCollection;
}

template <class T>
G4TDigiCollection<T>::~G4TDigiCollection()
{
  auto theDigiCollection = (std::vector<T*>*)theCollection;
  for (const auto* digi : *theDigiCollection) {
    delete digi;
  }
  theDigiCollection->clear();
  delete theDigiCollection;
}

template <class T>
G4bool G4TDigiCollection<T>::operator==(const G4TDigiCollection<T>& right) const
{
  return (collectionName == right.collectionName);
}

template <class T>
void G4TDigiCollection<T>::DrawAllDigi()
{
  auto theDigiCollection = (std::vector<T*>*)theCollection;
  for (auto* digi : *theDigiCollection) {
    digi->Draw();
  }
}

template <class T>
void G4TDigiCollection<T>::PrintAllDigi()
{
  auto theDigiCollection = (std::vector<T*>*)theCollection;
  for (auto* digi : *theDigiCollection) {
    digi->Print();
  }
}

#endif