MutableSimPulse.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableSimPulse_H
#define EDM4EIC_MutableSimPulse_H
 
#include "edm4eic/SimPulseObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/SimPulse.h"
 
#include "edm4hep/MCParticle.h"
#include "edm4hep/SimCalorimeterHit.h"
#include "edm4hep/SimTrackerHit.h"
#include "edm4hep/Vector3f.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class SimPulseCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableSimPulse
 *  Simulated pulse prior to digitization.
 *  @author: D. Anderson, S. Gardner, S. Joosten., D. Kalinkin
 */
class MutableSimPulse {
 
  friend class SimPulseCollection;
  friend class SimPulseMutableCollectionIterator;
  friend class SimPulse;
 
public:
  using object_type = SimPulse;
  using collection_type = SimPulseCollection;
 
  /// default constructor
  MutableSimPulse();
 
  /// Constructor initializing all members
  MutableSimPulse(std::uint64_t cellID, float integral, edm4hep::Vector3f position, float time, float interval);
 
  /// copy constructor
  MutableSimPulse(const MutableSimPulse& other) = default;
 
  /// copy-assignment operator
  MutableSimPulse& operator=(MutableSimPulse other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableSimPulse clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableSimPulse() = default;
 
 
public:
 
  /// Access the ID of the readout cell for this pulse.
  std::uint64_t getCellID() const;
 
  /// Access the Total pulse integral in relevant units.
  float getIntegral() const;
 
  /// Access the Position the pulse is evaluated in world coordinates [mm].
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the Start time for the pulse in [ns].
  float getTime() const;
 
  /// Access the Time interval between amplitude values [ns].
  float getInterval() const;
 
 
 
  /// Set the ID of the readout cell for this pulse.
  void setCellID(std::uint64_t value);
  /// Get mutable reference to ID of the readout cell for this pulse.
  std::uint64_t& getCellID();
  /// Get reference to ID of the readout cell for this pulse.
  [[deprecated("use getCellID instead")]]
  std::uint64_t& cellID();
 
  /// Set the Total pulse integral in relevant units.
  void setIntegral(float value);
  /// Get mutable reference to Total pulse integral in relevant units.
  float& getIntegral();
  /// Get reference to Total pulse integral in relevant units.
  [[deprecated("use getIntegral instead")]]
  float& integral();
 
  /// Set the Position the pulse is evaluated in world coordinates [mm].
  void setPosition(edm4hep::Vector3f value);
  /// Get mutable reference to Position the pulse is evaluated in world coordinates [mm].
  edm4hep::Vector3f& getPosition();
  /// Get reference to Position the pulse is evaluated in world coordinates [mm].
  [[deprecated("use getPosition instead")]]
  edm4hep::Vector3f& position();
 
  /// Set the Start time for the pulse in [ns].
  void setTime(float value);
  /// Get mutable reference to Start time for the pulse in [ns].
  float& getTime();
  /// Get reference to Start time for the pulse in [ns].
  [[deprecated("use getTime instead")]]
  float& time();
 
  /// Set the Time interval between amplitude values [ns].
  void setInterval(float value);
  /// Get mutable reference to Time interval between amplitude values [ns].
  float& getInterval();
  /// Get reference to Time interval between amplitude values [ns].
  [[deprecated("use getInterval instead")]]
  float& interval();
 
 
 
  void addToCalorimeterHits(const edm4hep::SimCalorimeterHit&);
  std::size_t calorimeterHits_size() const;
  edm4hep::SimCalorimeterHit getCalorimeterHits(std::size_t) const;
  std::vector<edm4hep::SimCalorimeterHit>::const_iterator calorimeterHits_begin() const;
  std::vector<edm4hep::SimCalorimeterHit>::const_iterator calorimeterHits_end() const;
  podio::RelationRange<edm4hep::SimCalorimeterHit> getCalorimeterHits() const;
  void addToTrackerHits(const edm4hep::SimTrackerHit&);
  std::size_t trackerHits_size() const;
  edm4hep::SimTrackerHit getTrackerHits(std::size_t) const;
  std::vector<edm4hep::SimTrackerHit>::const_iterator trackerHits_begin() const;
  std::vector<edm4hep::SimTrackerHit>::const_iterator trackerHits_end() const;
  podio::RelationRange<edm4hep::SimTrackerHit> getTrackerHits() const;
  void addToPulses(const edm4eic::SimPulse&);
  std::size_t pulses_size() const;
  edm4eic::SimPulse getPulses(std::size_t) const;
  std::vector<edm4eic::SimPulse>::const_iterator pulses_begin() const;
  std::vector<edm4eic::SimPulse>::const_iterator pulses_end() const;
  podio::RelationRange<edm4eic::SimPulse> getPulses() const;
  void addToParticles(const edm4hep::MCParticle&);
  std::size_t particles_size() const;
  edm4hep::MCParticle getParticles(std::size_t) const;
  std::vector<edm4hep::MCParticle>::const_iterator particles_begin() const;
  std::vector<edm4hep::MCParticle>::const_iterator particles_end() const;
  podio::RelationRange<edm4hep::MCParticle> getParticles() const;
  void addToAmplitude(const float&);
  std::size_t amplitude_size() const;
  float getAmplitude(std::size_t) const;
  std::vector<float>::const_iterator amplitude_begin() const;
  std::vector<float>::const_iterator amplitude_end() const;
  podio::RelationRange<float> getAmplitude() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from SimPulseObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<SimPulseObj>{nullptr}; }
 
  bool operator==(const MutableSimPulse& other) const { return m_obj == other.m_obj; }
  bool operator==(const SimPulse& other) const;
 
  bool operator!=(const MutableSimPulse& other) const { return !(*this == other); }
  bool operator!=(const SimPulse& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableSimPulse& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableSimPulse& a, MutableSimPulse& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing SimPulseObj
  explicit MutableSimPulse(podio::utils::MaybeSharedPtr<SimPulseObj> obj);
 
  podio::utils::MaybeSharedPtr<SimPulseObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableSimPulse& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif