enumeration.h
Go to the documentation of this file.
1 /************************************************************************************
2 * *
3 * Copyright (c) 2014 Axel Menzel <info@axelmenzel.de> *
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 
32 #include "rttr/type.h"
33 
34 #include <memory>
35 #include <string>
36 
37 namespace rttr
38 {
39 class type;
40 class Variant;
41 
42 namespace detail
43 {
44 class enumeration_container_base;
45 class argument;
46 }
97 {
98  public:
104  bool is_valid() const;
105 
111  operator bool() const;
112 
118  std::string get_name() const;
119 
125  type get_underlying_type() const;
126 
132  type get_type() const;
133 
142  type get_declaring_type() const;
143 
152  variant get_metadata(int key) const;
153 
162  variant get_metadata(const std::string& key) const;
163 
171  std::vector<std::string> get_keys() const;
172 
173 
181  std::vector<variant> get_values() const;
182 
189  std::string value_to_key(detail::argument value) const;
190 
196  variant key_to_value(const std::string& key) const;
197 
203  bool operator==(const enumeration& other) const;
204 
210  bool operator!=(const enumeration& other) const;
211 
212  private:
213  friend class type; // to prevent creation of this class
215  enumeration(const detail::enumeration_container_base* container = nullptr);
216  private:
217  const detail::enumeration_container_base* _container;
218 };
219 
220 } // end namespace rttr
221 
222 #endif // __RTTR_ENUMERATION_H__
The namespace for all rttr components.
Definition: core_prerequisites.h:33
This class holds the type information for any arbitrary object.
Definition: type.h:165
The enumeration class provides several meta information about an enum.
Definition: enumeration.h:96
The variant class allows to store data of any type and convert between these types transparently...
Definition: variant.h:125
#define RTTR_API
Definition: core_prerequisites.h:124