<!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.8"/>
<title>UHD: uhd::meta_range_t Struct 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">UHD
 <span id="projectnumber">003.007.002-0-unknown</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></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="namespaceuhd.html">uhd</a></li><li class="navelem"><a class="el" href="structuhd_1_1meta__range__t.html">meta_range_t</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="structuhd_1_1meta__range__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::meta_range_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="ranges_8hpp_source.html">ranges.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for uhd::meta_range_t:</div>
<div class="dyncontent">
<div class="center">
<img src="structuhd_1_1meta__range__t.png" usemap="#uhd::meta_range_t_map" alt=""/>
<map id="uhd::meta_range_t_map" name="uhd::meta_range_t_map">
</map>
</div></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:a984d835f7de595da5f7476bec1ea561d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#a984d835f7de595da5f7476bec1ea561d">meta_range_t</a> (void)</td></tr>
<tr class="memdesc:a984d835f7de595da5f7476bec1ea561d"><td class="mdescLeft"> </td><td class="mdescRight">A default constructor for an empty meta-range. <a href="#a984d835f7de595da5f7476bec1ea561d">More...</a><br /></td></tr>
<tr class="separator:a984d835f7de595da5f7476bec1ea561d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cc9dc38cb26185596b785070f6b3cda"><td class="memTemplParams" colspan="2">template<typename InputIterator > </td></tr>
<tr class="memitem:a3cc9dc38cb26185596b785070f6b3cda"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#a3cc9dc38cb26185596b785070f6b3cda">meta_range_t</a> (InputIterator first, InputIterator last)</td></tr>
<tr class="separator:a3cc9dc38cb26185596b785070f6b3cda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75b127b424b6f5b6d8ff10a6430da110"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#a75b127b424b6f5b6d8ff10a6430da110">meta_range_t</a> (double <a class="el" href="structuhd_1_1meta__range__t.html#a4f09a1a81b966a92ebfa25f6c1d351ec">start</a>, double <a class="el" href="structuhd_1_1meta__range__t.html#a89bf767f8817f78553460ba30d4a81f9">stop</a>, double <a class="el" href="structuhd_1_1meta__range__t.html#ae3227073aedda2b53b4b44cb75d8709b">step</a>=0)</td></tr>
<tr class="separator:a75b127b424b6f5b6d8ff10a6430da110"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f09a1a81b966a92ebfa25f6c1d351ec"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#a4f09a1a81b966a92ebfa25f6c1d351ec">start</a> (void) const </td></tr>
<tr class="memdesc:a4f09a1a81b966a92ebfa25f6c1d351ec"><td class="mdescLeft"> </td><td class="mdescRight">Get the overall start value for this meta-range. <a href="#a4f09a1a81b966a92ebfa25f6c1d351ec">More...</a><br /></td></tr>
<tr class="separator:a4f09a1a81b966a92ebfa25f6c1d351ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89bf767f8817f78553460ba30d4a81f9"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#a89bf767f8817f78553460ba30d4a81f9">stop</a> (void) const </td></tr>
<tr class="memdesc:a89bf767f8817f78553460ba30d4a81f9"><td class="mdescLeft"> </td><td class="mdescRight">Get the overall stop value for this meta-range. <a href="#a89bf767f8817f78553460ba30d4a81f9">More...</a><br /></td></tr>
<tr class="separator:a89bf767f8817f78553460ba30d4a81f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3227073aedda2b53b4b44cb75d8709b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#ae3227073aedda2b53b4b44cb75d8709b">step</a> (void) const </td></tr>
<tr class="memdesc:ae3227073aedda2b53b4b44cb75d8709b"><td class="mdescLeft"> </td><td class="mdescRight">Get the overall step value for this meta-range. <a href="#ae3227073aedda2b53b4b44cb75d8709b">More...</a><br /></td></tr>
<tr class="separator:ae3227073aedda2b53b4b44cb75d8709b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e6d7a0780ea2962c0ba13e9d64f9235"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#a3e6d7a0780ea2962c0ba13e9d64f9235">clip</a> (double value, bool clip_step=false) const </td></tr>
<tr class="separator:a3e6d7a0780ea2962c0ba13e9d64f9235"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49d43278da7a467d42140f9dbff047f7"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1meta__range__t.html#a49d43278da7a467d42140f9dbff047f7">to_pp_string</a> (void) const </td></tr>
<tr class="memdesc:a49d43278da7a467d42140f9dbff047f7"><td class="mdescLeft"> </td><td class="mdescRight">Convert this meta-range to a printable string. <a href="#a49d43278da7a467d42140f9dbff047f7">More...</a><br /></td></tr>
<tr class="separator:a49d43278da7a467d42140f9dbff047f7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A meta-range object holds a list of individual ranges. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a984d835f7de595da5f7476bec1ea561d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uhd::meta_range_t::meta_range_t </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A default constructor for an empty meta-range. </p>
</div>
</div>
<a class="anchor" id="a3cc9dc38cb26185596b785070f6b3cda"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename InputIterator > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uhd::meta_range_t::meta_range_t </td>
<td>(</td>
<td class="paramtype">InputIterator </td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InputIterator </td>
<td class="paramname"><em>last</em> </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Input iterator constructor: Makes boost::assign::list_of work. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">first</td><td>the begin iterator </td></tr>
<tr><td class="paramname">last</td><td>the end iterator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a75b127b424b6f5b6d8ff10a6430da110"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uhd::meta_range_t::meta_range_t </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>stop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>step</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A convenience constructor for a single range. A step size of zero implies infinite precision. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>the minimum value for this range </td></tr>
<tr><td class="paramname">stop</td><td>the maximum value for this range </td></tr>
<tr><td class="paramname">step</td><td>the step size for this range </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3e6d7a0780ea2962c0ba13e9d64f9235"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double uhd::meta_range_t::clip </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>clip_step</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clip the target value to a possible range value. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to clip to this range </td></tr>
<tr><td class="paramname">clip_step</td><td>if true, clip to steps as well </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a value that is in one of the ranges </dd></dl>
</div>
</div>
<a class="anchor" id="a4f09a1a81b966a92ebfa25f6c1d351ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double uhd::meta_range_t::start </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the overall start value for this meta-range. </p>
</div>
</div>
<a class="anchor" id="ae3227073aedda2b53b4b44cb75d8709b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double uhd::meta_range_t::step </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the overall step value for this meta-range. </p>
</div>
</div>
<a class="anchor" id="a89bf767f8817f78553460ba30d4a81f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double uhd::meta_range_t::stop </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the overall stop value for this meta-range. </p>
</div>
</div>
<a class="anchor" id="a49d43278da7a467d42140f9dbff047f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string uhd::meta_range_t::to_pp_string </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert this meta-range to a printable string. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/uhd/types/<a class="el" href="ranges_8hpp_source.html">ranges.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
eb4b034508697cc17e7c9cfffe7f772b
>
files
>
716
