openPMD-api
Variant.hpp
1 /* Copyright 2017-2021 Fabian Koller, Axel Huebl
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 #include "VariantSrc.hpp"
24 
25 #include <cstddef>
26 #include <type_traits>
27 
28 
29 namespace openPMD
30 {
31 namespace auxiliary
32 {
38 template< class T_DTYPES, typename ... T >
39 class Variant
40 {
41  static_assert(std::is_enum< T_DTYPES >::value, "Datatypes to Variant must be supplied as enum.");
42 
43 public:
44  using resource = variantSrc::variant< T ... >;
52  Variant(resource r)
53  : dtype{static_cast<T_DTYPES>(r.index())},
54  m_data{r}
55  { }
56 
63  template< typename U >
64  U get() const
65  {
66  return variantSrc::get< U >(m_data);
67  }
68 
73  resource getResource() const
74  {
75  return m_data;
76  }
77 
82  constexpr size_t index() const noexcept
83  {
84  return m_data.index();
85  }
86 
87  T_DTYPES dtype;
88 
89 private:
90  resource m_data;
91 };
92 } // auxiliary
93 } // openPMD
openPMD::auxiliary::Variant::Variant
Variant(resource r)
Construct a lightweight wrapper around a generic object that indicates the concrete datatype of the s...
Definition: Variant.hpp:52
openPMD::UnitDimension::T
@ T
time
openPMD::auxiliary::Variant::get
U get() const
Retrieve a stored specific object of known datatype with ensured type-safety.
Definition: Variant.hpp:64
openPMD::auxiliary::Variant::index
constexpr size_t index() const noexcept
Retrieve the index of the alternative that is currently been held.
Definition: Variant.hpp:82
openPMD
Public definitions of openPMD-api.
Definition: Date.cpp:29
openPMD::auxiliary::Variant::getResource
resource getResource() const
Retrieve the stored generic object.
Definition: Variant.hpp:73
openPMD::auxiliary::Variant
Generic object to store a set of datatypes in without losing type safety.
Definition: Variant.hpp:39