<!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::range_t Class 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="classuhd_1_1range__t.html">range_t</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classuhd_1_1range__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::range_t Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="ranges_8hpp_source.html">ranges.hpp</a>></code></p>
<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:a0ba373b18ca1bdc0cc7397abd0b800e1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1range__t.html#a0ba373b18ca1bdc0cc7397abd0b800e1">range_t</a> (double value=0)</td></tr>
<tr class="separator:a0ba373b18ca1bdc0cc7397abd0b800e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc9ef01a3fbb7748b0fb0fc2ae7d0276"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1range__t.html#acc9ef01a3fbb7748b0fb0fc2ae7d0276">range_t</a> (double <a class="el" href="classuhd_1_1range__t.html#ae237a39211a74455b3b7d8fe27014edd">start</a>, double <a class="el" href="classuhd_1_1range__t.html#a624344f03cbc99803fd39593c1f2f217">stop</a>, double <a class="el" href="classuhd_1_1range__t.html#a246d798fa86beac06207b1cebf949b95">step</a>=0)</td></tr>
<tr class="separator:acc9ef01a3fbb7748b0fb0fc2ae7d0276"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae237a39211a74455b3b7d8fe27014edd"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1range__t.html#ae237a39211a74455b3b7d8fe27014edd">start</a> (void) const </td></tr>
<tr class="memdesc:ae237a39211a74455b3b7d8fe27014edd"><td class="mdescLeft"> </td><td class="mdescRight">Get the start value for this range. <a href="#ae237a39211a74455b3b7d8fe27014edd">More...</a><br /></td></tr>
<tr class="separator:ae237a39211a74455b3b7d8fe27014edd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a624344f03cbc99803fd39593c1f2f217"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1range__t.html#a624344f03cbc99803fd39593c1f2f217">stop</a> (void) const </td></tr>
<tr class="memdesc:a624344f03cbc99803fd39593c1f2f217"><td class="mdescLeft"> </td><td class="mdescRight">Get the stop value for this range. <a href="#a624344f03cbc99803fd39593c1f2f217">More...</a><br /></td></tr>
<tr class="separator:a624344f03cbc99803fd39593c1f2f217"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a246d798fa86beac06207b1cebf949b95"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1range__t.html#a246d798fa86beac06207b1cebf949b95">step</a> (void) const </td></tr>
<tr class="memdesc:a246d798fa86beac06207b1cebf949b95"><td class="mdescLeft"> </td><td class="mdescRight">Get the step value for this range. <a href="#a246d798fa86beac06207b1cebf949b95">More...</a><br /></td></tr>
<tr class="separator:a246d798fa86beac06207b1cebf949b95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba36a3206565d29a20633138b2c17eaa"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1range__t.html#aba36a3206565d29a20633138b2c17eaa">to_pp_string</a> (void) const </td></tr>
<tr class="memdesc:aba36a3206565d29a20633138b2c17eaa"><td class="mdescLeft"> </td><td class="mdescRight">Convert this range to a printable string. <a href="#aba36a3206565d29a20633138b2c17eaa">More...</a><br /></td></tr>
<tr class="separator:aba36a3206565d29a20633138b2c17eaa"><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 range object describes a set of discrete values of the form: y = start + step*n, where n is an integer between 0 and (stop - start)/step </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0ba373b18ca1bdc0cc7397abd0b800e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uhd::range_t::range_t </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>value</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a range from a single value. The step size will be taken as zero. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the only possible value in this range </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acc9ef01a3fbb7748b0fb0fc2ae7d0276"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uhd::range_t::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>Create a range from a full set of values. 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="ae237a39211a74455b3b7d8fe27014edd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double uhd::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 start value for this range. </p>
</div>
</div>
<a class="anchor" id="a246d798fa86beac06207b1cebf949b95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double uhd::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 step value for this range. </p>
</div>
</div>
<a class="anchor" id="a624344f03cbc99803fd39593c1f2f217"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double uhd::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 stop value for this range. </p>
</div>
</div>
<a class="anchor" id="aba36a3206565d29a20633138b2c17eaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string uhd::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 range to a printable string. </p>
</div>
</div>
<hr/>The documentation for this class 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>
