property.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_PROPERTY_H__
29 #define __RTTR_PROPERTY_H__
30 
32 
33 #include <string>
34 
35 namespace rttr
36 {
37 class variant;
38 class type;
39 class enumeration;
40 
41 namespace detail
42 {
43 class property_container_base;
44 class instance;
45 class argument;
46 }
47 
110 {
111  public:
117  bool is_valid() const;
118 
124  operator bool() const;
125 
133  bool is_readonly() const;
134 
135 
144  bool is_static() const;
145 
146 
154  bool is_enumeration() const;
155 
164  enumeration get_enumeration() const;
165 
173  bool is_array() const;
174 
182  std::string get_name() const;
183 
191  type get_type() const;
192 
201  type get_declaring_type() const;
202 
214  bool set_value(detail::instance object, detail::argument arg) const;
215 
225  variant get_value(detail::instance object) const;
226 
235  variant get_metadata(int key) const;
236 
245  variant get_metadata(const std::string& key) const;
246 
252  bool operator==(const property& other) const;
253 
259  bool operator!=(const property& other) const;
260 
261  private:
262  friend class type; // to prevent creation of this class
264  property(const detail::property_container_base* container = nullptr);
265  private:
266  const detail::property_container_base* _container;
267 };
268 
269 } // end namespace rttr
270 
271 #endif // __RTTR_PROPERTY_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 property class provides several meta information about a property and gives read/write access to ...
Definition: property.h:109
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