instance.h Source File - 0.9.6 |RTTR
instance.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_INSTANCE_H_
29 #define RTTR_INSTANCE_H_
30 
31 #include "rttr/detail/base/core_prerequisites.h"
32 #include "rttr/detail/misc/misc_type_traits.h"
33 #include "rttr/detail/misc/data_address_container.h"
34 
35 namespace rttr
36 {
37 class variant;
38 class type;
39 class argument;
40 
47 class RTTR_API instance
48 {
49  template<typename T, typename Tp = detail::decay_t<T>>
52 
53 public:
59  RTTR_INLINE instance() RTTR_NOEXCEPT;
60 
64  RTTR_INLINE instance(const variant& var) RTTR_NOEXCEPT;
65 
69  RTTR_INLINE instance(const instance& other) RTTR_NOEXCEPT;
70 
76  template<typename T, typename Tp = decay_instance_t<T>>
77  RTTR_INLINE instance(T& data) RTTR_NOEXCEPT;
78 
85  template<typename Target_Type>
86  RTTR_INLINE Target_Type* try_convert() const RTTR_NOEXCEPT;
87 
93  RTTR_INLINE bool is_valid() const RTTR_NOEXCEPT;
94 
100  explicit operator bool() const RTTR_NOEXCEPT;
101 
109  RTTR_INLINE type get_type() const RTTR_NOEXCEPT;
110 
128  RTTR_INLINE instance get_wrapped_instance() const RTTR_NOEXCEPT;
129 
147  RTTR_INLINE type get_derived_type() const RTTR_NOEXCEPT;
148 
149 private:
150  instance& operator=(const instance& other) RTTR_NOEXCEPT;
151 
152  detail::data_address_container m_data_container;
153 };
154 
155 } // end namespace rttr
156 
157 #include "rttr/detail/impl/instance_impl.h"
158 
159 #endif // RTTR_INSTANCE_H_
Definition: access_levels.h:33
The type class holds the type information for any arbitrary object.
Definition: type.h:170
The instance class is used for forwarding the instance of an object to invoke a property or method...
Definition: instance.h:47
detail::enum_data< Enum_Type > value(string_view, Enum_Type value)
The value function should be used to add a mapping from enum name to value during the registration pr...
The variant class allows to store data of any type and convert between these types transparently...
Definition: variant.h:197