1 // This file's extension implies that it's C, but it's really -*- C++ -*-.
4 Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
7 * @file AthContainers/tools/DVLDataBucket.icc
10 * @brief A @c DataBucket specialized for @c DataVector/@c DataList.
12 * Template and inline implementations.
16 #include "AthContainers/exceptions.h"
17 #include "AthenaKernel/IRegisterTransient.h"
18 #include "CxxUtils/AthUnlikelyMacros.h"
25 * @brief Is a @c DataVector we're trying to record actually a @c ViewVector?
26 * @param data Object being recorded.
27 * @param[out] clid If the object is a @c ViewVector, set to the CLID
28 * of that class. Otherwise unchanged.
29 * @returns The @c type_info for the object being recorded, either the
30 * @c DataVector or a @c ViewVector that derives from it.
33 const std::type_info* testViewVector (const DataVector<T>& data,
36 // If this is a view container, test for @c ViewVector.
37 if (data.ownPolicy() == SG::VIEW_ELEMENTS) {
38 // See if we actually have a @c ViewVector.
39 // FIXME: This doesn't work if @c ViewVector is templated on an intermediate
40 // class rather than @c DataVector directly.
41 if (dynamic_cast<const ViewVector<DataVector<T> >*> (&data)) {
42 const std::type_info& ti = typeid(ViewVector<DataVector<T> >);
43 const SG::BaseInfoBase* bib = SG::BaseInfoBase::find (ti);
46 if (clid == CLID_NULL)
47 SG::throwExcMissingViewVectorCLID (ti);
51 SG::throwExcMissingBaseInfo (ti);
55 return &typeid(DataVector<T>);
60 * @brief Is a @c DataVector we're trying to record actually a @c ViewVector?
62 * Handle the case where the object being recorded is not a @c DataVector.
65 const std::type_info* testViewVector (const T& ,
73 * @brief Constructor from a payload object.
74 * @param data Object to hold in the bucket.
77 DVLDataBucket<T>::DVLDataBucket (T* data)
78 : DataBucket<T> (data)
80 // cppcheck-suppress useInitializationList
81 m_clid = DataBucket<T>::classID();
82 m_ti = testViewVector (*this->ptr(), m_clid);
87 * @brief Constructor from a payload object.
88 * @param data Object to hold in the bucket.
92 DVLDataBucket<T>::DVLDataBucket (std::unique_ptr<U> data)
93 : DataBucket<T> (std::move (data))
95 // cppcheck-suppress useInitializationList
96 m_clid = DataBucket<T>::classID();
97 // cppcheck-suppress missingReturn; false positive
98 m_ti = testViewVector (*this->ptr(), m_clid);
103 * @brief Copy constructor.
104 * @param other Bucket to copy.
106 template <typename T>
107 DVLDataBucket<T>::DVLDataBucket (const DVLDataBucket& other)
108 : SG::DataBucket<T> (new T (*(T*)(other.cptr()))),
109 m_copies (other.m_copies),
111 m_clid (other.m_clid)
113 // Make a copy of each of the copies.
114 vec_t::iterator end = m_copies.end();
115 for (vec_t::iterator it = m_copies.begin(); it != end; ++it) {
116 it->second = it->first->clone (it->second);
124 template <typename T>
125 DVLDataBucket<T>::~DVLDataBucket()
127 // Delete any copies.
128 vec_t::iterator end = m_copies.end();
129 for (vec_t::iterator it = m_copies.begin(); it != end; ++it) {
130 it->first->del (it->second);
136 * @brief Return the contents of the @c DataBucket,
137 * converted to type given by @a clid. Note that only
138 * derived->base conversions are allowed here.
139 * @param clid The class ID to which to convert.
140 * @param irt To be called if we make a new instance.
141 * @param isConst True if the object being converted is regarded as const.
143 template <typename T>
145 DVLDataBucket<T>::cast (CLID clid, IRegisterTransient* irt /*= 0*/,
146 bool /*isConst = true*/)
148 // Test for trivial conversion.
149 // FIXME: Assumes we can reinterpret_cast between DV* and ViewVector<DV>*.
150 if (ATH_LIKELY (clid == m_clid) || clid == DataBucket<T>::classID())
153 // Try looking for a true base conversion,
154 // first using static SG_BASES information.
155 // This can all be unfolded at compile time, so is fast, but
156 // doesn't take into account SG_ADD_BASES.
157 void* ret = this->tryStaticConversion (clid);
162 T* ptr = this->ptr();
164 // Then try using BaseInfo, in case of SG_ADD_BASES.
165 ret = SG::BaseInfo<T>::cast (ptr, clid);
170 // See if we've already made an instance for this type.
171 // We don't expect to have more than a few, so no point in doing
172 // anything more complicated than a linear search.
173 vec_t::iterator end = m_copies.end();
174 for (vec_t::iterator it = m_copies.begin(); it != end; ++it) {
175 if (clid == it->first->clid()) {
176 // Recopy the elements if the container size has changed.
177 if (it->first->size (it->second) != ptr->size()) {
178 dvl_update (*ptr, it->second, it->first);
184 // Try to do a copying conversion.
185 DataModel_detail::DVLInfoBase* info;
186 void* newcont = dvl_convert (*ptr, clid, info);
188 m_copies.push_back (std::make_pair (info, newcont));
189 irt->registerTransient (newcont);
197 * @brief Return the contents of the @c DataBucket,
198 * converted to type given by @a std::type_info. Note that only
199 * derived->base conversions are allowed here.
200 * @param clid The @a std::type_info of the type to which to convert.
201 * @param irt To be called if we make a new instance.
202 * @param isConst True if the object being converted is regarded as const.
204 template <typename T>
206 DVLDataBucket<T>::cast (const std::type_info& tinfo,
207 IRegisterTransient* irt /*= 0*/,
208 bool /*isConst = true*/)
210 // Test for trivial conversion.
211 // FIXME: Assumes we can reinterpret_cast between DV* and ViewVector<DV>*.
212 if (ATH_LIKELY (&tinfo == m_ti) || tinfo == DataBucket<T>::tinfo())
215 // Try looking for a true base conversion,
216 // first using static SG_BASES information.
217 // This can all be unfolded at compile time, so is fast, but
218 // doesn't take into account SG_ADD_BASES.
219 void* ret = this->tryStaticConversion (tinfo);
224 T* ptr = this->ptr();
226 // Try looking for a true base conversion.
227 ret = SG::BaseInfo<T>::cast (ptr, tinfo);
232 // See if we've already made an instance for this type.
233 // We don't expect to have more than a few, so no point in doing
234 // anything more complicated than a linear search.
235 vec_t::iterator end = m_copies.end();
236 for (vec_t::iterator it = m_copies.begin(); it != end; ++it) {
237 if (tinfo == it->first->tinfo()) {
238 // Recopy the elements if the container size has changed.
239 if (it->first->size (it->second) != ptr->size()) {
240 dvl_update (*ptr, it->second, it->first);
246 // Try to do a copying conversion.
247 DataModel_detail::DVLInfoBase* info;
248 void* newcont = dvl_convert (*ptr, tinfo, info);
250 m_copies.push_back (std::make_pair (info, newcont));
251 irt->registerTransient (newcont);
259 * @brief Return the contents of the @c DataBucket,
260 * converted to type given by @a clid. Note that only
261 * derived->base conversions are allowed here.
262 * @param clid The class ID to which to convert.
263 * @param tinfo The @a std::type_info of the type to which to convert.
264 * @param irt To be called if we make a new instance.
265 * @param isConst True if the object being converted is regarded as const.
267 * This allows the callee to choose whether to use clid or tinfo.
270 template <typename T>
272 void* DVLDataBucket<T>::cast (CLID clid,
273 const std::type_info& /*tinfo*/,
274 SG::IRegisterTransient* irt /*= 0*/,
275 bool isConst /*= true*/)
277 return DVLDataBucket::cast (clid, irt, isConst);
282 * @brief The CLID for the class of object we're holding.
284 * May be different from that of the base @c DataVector in the case
285 * of a @c ViewVector.
287 template <typename T>
288 const CLID& DVLDataBucket<T>::clID() const
295 * @brief The std::type_info for the class of object we're holding.
297 * May be different from that of the base @c DataVector in the case
298 * of a @c ViewVector.
300 template <typename T>
301 const std::type_info& DVLDataBucket<T>::tinfo() const