include/ActsPodioEdm/MutableJacobian.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef ACTSPODIOEDM_MutableJacobian_H
0004 #define ACTSPODIOEDM_MutableJacobian_H
0005
0006 #include "ActsPodioEdm/JacobianObj.h"
0007 // Make the immutable class available from its mutable version but not vice
0008 // versa
0009 #include "ActsPodioEdm/Jacobian.h"
0010 #include "ActsPodioEdm/JacobianInfo.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 JacobianCollection;
0023 }
0024
0025 namespace ActsPodioEdm {
0026
0027 /** @class MutableJacobian
0028  *  Jacobian matrix from the previous track state to the current one
0029  *  @author: Paul Gessinger, CERN
0030  */
0031 class MutableJacobian {
0032   friend class JacobianCollection;
0033   friend class JacobianMutableCollectionIterator;
0034   friend class Jacobian;
0035
0036  public:
0037   using object_type = Jacobian;
0038   using collection_type = JacobianCollection;
0039
0040   /// default constructor
0041   MutableJacobian();
0042
0043   /// Constructor initializing all members
0044   MutableJacobian(ActsPodioEdm::JacobianInfo data);
0045
0046   /// copy constructor
0047   MutableJacobian(const MutableJacobian& other) = default;
0048
0049   /// copy-assignment operator
0050   MutableJacobian& operator=(MutableJacobian 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   MutableJacobian clone(bool cloneRelations = true) const;
0055
0056   /// destructor
0057   ~MutableJacobian() = default;
0058
0059  public:
0060   /// Access the the jacobian data
0061   const ActsPodioEdm::JacobianInfo& getData() const;
0062
0063   /// Set the the jacobian data
0064   void setData(ActsPodioEdm::JacobianInfo value);
0065   /// Get mutable reference to the jacobian data
0066   ActsPodioEdm::JacobianInfo& getData();
0067   /// Get reference to the jacobian data
0068   [[deprecated("use getData instead")]]
0069   ActsPodioEdm::JacobianInfo& data();
0070
0071   /// check whether the object is actually available
0072   bool isAvailable() const;
0073   /// disconnect from JacobianObj instance
0074   void unlink() { m_obj = podio::utils::MaybeSharedPtr<JacobianObj>{nullptr}; }
0075
0076   bool operator==(const MutableJacobian& other) const {
0077     return m_obj == other.m_obj;
0078   }
0079   bool operator==(const Jacobian& other) const;
0080
0081   bool operator!=(const MutableJacobian& other) const {
0082     return !(*this == other);
0083   }
0084   bool operator!=(const Jacobian& other) const { return !(*this == other); }
0085
0086   // less comparison operator, so that objects can be e.g. stored in sets.
0087   bool operator<(const MutableJacobian& other) const {
0088     return podio::detail::getOrderKey(*this) <
0089            podio::detail::getOrderKey(other);
0090   }
0091
0092   podio::ObjectID id() const { return getObjectID(); }
0093
0094   const podio::ObjectID getObjectID() const;
0095
0096   friend void swap(MutableJacobian& a, MutableJacobian& b) {
0097     using std::swap;
0098     swap(a.m_obj, b.m_obj);  // swap out the internal pointers
0099   }
0100
0101  private:
0102   /// constructor from existing JacobianObj
0103   explicit MutableJacobian(podio::utils::MaybeSharedPtr<JacobianObj> obj);
0104
0105   podio::utils::MaybeSharedPtr<JacobianObj> m_obj{nullptr};
0106 };
0107
0108 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0109 void to_json(nlohmann::json& j, const MutableJacobian& value);
0110 #endif
0111
0112 }  // namespace ActsPodioEdm
0113
0114 #endif