Skip to content

Commit 656e740

Browse files
franzpoeschelfranzpoeschel
committed
Add and use Attribute::getOptional<T>()
Useful for backends that might not report back the right numerical type
1 parent c49d092 commit 656e740

File tree

9 files changed

+184
-47
lines changed

9 files changed

+184
-47
lines changed

‎include/openPMD/backend/Attribute.hpp‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
#include <complex>
3030
#include <cstdint>
3131
#include <iterator>
32+
#include <optional>
3233
#include <stdexcept>
3334
#include <string>
3435
#include <type_traits>
@@ -117,6 +118,9 @@ class Attribute
117118
*/
118119
template <typename U>
119120
U get() const;
121+
122+
template <typename U>
123+
std::optional<U> getOptional() const;
120124
};
121125

122126
template <typename T, typename U>
@@ -226,6 +230,110 @@ auto doConvert(T *pv) -> U
226230
}
227231
#endif
228232

233+
template <typename T, typename U>
234+
auto doConvertOptional(T *pv) -> std::optional<U>
235+
{
236+
(void)pv;
237+
if constexpr (std::is_convertible_v<T, U>)
238+
{
239+
return static_cast<U>(*pv);
240+
}
241+
else if constexpr (auxiliary::IsVector_v<T> && auxiliary::IsVector_v<U>)
242+
{
243+
if constexpr (std::is_convertible_v<
244+
typename T::value_type,
245+
typename U::value_type>)
246+
{
247+
U res{};
248+
res.reserve(pv->size());
249+
std::copy(pv->begin(), pv->end(), std::back_inserter(res));
250+
return res;
251+
}
252+
else
253+
{
254+
return {};
255+
}
256+
}
257+
// conversion cast: array to vector
258+
// if a backend reports a std::array<> for something where
259+
// the frontend expects a vector
260+
else if constexpr (auxiliary::IsArray_v<T> && auxiliary::IsVector_v<U>)
261+
{
262+
if constexpr (std::is_convertible_v<
263+
typename T::value_type,
264+
typename U::value_type>)
265+
{
266+
U res{};
267+
res.reserve(pv->size());
268+
std::copy(pv->begin(), pv->end(), std::back_inserter(res));
269+
return res;
270+
}
271+
else
272+
{
273+
return {};
274+
}
275+
}
276+
// conversion cast: vector to array
277+
// if a backend reports a std::vector<> for something where
278+
// the frontend expects an array
279+
else if constexpr (auxiliary::IsVector_v<T> && auxiliary::IsArray_v<U>)
280+
{
281+
if constexpr (std::is_convertible_v<
282+
typename T::value_type,
283+
typename U::value_type>)
284+
{
285+
U res{};
286+
if (res.size() != pv->size())
287+
{
288+
throw std::runtime_error(
289+
"getCast: no vector to array conversion possible (wrong "
290+
"requested array size).");
291+
}
292+
for (size_t i = 0; i < res.size(); ++i)
293+
{
294+
res[i] = static_cast<typename U::value_type>((*pv)[i]);
295+
}
296+
return res;
297+
}
298+
else
299+
{
300+
return {};
301+
}
302+
}
303+
// conversion cast: turn a single value into a 1-element vector
304+
else if constexpr (auxiliary::IsVector_v<U>)
305+
{
306+
if constexpr (std::is_convertible_v<T, typename U::value_type>)
307+
{
308+
U res{};
309+
res.reserve(1);
310+
res.push_back(static_cast<typename U::value_type>(*pv));
311+
return res;
312+
}
313+
else
314+
{
315+
return {};
316+
}
317+
}
318+
else
319+
{
320+
return {};
321+
}
322+
#if defined(__INTEL_COMPILER)
323+
/*
324+
* ICPC has trouble with if constexpr, thinking that return statements are
325+
* missing afterwards. Deactivate the warning.
326+
* Note that putting a statement here will not help to fix this since it will
327+
* then complain about unreachable code.
328+
* https://community.intel.com/t5/Intel-C-Compiler/quot-if-constexpr-quot-and-quot-missing-return-statement-quot-in/td-p/1154551
329+
*/
330+
#pragma warning(disable : 1011)
331+
}
332+
#pragma warning(default : 1011)
333+
#else
334+
}
335+
#endif
336+
229337
/** Retrieve a stored specific Attribute and cast if convertible.
230338
*
231339
* @throw std::runtime_error if stored object is not static castable to U.
@@ -245,10 +353,28 @@ inline U getCast(Attribute const &a)
245353
v);
246354
}
247355

356+
template <typename U>
357+
inline std::optional<U> getCastOptional(Attribute const &a)
358+
{
359+
auto v = a.getResource();
360+
361+
return std::visit(
362+
[](auto &&containedValue) -> U {
363+
using containedType = std::decay_t<decltype(containedValue)>;
364+
return doConvert<containedType, U>(&containedValue);
365+
},
366+
v);
367+
}
368+
248369
template <typename U>
249370
U Attribute::get() const
250371
{
251372
return getCast<U>(Variant::getResource());
252373
}
253374

375+
template <typename U>
376+
std::optional<U> Attribute::getOptional() const
377+
{
378+
return getCastOptional<U>(Variant::getResource());
379+
}
254380
} // namespace openPMD

‎include/openPMD/backend/BaseRecord.hpp‎

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -317,24 +317,10 @@ inline void BaseRecord<T_elem>::readBase()
317317
aRead.name = "unitDimension";
318318
this->IOHandler()->enqueue(IOTask(this, aRead));
319319
this->IOHandler()->flush(internal::defaultFlushParams);
320-
if (*aRead.dtype == DT::ARR_DBL_7)
321-
this->setAttribute(
322-
"unitDimension",
323-
Attribute(*aRead.resource).template get<std::array<double, 7> >());
324-
else if (*aRead.dtype == DT::VEC_DOUBLE)
325-
{
326-
auto vec =
327-
Attribute(*aRead.resource).template get<std::vector<double> >();
328-
if (vec.size() == 7)
329-
{
330-
std::array<double, 7> arr;
331-
std::copy(vec.begin(), vec.end(), arr.begin());
332-
this->setAttribute("unitDimension", arr);
333-
}
334-
else
335-
throw std::runtime_error(
336-
"Unexpected Attribute datatype for 'unitDimension'");
337-
}
320+
if (auto val =
321+
Attribute(*aRead.resource).getOptional<std::array<double, 7> >();
322+
val.has_value())
323+
this->setAttribute("unitDimension", val.value());
338324
else
339325
throw std::runtime_error(
340326
"Unexpected Attribute datatype for 'unitDimension'");
@@ -344,10 +330,14 @@ inline void BaseRecord<T_elem>::readBase()
344330
this->IOHandler()->flush(internal::defaultFlushParams);
345331
if (*aRead.dtype == DT::FLOAT)
346332
this->setAttribute(
347-
"timeOffset", Attribute(*aRead.resource).template get<float>());
333+
"timeOffset", Attribute(*aRead.resource).get<float>());
348334
else if (*aRead.dtype == DT::DOUBLE)
349335
this->setAttribute(
350-
"timeOffset", Attribute(*aRead.resource).template get<double>());
336+
"timeOffset", Attribute(*aRead.resource).get<double>());
337+
// conversion cast if a backend reports an integer type
338+
else if (auto val = Attribute(*aRead.resource).getOptional<double>();
339+
val.has_value())
340+
this->setAttribute("timeOffset", val.value());
351341
else
352342
throw std::runtime_error(
353343
"Unexpected Attribute datatype for 'timeOffset'");

‎src/Iteration.cpp‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,10 @@ void Iteration::read_impl(std::string const &groupPath)
417417
setDt(Attribute(*aRead.resource).get<double>());
418418
else if (*aRead.dtype == DT::LONG_DOUBLE)
419419
setDt(Attribute(*aRead.resource).get<long double>());
420+
// conversion cast if a backend reports an integer type
421+
else if (auto val = Attribute(*aRead.resource).getOptional<double>();
422+
val.has_value())
423+
setDt(val.value());
420424
else
421425
throw std::runtime_error("Unexpected Attribute datatype for 'dt'");
422426

@@ -429,14 +433,18 @@ void Iteration::read_impl(std::string const &groupPath)
429433
setTime(Attribute(*aRead.resource).get<double>());
430434
else if (*aRead.dtype == DT::LONG_DOUBLE)
431435
setTime(Attribute(*aRead.resource).get<long double>());
436+
else if (auto val = Attribute(*aRead.resource).getOptional<double>();
437+
val.has_value())
438+
setTime(val.value());
432439
else
433440
throw std::runtime_error("Unexpected Attribute datatype for 'time'");
434441

435442
aRead.name = "timeUnitSI";
436443
IOHandler()->enqueue(IOTask(this, aRead));
437444
IOHandler()->flush(internal::defaultFlushParams);
438-
if (*aRead.dtype == DT::DOUBLE)
439-
setTimeUnitSI(Attribute(*aRead.resource).get<double>());
445+
if (auto val = Attribute(*aRead.resource).getOptional<double>();
446+
val.has_value())
447+
setTimeUnitSI(val.value());
440448
else
441449
throw std::runtime_error(
442450
"Unexpected Attribute datatype for 'timeUnitSI'");

‎src/Mesh.cpp‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -337,25 +337,30 @@ void Mesh::read()
337337
else if (
338338
*aRead.dtype == DT::VEC_LONG_DOUBLE || *aRead.dtype == DT::LONG_DOUBLE)
339339
setGridSpacing(a.get<std::vector<long double> >());
340+
// conversion cast if a backend reports an integer type
341+
else if (auto val = a.getOptional<std::vector<double> >(); val.has_value())
342+
setGridSpacing(val.value());
340343
else
341344
throw std::runtime_error(
342345
"Unexpected Attribute datatype for 'gridSpacing'");
343346

344347
aRead.name = "gridGlobalOffset";
345348
IOHandler()->enqueue(IOTask(this, aRead));
346349
IOHandler()->flush(internal::defaultFlushParams);
347-
if (*aRead.dtype == DT::VEC_DOUBLE || *aRead.dtype == DT::DOUBLE)
348-
setGridGlobalOffset(
349-
Attribute(*aRead.resource).get<std::vector<double> >());
350+
if (auto val =
351+
Attribute(*aRead.resource).getOptional<std::vector<double> >();
352+
val.has_value())
353+
setGridGlobalOffset(val.value());
350354
else
351355
throw std::runtime_error(
352356
"Unexpected Attribute datatype for 'gridGlobalOffset'");
353357

354358
aRead.name = "gridUnitSI";
355359
IOHandler()->enqueue(IOTask(this, aRead));
356360
IOHandler()->flush(internal::defaultFlushParams);
357-
if (*aRead.dtype == DT::DOUBLE)
358-
setGridUnitSI(Attribute(*aRead.resource).get<double>());
361+
if (auto val = Attribute(*aRead.resource).getOptional<double>();
362+
val.has_value())
363+
setGridUnitSI(val.value());
359364
else
360365
throw std::runtime_error(
361366
"Unexpected Attribute datatype for 'gridUnitSI'");

‎src/RecordComponent.cpp‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -389,8 +389,9 @@ void RecordComponent::readBase()
389389
aRead.name = "unitSI";
390390
IOHandler()->enqueue(IOTask(this, aRead));
391391
IOHandler()->flush(internal::defaultFlushParams);
392-
if (*aRead.dtype == DT::DOUBLE)
393-
setUnitSI(Attribute(*aRead.resource).get<double>());
392+
if (auto val = Attribute(*aRead.resource).getOptional<double>();
393+
val.has_value())
394+
setUnitSI(val.value());
394395
else
395396
throw std::runtime_error("Unexpected Attribute datatype for 'unitSI'");
396397

‎src/Series.cpp‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1241,31 +1241,33 @@ void Series::readGorVBased(bool do_init)
12411241
void Series::readBase()
12421242
{
12431243
auto &series = get();
1244-
using DT = Datatype;
12451244
Parameter<Operation::READ_ATT> aRead;
12461245

12471246
aRead.name = "openPMD";
12481247
IOHandler()->enqueue(IOTask(this, aRead));
12491248
IOHandler()->flush(internal::defaultFlushParams);
1250-
if (*aRead.dtype == DT::STRING)
1251-
setOpenPMD(Attribute(*aRead.resource).get<std::string>());
1249+
if (auto val = Attribute(*aRead.resource).getOptional<std::string>();
1250+
val.has_value())
1251+
setOpenPMD(val.value());
12521252
else
12531253
throw std::runtime_error("Unexpected Attribute datatype for 'openPMD'");
12541254

12551255
aRead.name = "openPMDextension";
12561256
IOHandler()->enqueue(IOTask(this, aRead));
12571257
IOHandler()->flush(internal::defaultFlushParams);
1258-
if (*aRead.dtype == determineDatatype<uint32_t>())
1259-
setOpenPMDextension(Attribute(*aRead.resource).get<uint32_t>());
1258+
if (auto val = Attribute(*aRead.resource).getOptional<uint32_t>();
1259+
val.has_value())
1260+
setOpenPMDextension(val.value());
12601261
else
12611262
throw std::runtime_error(
12621263
"Unexpected Attribute datatype for 'openPMDextension'");
12631264

12641265
aRead.name = "basePath";
12651266
IOHandler()->enqueue(IOTask(this, aRead));
12661267
IOHandler()->flush(internal::defaultFlushParams);
1267-
if (*aRead.dtype == DT::STRING)
1268-
setAttribute("basePath", Attribute(*aRead.resource).get<std::string>());
1268+
if (auto val = Attribute(*aRead.resource).getOptional<std::string>();
1269+
val.has_value())
1270+
setAttribute("basePath", val.value());
12691271
else
12701272
throw std::runtime_error(
12711273
"Unexpected Attribute datatype for 'basePath'");
@@ -1280,13 +1282,14 @@ void Series::readBase()
12801282
aRead.name = "meshesPath";
12811283
IOHandler()->enqueue(IOTask(this, aRead));
12821284
IOHandler()->flush(internal::defaultFlushParams);
1283-
if (*aRead.dtype == DT::STRING)
1285+
if (auto val = Attribute(*aRead.resource).getOptional<std::string>();
1286+
val.has_value())
12841287
{
12851288
/* allow setting the meshes path after completed IO */
12861289
for (auto &it : series.iterations)
12871290
it.second.meshes.written() = false;
12881291

1289-
setMeshesPath(Attribute(*aRead.resource).get<std::string>());
1292+
setMeshesPath(val.value());
12901293

12911294
for (auto &it : series.iterations)
12921295
it.second.meshes.written() = true;
@@ -1304,13 +1307,14 @@ void Series::readBase()
13041307
aRead.name = "particlesPath";
13051308
IOHandler()->enqueue(IOTask(this, aRead));
13061309
IOHandler()->flush(internal::defaultFlushParams);
1307-
if (*aRead.dtype == DT::STRING)
1310+
if (auto val = Attribute(*aRead.resource).getOptional<std::string>();
1311+
val.has_value())
13081312
{
13091313
/* allow setting the meshes path after completed IO */
13101314
for (auto &it : series.iterations)
13111315
it.second.particles.written() = false;
13121316

1313-
setParticlesPath(Attribute(*aRead.resource).get<std::string>());
1317+
setParticlesPath(val.value());
13141318

13151319
for (auto &it : series.iterations)
13161320
it.second.particles.written() = true;

‎src/backend/MeshRecordComponent.cpp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ void MeshRecordComponent::read()
4343
else if (
4444
*aRead.dtype == DT::VEC_LONG_DOUBLE || *aRead.dtype == DT::LONG_DOUBLE)
4545
setPosition(a.get<std::vector<long double> >());
46+
// conversion cast if a backend reports an integer type
47+
else if (auto val = a.getOptional<std::vector<double> >(); val.has_value())
48+
setPosition(val.value());
4649
else
4750
throw std::runtime_error(
4851
"Unexpected Attribute datatype for 'position'");

‎src/backend/PatchRecord.cpp‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,10 @@ void PatchRecord::read()
6363
IOHandler()->enqueue(IOTask(this, aRead));
6464
IOHandler()->flush(internal::defaultFlushParams);
6565

66-
if (*aRead.dtype == Datatype::ARR_DBL_7 ||
67-
*aRead.dtype == Datatype::VEC_DOUBLE)
68-
this->setAttribute(
69-
"unitDimension",
70-
Attribute(*aRead.resource).template get<std::array<double, 7> >());
66+
if (auto val =
67+
Attribute(*aRead.resource).getOptional<std::array<double, 7> >();
68+
val.has_value())
69+
this->setAttribute("unitDimension", val.value());
7170
else
7271
throw std::runtime_error(
7372
"Unexpected Attribute datatype for 'unitDimension'");

‎src/backend/PatchRecordComponent.cpp‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,9 @@ void PatchRecordComponent::read()
126126
aRead.name = "unitSI";
127127
IOHandler()->enqueue(IOTask(this, aRead));
128128
IOHandler()->flush(internal::defaultFlushParams);
129-
if (*aRead.dtype == Datatype::DOUBLE)
130-
setUnitSI(Attribute(*aRead.resource).get<double>());
129+
if (auto val = Attribute(*aRead.resource).getOptional<double>();
130+
val.has_value())
131+
setUnitSI(val.value());
131132
else
132133
throw std::runtime_error("Unexpected Attribute datatype for 'unitSI'");
133134

0 commit comments

Comments
 (0)