uvw/classuvw_1_1UnderlyingType.html
2017-10-11 09:11:53 +02:00

197 lines
9.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: uvw::UnderlyingType&lt; T, U &gt; 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>
<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">uvw
&#160;<span id="projectnumber">1.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1UnderlyingType.html">UnderlyingType</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classuvw_1_1UnderlyingType-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uvw::UnderlyingType&lt; T, U &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wrapper class for underlying types.
<a href="classuvw_1_1UnderlyingType.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="underlying__type_8hpp_source.html">underlying_type.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for uvw::UnderlyingType&lt; T, U &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1UnderlyingType__inherit__graph.png" border="0" usemap="#uvw_1_1UnderlyingType_3_01T_00_01U_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="uvw_1_1UnderlyingType_3_01T_00_01U_01_4_inherit__map" id="uvw_1_1UnderlyingType_3_01T_00_01U_01_4_inherit__map">
<area shape="rect" id="node2" href="classuvw_1_1Resource.html" title="Common class for almost all the resources available in uvw. " alt="" coords="5,95,165,121"/>
<area shape="rect" id="node3" href="classuvw_1_1Handle.html" title="Handle base class. " alt="" coords="13,169,158,196"/>
<area shape="rect" id="node4" href="classuvw_1_1StreamHandle.html" title="The StreamHandle handle. " alt="" coords="13,244,158,285"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:aab78fbfffb3c03d78aab515e605ecb18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1Loop.html">Loop</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#aab78fbfffb3c03d78aab515e605ecb18">loop</a> () const noexcept</td></tr>
<tr class="memdesc:aab78fbfffb3c03d78aab515e605ecb18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the loop from which the resource was originated. <a href="#aab78fbfffb3c03d78aab515e605ecb18">More...</a><br /></td></tr>
<tr class="separator:aab78fbfffb3c03d78aab515e605ecb18"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa711faff7e88895f769f66e8245bda73"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:aa711faff7e88895f769f66e8245bda73"><td class="memTemplItemLeft" align="right" valign="top">static std::shared_ptr&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#aa711faff7e88895f769f66e8245bda73">create</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:aa711faff7e88895f769f66e8245bda73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new resource of the given type. <a href="#aa711faff7e88895f769f66e8245bda73">More...</a><br /></td></tr>
<tr class="separator:aa711faff7e88895f769f66e8245bda73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T, typename U&gt;<br />
class uvw::UnderlyingType&lt; T, U &gt;</h3>
<p>Wrapper class for underlying types. </p>
<p>It acts mainly as a wrapper around data structures of the underlying library. </p>
<p class="definition">Definition at line <a class="el" href="underlying__type_8hpp_source.html#l00019">19</a> of file <a class="el" href="underlying__type_8hpp_source.html">underlying_type.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa711faff7e88895f769f66e8245bda73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa711faff7e88895f769f66e8245bda73">&#9670;&nbsp;</a></span>create()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename U&gt; </div>
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::shared_ptr&lt;T&gt; <a class="el" href="classuvw_1_1UnderlyingType.html">uvw::UnderlyingType</a>&lt; T, U &gt;::create </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new resource of the given type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Arguments to be forwarded to the actual constructor (if any). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the newly created resource. </dd></dl>
<p class="definition">Definition at line <a class="el" href="underlying__type_8hpp_source.html#l00077">77</a> of file <a class="el" href="underlying__type_8hpp_source.html">underlying_type.hpp</a>.</p>
</div>
</div>
<a id="aab78fbfffb3c03d78aab515e605ecb18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab78fbfffb3c03d78aab515e605ecb18">&#9670;&nbsp;</a></span>loop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, typename U&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuvw_1_1Loop.html">Loop</a>&amp; <a class="el" href="classuvw_1_1UnderlyingType.html">uvw::UnderlyingType</a>&lt; T, U &gt;::loop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the loop from which the resource was originated. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to a loop instance. </dd></dl>
<p class="definition">Definition at line <a class="el" href="underlying__type_8hpp_source.html#l00085">85</a> of file <a class="el" href="underlying__type_8hpp_source.html">underlying_type.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/uvw/<a class="el" href="underlying__type_8hpp_source.html">underlying_type.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>