ChargedSpacePointCreator.h

Go to the documentation of this file.

#ifndef LARDATA_ARTDATAHELPER_CHARGEDSPACEPOINTCREATOR_H
#define LARDATA_ARTDATAHELPER_CHARGEDSPACEPOINTCREATOR_H

// LArSoft libraries
#include "lardataobj/RecoBase/PointCharge.h"
#include "lardataobj/RecoBase/SpacePoint.h"

// framework libraries
#include "art/Persistency/Common/PtrMaker.h"
#include "canvas/Persistency/Common/Ptr.h"

// C/C++ standard libraries
#include <cstdlib>     // std::size_t
#include <memory>      // std::unique_ptr<>
#include <type_traits> // std::enable_if_t, ...
#include <vector>

namespace art {
  class Event;
  class ProducesCollector;
}

namespace recob {

  class ChargedSpacePointCollectionCreator {

  public:
    //--- BEGIN Constructors ---------------------------------------------------

    ChargedSpacePointCollectionCreator(art::Event& event, std::string const& instanceName = {});

    static ChargedSpacePointCollectionCreator forPtrs(art::Event& event,
                                                      std::string const& instanceName = {});

    //--- END Constructors ---------------------------------------------------

    //--- BEGIN Insertion and finish operations --------------------------------


    void add(recob::SpacePoint const& spacePoint, recob::PointCharge const& charge);
    void add(recob::SpacePoint&& spacePoint, recob::PointCharge&& charge);


    void addAll(std::vector<recob::SpacePoint>&& spacePoints,
                std::vector<recob::PointCharge>&& charges);
    void addAll(std::vector<recob::SpacePoint> const& spacePoints,
                std::vector<recob::PointCharge> const& charges);

    void put();

    //--- END Insertion and finish operations --------------------------------

    //--- BEGIN Queries and operations -----------------------------------------

    bool empty() const { return spent() || fSpacePoints->empty(); }

    std::size_t size() const { return spent() ? 0U : fSpacePoints->size(); }

    void clear();

    bool spent() const { return !fSpacePoints; }

    bool canMakePointers() const { return bool(fSpacePointPtrMaker); }

    //--- END Queries and operations -------------------------------------------

    //--- BEGIN Complimentary unchecked element access -------------------------

    recob::SpacePoint const& spacePoint(std::size_t i) const { return fSpacePoints->operator[](i); }

    recob::SpacePoint const& lastSpacePoint() const { return spacePoint(lastIndex()); }

    art::Ptr<recob::SpacePoint> spacePointPtr(std::size_t i) const;

    art::Ptr<recob::SpacePoint> lastSpacePointPtr() const { return spacePointPtr(lastIndex()); }

    recob::PointCharge const& charge(std::size_t i) const { return fCharges->operator[](i); }

    recob::PointCharge const& lastCharge() const { return charge(lastIndex()); }

    art::Ptr<recob::PointCharge> chargePtr(std::size_t i) const;

    art::Ptr<recob::PointCharge> lastChargePtr() const { return chargePtr(lastIndex()); }

    //--- END Complimentary unchecked element access ---------------------------

    //--- BEGIN Static constructor interface -----------------------------------

    static void produces(art::ProducesCollector& producesCollector,
                         std::string const& instanceName = {});

    //--- END Static constructor interface -------------------------------------

  private:
    art::Event& fEvent; 

    std::string fInstanceName; 

    std::unique_ptr<std::vector<recob::SpacePoint>> fSpacePoints;
    std::unique_ptr<art::PtrMaker<recob::SpacePoint>> fSpacePointPtrMaker;
    std::unique_ptr<std::vector<recob::PointCharge>> fCharges;
    std::unique_ptr<art::PtrMaker<recob::PointCharge>> fChargePtrMaker;

    std::size_t lastIndex() const { return size() - 1U; }

  }; // class ChargedSpacePointCollectionCreator

} // namespace recob

//------------------------------------------------------------------------------

#endif // LARDATA_ARTDATAHELPER_CHARGEDSPACEPOINTCREATOR_H