<!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::ref_vector< T > 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/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_1ref__vector.html">ref_vector</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classuhd_1_1ref__vector-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">uhd::ref_vector< T > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="ref__vector_8hpp_source.html">ref_vector.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:a718adec3ee38e28a33358322f5395a75"><td class="memTemplParams" colspan="2">template<typename Ptr > </td></tr> <tr class="memitem:a718adec3ee38e28a33358322f5395a75"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuhd_1_1ref__vector.html#a718adec3ee38e28a33358322f5395a75">ref_vector</a> (Ptr *ptr)</td></tr> <tr class="separator:a718adec3ee38e28a33358322f5395a75"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a60d654808b319cc0ab85c947fcf1f848"><td class="memTemplParams" colspan="2">template<typename Vector > </td></tr> <tr class="memitem:a60d654808b319cc0ab85c947fcf1f848"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuhd_1_1ref__vector.html#a60d654808b319cc0ab85c947fcf1f848">ref_vector</a> (const Vector &vec)</td></tr> <tr class="separator:a60d654808b319cc0ab85c947fcf1f848"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a031378d4a30662f30bb188cba135d2d5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1ref__vector.html#a031378d4a30662f30bb188cba135d2d5">ref_vector</a> (const T *mem, size_t len)</td></tr> <tr class="separator:a031378d4a30662f30bb188cba135d2d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a23ccf9c7f7ae96b3e1796d8b369bbc5a"><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1ref__vector.html#a23ccf9c7f7ae96b3e1796d8b369bbc5a">operator[]</a> (size_t index) const </td></tr> <tr class="memdesc:a23ccf9c7f7ae96b3e1796d8b369bbc5a"><td class="mdescLeft"> </td><td class="mdescRight">Index operator gets the value of rv[index]. <a href="#a23ccf9c7f7ae96b3e1796d8b369bbc5a">More...</a><br /></td></tr> <tr class="separator:a23ccf9c7f7ae96b3e1796d8b369bbc5a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a18c02aaeb6625441213070adea95daa5"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1ref__vector.html#a18c02aaeb6625441213070adea95daa5">size</a> (void) const </td></tr> <tr class="memdesc:a18c02aaeb6625441213070adea95daa5"><td class="mdescLeft"> </td><td class="mdescRight">The number of elements in this container. <a href="#a18c02aaeb6625441213070adea95daa5">More...</a><br /></td></tr> <tr class="separator:a18c02aaeb6625441213070adea95daa5"><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><br /> class uhd::ref_vector< T ></h3> <p>Reference vector:</p><ul> <li>Provides a std::vector-like interface for an array.</li> <li>Statically sized, and does not manage the memory. </li> </ul> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a718adec3ee38e28a33358322f5395a75"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <div class="memtemplate"> template<typename Ptr > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classuhd_1_1ref__vector.html">uhd::ref_vector</a>< T >::<a class="el" href="classuhd_1_1ref__vector.html">ref_vector</a> </td> <td>(</td> <td class="paramtype">Ptr * </td> <td class="paramname"><em>ptr</em></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>Create a reference vector of size 1 from a pointer. Therefore: rv[0] == ptr and rv.size() == 1 </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ptr</td><td>a pointer to a chunk of memory </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a60d654808b319cc0ab85c947fcf1f848"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <div class="memtemplate"> template<typename Vector > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classuhd_1_1ref__vector.html">uhd::ref_vector</a>< T >::<a class="el" href="classuhd_1_1ref__vector.html">ref_vector</a> </td> <td>(</td> <td class="paramtype">const Vector & </td> <td class="paramname"><em>vec</em></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>Create a reference vector from a std::vector container. Therefore: rv[n] == vec[n] and rv.size() == vec.size() </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">vec</td><td>a const reference to an std::vector </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a031378d4a30662f30bb188cba135d2d5"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classuhd_1_1ref__vector.html">uhd::ref_vector</a>< T >::<a class="el" href="classuhd_1_1ref__vector.html">ref_vector</a> </td> <td>(</td> <td class="paramtype">const T * </td> <td class="paramname"><em>mem</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>len</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>Create a reference vector from a pointer and a length Therefore: rv[n] == mem[n] and rv.size() == len </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">mem</td><td>a pointer to an array of pointers </td></tr> <tr><td class="paramname">len</td><td>the length of the array of pointers </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a23ccf9c7f7ae96b3e1796d8b369bbc5a"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const T& <a class="el" href="classuhd_1_1ref__vector.html">uhd::ref_vector</a>< T >::operator[] </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"><em>index</em></td><td>)</td> <td> const</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>Index operator gets the value of rv[index]. </p> </div> </div> <a class="anchor" id="a18c02aaeb6625441213070adea95daa5"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">size_t <a class="el" href="classuhd_1_1ref__vector.html">uhd::ref_vector</a>< T >::size </td> <td>(</td> <td class="paramtype">void </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> </td> </tr> </table> </div><div class="memdoc"> <p>The number of elements in this container. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>include/uhd/types/<a class="el" href="ref__vector_8hpp_source.html">ref_vector.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>