openPMD-api
Variant.hpp
1 /* Copyright 2017-2020 Fabian Koller
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 <type_traits>
26 
27 
28 namespace openPMD
29 {
30 namespace auxiliary
31 {
37 template< class T_DTYPES, typename ... T >
38 class Variant
39 {
40  static_assert(std::is_enum< T_DTYPES >::value, "Datatypes to Variant must be supplied as enum.");
41 
42 public:
43  using resource = variantSrc::variant< T ... >;
51  Variant(resource r)
52  : dtype{static_cast<T_DTYPES>(r.index())},
53  m_data{r}
54  { }
55 
62  template< typename U >
63  U get() const
64  {
65  return variantSrc::get< U >(m_data);
66  }
67 
72  resource getResource() const
73  {
74  return m_data;
75  }
76 
81  constexpr size_t index() const noexcept
82  {
83  return m_data.index();
84  }
85 
86  T_DTYPES dtype;
87 
88 private:
89  resource m_data;
90 };
91 } // auxiliary
92 } // openPMD
Variant(resource r)
Construct a lightweight wrapper around a generic object that indicates the concrete datatype of the s...
Definition: Variant.hpp:51
Generic object to store a set of datatypes in without losing type safety.
Definition: Variant.hpp:38
constexpr size_t index() const noexcept
Retrieve the index of the alternative that is currently been held.
Definition: Variant.hpp:81
Public definitions of openPMD-api.
Definition: Date.cpp:29
resource getResource() const
Retrieve the stored generic object.
Definition: Variant.hpp:72