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;
47
48namespace detail
49{
50 class property_wrapper_base;
51}
52
116class RTTR_API property
117{
118 public:
124 bool is_valid() const RTTR_NOEXCEPT;
125
131 explicit operator bool() const RTTR_NOEXCEPT;
132
141 access_levels get_access_level() const RTTR_NOEXCEPT;
142
150 bool is_readonly() const RTTR_NOEXCEPT;
151
160 bool is_static() const RTTR_NOEXCEPT;
161
169 bool is_enumeration() const RTTR_NOEXCEPT;
170
179 enumeration get_enumeration() const RTTR_NOEXCEPT;
180
188 string_view get_name() const RTTR_NOEXCEPT;
189
197 type get_type() const RTTR_NOEXCEPT;
198
207 type get_declaring_type() const RTTR_NOEXCEPT;
208
220 bool set_value(instance object, argument arg) const;
221
232
241 variant get_metadata(const variant& key) const;
242
248 bool operator==(const property& other) const RTTR_NOEXCEPT;
249
255 bool operator!=(const property& other) const RTTR_NOEXCEPT;
256
257 private:
259 property(const detail::property_wrapper_base* wrapper) RTTR_NOEXCEPT;
260
261 template<typename T>
262 friend T detail::create_item(const detail::class_item_to_wrapper_t<T>* wrapper);
263 template<typename T>
264 friend T detail::create_invalid_item();
265
266 private:
267 const detail::property_wrapper_base* m_wrapper;
268};
269
270} // end namespace rttr
271
272#endif // RTTR_PROPERTY_H_
The argument class is used for forwarding arguments to properties or methods.
Definition argument.h:52
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:117
bool set_value(instance object, argument arg) const
Set the property of the given instance object to the given value arg.
variant get_value(instance object) const
Returns the current property value of the given instance object.
bool is_readonly() const noexcept
Returns true if this property is read only, otherwise false.
bool is_static() const noexcept
Returns true if this property is static property, otherwise false.
bool is_valid() const noexcept
Returns true if this property is valid, otherwise false.
enumeration get_enumeration() const noexcept
Returns the enumerator if this property is an enum type; otherwise the returned value is not valid.
type get_type() const noexcept
Returns the underlying type object of this property.
bool is_enumeration() const noexcept
Returns true if the underlying property is an enumeration.
string_view get_name() const noexcept
Returns the name of this property.
variant get_metadata(const variant &key) const
Returns the meta data for the given key key.
access_levels get_access_level() const noexcept
Returns the access level with which this property was registered.
type get_declaring_type() const noexcept
Returns the type of the class or struct that declares this property.
The type class holds the type information for any arbitrary object.
Definition type.h:171
The variant class allows to store data of any type and convert between these types transparently.
Definition variant.h:198
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
basic_string_view< char > string_view
A class to hold a reference to a continuous sequence of char objects.
Definition string_view.h:493