include/ActsPodioEdm/MutableBoundParameters.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef ACTSPODIOEDM_MutableBoundParameters_H
0004 #define ACTSPODIOEDM_MutableBoundParameters_H
0005
0006 #include "ActsPodioEdm/BoundParametersObj.h"
0007 // Make the immutable class available from its mutable version but not vice
0008 // versa
0009 #include "ActsPodioEdm/BoundParameters.h"
0010 #include "ActsPodioEdm/BoundParametersInfo.h"
0011
0012 #include <cstdint>
0013
0014 #include "podio/utilities/MaybeSharedPtr.h"
0015
0016 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0017 #include "nlohmann/json_fwd.hpp"
0018 #endif
0019
0020 // forward declarations
0021 namespace ActsPodioEdm {
0022 class BoundParametersCollection;
0023 }
0024
0025 namespace ActsPodioEdm {
0026
0027 /** @class MutableBoundParameters
0028  *  Local track parameters
0029  *  @author: Paul Gessinger, CERN
0030  */
0031 class MutableBoundParameters {
0032   friend class BoundParametersCollection;
0033   friend class BoundParametersMutableCollectionIterator;
0034   friend class BoundParameters;
0035
0036  public:
0037   using object_type = BoundParameters;
0038   using collection_type = BoundParametersCollection;
0039
0040   /// default constructor
0041   MutableBoundParameters();
0042
0043   /// Constructor initializing all members
0044   MutableBoundParameters(ActsPodioEdm::BoundParametersInfo data);
0045
0046   /// copy constructor
0047   MutableBoundParameters(const MutableBoundParameters& other) = default;
0048
0049   /// copy-assignment operator
0050   MutableBoundParameters& operator=(MutableBoundParameters other);
0051
0052   /// create a mutable deep-copy of the object with identical relations
0053   /// if cloneRelations=false, the relations are not cloned and will be empty
0054   MutableBoundParameters clone(bool cloneRelations = true) const;
0055
0056   /// destructor
0057   ~MutableBoundParameters() = default;
0058
0059  public:
0060   /// Access the parameter information
0061   const ActsPodioEdm::BoundParametersInfo& getData() const;
0062
0063   /// Set the parameter information
0064   void setData(ActsPodioEdm::BoundParametersInfo value);
0065   /// Get mutable reference to parameter information
0066   ActsPodioEdm::BoundParametersInfo& getData();
0067   /// Get reference to parameter information
0068   [[deprecated("use getData instead")]]
0069   ActsPodioEdm::BoundParametersInfo& data();
0070
0071   /// check whether the object is actually available
0072   bool isAvailable() const;
0073   /// disconnect from BoundParametersObj instance
0074   void unlink() {
0075     m_obj = podio::utils::MaybeSharedPtr<BoundParametersObj>{nullptr};
0076   }
0077
0078   bool operator==(const MutableBoundParameters& other) const {
0079     return m_obj == other.m_obj;
0080   }
0081   bool operator==(const BoundParameters& other) const;
0082
0083   bool operator!=(const MutableBoundParameters& other) const {
0084     return !(*this == other);
0085   }
0086   bool operator!=(const BoundParameters& other) const {
0087     return !(*this == other);
0088   }
0089
0090   // less comparison operator, so that objects can be e.g. stored in sets.
0091   bool operator<(const MutableBoundParameters& other) const {
0092     return podio::detail::getOrderKey(*this) <
0093            podio::detail::getOrderKey(other);
0094   }
0095
0096   podio::ObjectID id() const { return getObjectID(); }
0097
0098   const podio::ObjectID getObjectID() const;
0099
0100   friend void swap(MutableBoundParameters& a, MutableBoundParameters& b) {
0101     using std::swap;
0102     swap(a.m_obj, b.m_obj);  // swap out the internal pointers
0103   }
0104
0105  private:
0106   /// constructor from existing BoundParametersObj
0107   explicit MutableBoundParameters(
0108       podio::utils::MaybeSharedPtr<BoundParametersObj> obj);
0109
0110   podio::utils::MaybeSharedPtr<BoundParametersObj> m_obj{nullptr};
0111 };
0112
0113 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0114 void to_json(nlohmann::json& j, const MutableBoundParameters& value);
0115 #endif
0116
0117 }  // namespace ActsPodioEdm
0118
0119 #endif