File: rtti.adoc

package info (click to toggle)
boost1.90 1.90.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 593,120 kB
  • sloc: cpp: 4,190,908; xml: 196,648; python: 34,618; ansic: 23,145; asm: 5,468; sh: 3,774; makefile: 1,161; perl: 1,020; sql: 728; ruby: 676; yacc: 478; java: 77; lisp: 24; csh: 6
file content (77 lines) | stat: -rw-r--r-- 1,603 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

## rtti

### Synopsis

Defined in <boost/openmethod/policies/basic_policy.hpp>.

```c++
namespace boost::openmethod::policies {

struct rtti : policy {};

} // boost::openmethod::policies
```

### Description

The `rtti` policy provides type information for classes and objects, implements
downcast in presence of virtual inheritance, and writes descriptions of types to
an `ostream`-like object.

### Requirements

#### is_polymorphic

```c++
template<class Class> static constexpr bool is_polymorphic;
```

`true` if `Class` is polymorphic.

#### static_type

```c++
template<class Class> static auto static_type() -> type_id;
```

Returns a `type_id` for `Class`.

#### dynamic_type

```c++
template<class Class> static auto dynamic_type(const Class& obj) -> type_id;
```

Returns a `type_id` for an object's dynamic type.

#### type_name

```c++
template<typename Stream>
static auto type_name(type_id type, Stream& stream) -> void;
```

Writes a description of `type` to `stream`.

This requirement is optional. `rtti` provides a default implementation that writes `typeid({type})` to `stream`.

#### type_index

```c++
static auto type_index(type_id type) -> /* unspecified */;
```

Returns a unique key for `type`. Required only for RTTI systems that assign more
than one type "identifiers" to a type. For example, standard RTTI allows
implementations to have multiple instances of `std::type_info` for the same
type.

#### dynamic_cast_ref

```c++
template<typename D, typename B>
static auto dynamic_cast_ref(B&& obj) -> D;
```

Casts `obj` to `D`. Required only if using virtual inheritance.