property.h
Go to the documentation of this file.
1/************************************************************************************
2* *
3* Copyright (c) 2014 - 2018 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_PROPERTY_H_
29#define RTTR_PROPERTY_H_
30
31#include "rttr/detail/base/core_prerequisites.h"
32#include "rttr/detail/misc/class_item_mapper.h"
33#include "rttr/parameter_info.h"
34#include "rttr/access_levels.h"
35#include "rttr/string_view.h"
36
37#include <string>
38
39namespace rttr
40{
41class variant;
42class type;
43class enumeration;
44class instance;
45class argument;
46class property;
47class visitor;
48
49namespace detail
50{
51 class property_wrapper_base;
52}
53
117class RTTR_API property
118{
119 public:
125 bool is_valid() const RTTR_NOEXCEPT;
126
132 explicit operator bool() const RTTR_NOEXCEPT;
133
142 access_levels get_access_level() const RTTR_NOEXCEPT;
143
151 bool is_readonly() const RTTR_NOEXCEPT;
152
161 bool is_static() const RTTR_NOEXCEPT;
162
170 bool is_enumeration() const RTTR_NOEXCEPT;
171
180 enumeration get_enumeration() const RTTR_NOEXCEPT;
181
189 string_view get_name() const RTTR_NOEXCEPT;
190
198 type get_type() const RTTR_NOEXCEPT;
199
208 type get_declaring_type() const RTTR_NOEXCEPT;
209
221 bool set_value(instance object, argument arg) const;
222
232 variant get_value(instance object) const;
233
242 variant get_metadata(const variant& key) const;
243
249 bool operator==(const property& other) const RTTR_NOEXCEPT;
250
256 bool operator!=(const property& other) const RTTR_NOEXCEPT;
257
258 private:
260 property(const detail::property_wrapper_base* wrapper) RTTR_NOEXCEPT;
261
262 void visit(visitor& visitor) const RTTR_NOEXCEPT;
263
264 template<typename T>
265 friend T detail::create_item(const detail::class_item_to_wrapper_t<T>* wrapper);
266 template<typename T>
267 friend T detail::create_invalid_item();
268 friend class visitor;
269
270 private:
271 const detail::property_wrapper_base* m_wrapper;
272};
273
274} // end namespace rttr
275
276#endif // RTTR_PROPERTY_H_
The argument class is used for forwarding arguments to properties or methods.
Definition: argument.h:52
The class template basic_string_view describes an non-owning reference to a constant contiguous seque...
Definition: string_view.h:49
The enumeration class provides several meta information about an enum.
Definition: enumeration.h:113
The instance class is used for forwarding the instance of an object to invoke a property or method.
Definition: instance.h:48
The property class provides several meta information about a property and gives read/write access to ...
Definition: property.h:118
bool is_valid() const noexcept
Returns true if this property is valid, otherwise false.
The type class holds the type information for any arbitrary object.
Definition: type.h:178
The variant class allows to store data of any type and convert between these types transparently.
Definition: variant.h:199
The class visitor, is used for visiting your registered accessors of a type at compile time.
Definition: visitor.h:99
Definition: access_levels.h:34
access_levels
The access_levels enum represents the three access modifiers, which can be used in classes to encapsu...
Definition: access_levels.h:46