enumeration.h
Go to the documentation of this file.
1 /************************************************************************************
2 * *
3 * Copyright (c) 2014, 2015 - 2016 Axel Menzel <info@rttr.org> *
4 * *
5 * This file is part of RTTR (Run Time Type Reflection) *
6 * License: MIT License *
7 * *
8 * Permission is hereby granted, free of charge, to any person obtaining *
9 * a copy of this software and associated documentation files (the "Software"), *
10 * to deal in the Software without restriction, including without limitation *
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense, *
12 * and/or sell copies of the Software, and to permit persons to whom the *
13 * Software is furnished to do so, subject to the following conditions: *
14 * *
15 * The above copyright notice and this permission notice shall be included in *
16 * all copies or substantial portions of the Software. *
17 * *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *
24 * SOFTWARE. *
25 * *
26 *************************************************************************************/
27 
28 #ifndef RTTR_ENUMERATION_H_
29 #define RTTR_ENUMERATION_H_
30 
31 #include "rttr/detail/base/core_prerequisites.h"
32 #include "rttr/type.h"
33 
34 #include <memory>
35 #include <string>
36 
37 namespace rttr
38 {
39 class type;
40 class variant;
41 class argument;
42 
43 namespace detail
44 {
45  class enumeration_wrapper_base;
46 }
47 
101 class RTTR_API enumeration
102 {
103  public:
109  bool is_valid() const;
110 
116  explicit operator bool() const;
117 
123  std::string get_name() const;
124 
130  type get_underlying_type() const;
131 
137  type get_type() const;
138 
147  type get_declaring_type() const;
148 
157  variant get_metadata(const variant& key) const;
158 
166  std::vector<std::string> get_names() const;
167 
168 
176  std::vector<variant> get_values() const;
177 
184  std::string value_to_name(argument value) const;
185 
191  variant name_to_value(const std::string& name) const;
192 
198  bool operator==(const enumeration& other) const;
199 
205  bool operator!=(const enumeration& other) const;
206 
207  private:
208  friend class type; // to prevent creation of this class
210  enumeration(const detail::enumeration_wrapper_base* wrapper = nullptr);
211  private:
212  const detail::enumeration_wrapper_base* m_wrapper;
213 };
214 
215 } // end namespace rttr
216 
217 #endif // RTTR_ENUMERATION_H_
Definition: access_levels.h:33
The type class holds the type information for any arbitrary object.
Definition: type.h:153
The enumeration class provides several meta information about an enum.
Definition: enumeration.h:101
detail::enum_data< Enum_Type > value(const char *name, Enum_Type value)
The value function should be used to add a mapping from enum name to value during the registration pr...
The argument class is used for forwarding arguments to properties or methods.
Definition: argument.h:51
The variant class allows to store data of any type and convert between these types transparently...
Definition: variant.h:192