forked from DLR-SC/tigl-website
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathclassT8Type.html
196 lines (188 loc) · 10.2 KB
/
classT8Type.html
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>t8: T8Type< T, Parameter, competence > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">t8
 <span id="projectnumber">4.0.0-RC1.588-22cbd</span>
</div>
<div id="projectbrief">t8code is a C library to manage a forest of adaptive space-trees of general element classes in parallel.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">T8Type< T, Parameter, competence > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An implementation of strong type with additional competences.
<a href="classT8Type.html#details">More...</a></p>
<p><code>#include <<a class="el" href="t8__type_8hxx_source.html">t8_type.hxx</a>></code></p>
<div class="dynheader">
Inheritance diagram for T8Type< T, Parameter, competence >:</div>
<div class="dyncontent">
<div class="center">
<img src="classT8Type.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af12297465367421f17cca706085247f3"><td class="memItemLeft" align="right" valign="top"><a id="af12297465367421f17cca706085247f3"></a>
using </td><td class="memItemRight" valign="bottom"><b>value_type</b> = T</td></tr>
<tr class="separator:af12297465367421f17cca706085247f3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a31433b33b86457fa7d841006cd5e2d88"><td class="memItemLeft" align="right" valign="top"><a id="a31433b33b86457fa7d841006cd5e2d88"></a>
constexpr </td><td class="memItemRight" valign="bottom"><b>T8Type</b> (const T &value)</td></tr>
<tr class="separator:a31433b33b86457fa7d841006cd5e2d88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa709fdf352d80185cd3dda189c55c972"><td class="memTemplParams" colspan="2">template<typename T_ref = T> </td></tr>
<tr class="memitem:aa709fdf352d80185cd3dda189c55c972"><td class="memTemplItemLeft" align="right" valign="top">constexpr </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classT8Type.html#aa709fdf352d80185cd3dda189c55c972">T8Type</a> (T &&value, typename std::enable_if<!std::is_reference< T_ref > {}, std::nullptr_t >::type=nullptr)</td></tr>
<tr class="memdesc:aa709fdf352d80185cd3dda189c55c972"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classT8Type.html" title="An implementation of strong type with additional competences.">T8Type</a> object. <a href="classT8Type.html#aa709fdf352d80185cd3dda189c55c972">More...</a><br /></td></tr>
<tr class="separator:aa709fdf352d80185cd3dda189c55c972"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc148c394aae8dc73a083c5891a254ff"><td class="memItemLeft" align="right" valign="top"><a id="adc148c394aae8dc73a083c5891a254ff"></a>
constexpr <a class="el" href="classT8Type.html">T8Type</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const T &value)</td></tr>
<tr class="separator:adc148c394aae8dc73a083c5891a254ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59d939e6200452904a61e7989d43b445"><td class="memItemLeft" align="right" valign="top"><a id="a59d939e6200452904a61e7989d43b445"></a>
constexpr T & </td><td class="memItemRight" valign="bottom"><b>get</b> () noexcept</td></tr>
<tr class="separator:a59d939e6200452904a61e7989d43b445"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace892eadb0ab82e35449047ca831d4e9"><td class="memItemLeft" align="right" valign="top"><a id="ace892eadb0ab82e35449047ca831d4e9"></a>
constexpr T const & </td><td class="memItemRight" valign="bottom"><b>get</b> () const noexcept</td></tr>
<tr class="separator:ace892eadb0ab82e35449047ca831d4e9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T, typename Parameter, template< typename > class... competence><br />
class T8Type< T, Parameter, competence ></h3>
<p>An implementation of strong type with additional competences. </p>
<p>This class template allows the creation of a type that can be extended with multiple competences. Each competence is a template class that takes the main type as a template parameter.</p>
<p>This is heavily inspired by (and taken from) <a href="https://www.fluentcpp.com/2016/12/08/strong-types-for-strong-interfaces/">https://www.fluentcpp.com/2016/12/08/strong-types-for-strong-interfaces/</a></p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type of the value to be stored. </td></tr>
<tr><td class="paramname">Parameter</td><td>An additional parameter for the type. </td></tr>
<tr><td class="paramname">competence</td><td>Variadic template parameter for the competences. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aa709fdf352d80185cd3dda189c55c972"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa709fdf352d80185cd3dda189c55c972">◆ </a></span>T8Type()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , typename Parameter , template< typename > class... competence> </div>
<div class="memtemplate">
template<typename T_ref = T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classT8Type.html">T8Type</a>< T, Parameter, competence >::<a class="el" href="classT8Type.html">T8Type</a> </td>
<td>(</td>
<td class="paramtype">T && </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename std::enable_if<!std::is_reference< T_ref > {}, std::nullptr_t >::type </td>
<td class="paramname"> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new <a class="el" href="classT8Type.html" title="An implementation of strong type with additional competences.">T8Type</a> object. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T_ref</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This constructor is only enabled if T is not a reference. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/t8_types/<a class="el" href="t8__type_8hxx_source.html">t8_type.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
</body>
</html>