<!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"/> <title>OMPL: ompl::base::StateSamplerArray< T > Class Template Reference</title> <meta name="author" content="Ioan A. Șucan, Mark Moll, Lydia E. Kavraki"> <link rel="stylesheet" href="../css/screen.css" type="text/css" media="screen, projection"> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print"> <!--[if lt IE 7]> <script type="text/javascript" src="../js/jquery/jquery.js"></script> <script type="text/javascript" src="../js/jquery/jquery.dropdown.js"></script> <![endif]--> <script type="text/javaScript" src="search/search.js"></script> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-9156598-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> </head> <body onload='searchBox.OnSelectItem(0);'> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search API'); --></script> <div class="navigation" id="top"> <div class="tabs" id="ompltitle"> <ul class="tablist"> <li>The Open Motion Planning Library</li> <li id="searchli"> <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 API" 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> <ul id="nav" class="dropdown"> <li class="first"><a href="index.html">Home</a></li> <li><a href="download.html">Download</a></li> <li><a href="documentation.html">Documentation</a></li> <li><span class="dir">Code API</span> <ul> <li><a href="api_overview.html">API Overview</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="annotated.html">Classes</a></li> <li><a href="files.html">Files</a></li> <li><a href="dirs.html">Directories</a></li> </ul> </li> <li><span class="dir">Community</span> <ul> <li><a href="developers.html">Developers</a></li> <li><a href="thirdparty.html">Contributions</a></li> <li><a href="education.html">Education</a></li> <li><a href="gallery.html">Gallery</a></li> </ul> </li> <li><span class="dir">About</span> <ul> <li><a href="license.html">License</a></li> <li><a href="citations.html">Citations</a></li> <li><a href="acknowledgements.html">Acknowledgments</a></li> <li><a href="contact.html">Contact Us</a></li> </ul> </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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0"name="MSearchResults" id="MSearchResults"></iframe> </div> <div class="container"> <div class="span-22 push-2 first last"> <div> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceompl.html">ompl</a> </li> <li class="navelem"><a class="el" href="namespaceompl_1_1base.html">base</a> </li> <li class="navelem"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html">StateSamplerArray</a> </li> </ul> </div> </div> <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">ompl::base::StateSamplerArray< T > Class Template Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="ompl::base::StateSamplerArray" --> <p>Class to ease the creation of a set of samplers. This is especially useful for multi-threaded planners. <a href="classompl_1_1base_1_1StateSamplerArray.html#details">More...</a></p> <p><code>#include <<a class="el" href="StateSamplerArray_8h_source.html">StateSamplerArray.h</a>></code></p> <p><a href="classompl_1_1base_1_1StateSamplerArray-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0869da074058c67fb600d355c0d8a9c4"></a><!-- doxytag: member="ompl::base::StateSamplerArray::SamplerPtr" ref="a0869da074058c67fb600d355c0d8a9c4" args="" --> typedef <a class="el" href="structompl_1_1base_1_1SamplerSelector.html">SamplerSelector</a>< T ><br class="typebreak"/> ::<a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a0869da074058c67fb600d355c0d8a9c4">SamplerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a0869da074058c67fb600d355c0d8a9c4">SamplerPtr</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the type of sampler allocated. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a975d4bc341acf6116a94fdc6f050cc01"></a><!-- doxytag: member="ompl::base::StateSamplerArray::Sampler" ref="a975d4bc341acf6116a94fdc6f050cc01" args="" --> typedef <a class="el" href="structompl_1_1base_1_1SamplerSelector.html">SamplerSelector</a>< T ><br class="typebreak"/> ::<a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a975d4bc341acf6116a94fdc6f050cc01">Sampler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a975d4bc341acf6116a94fdc6f050cc01">Sampler</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The type of sampler allocated. <br/></td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d9c7fc2ef129b81f4f4b350b4c1faf8"></a><!-- doxytag: member="ompl::base::StateSamplerArray::StateSamplerArray" ref="a5d9c7fc2ef129b81f4f4b350b4c1faf8" args="(const SpaceInformationPtr &si)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a5d9c7fc2ef129b81f4f4b350b4c1faf8">StateSamplerArray</a> (const <a class="el" href="classompl_1_1base_1_1SpaceInformationPtr.html">SpaceInformationPtr</a> &si)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b2695cf7992fe63c9364b7df8ef18d3"></a><!-- doxytag: member="ompl::base::StateSamplerArray::StateSamplerArray" ref="a4b2695cf7992fe63c9364b7df8ef18d3" args="(const SpaceInformation *si)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a4b2695cf7992fe63c9364b7df8ef18d3">StateSamplerArray</a> (const <a class="el" href="classompl_1_1base_1_1SpaceInformation.html">SpaceInformation</a> *si)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9712328ee4ac70eb5477a97e67213bb1"></a><!-- doxytag: member="ompl::base::StateSamplerArray::operator[]" ref="a9712328ee4ac70eb5477a97e67213bb1" args="(std::size_t index) const " --> <a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a975d4bc341acf6116a94fdc6f050cc01">Sampler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a9712328ee4ac70eb5477a97e67213bb1">operator[]</a> (std::size_t index) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Access operator for a specific sampler. For performance reasons, the bounds are not checked. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee87211c80826b2fddf610bf213f0a9e"></a><!-- doxytag: member="ompl::base::StateSamplerArray::resize" ref="aee87211c80826b2fddf610bf213f0a9e" args="(std::size_t count)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#aee87211c80826b2fddf610bf213f0a9e">resize</a> (std::size_t count)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create or release some state samplers. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fcdcd7356483c19fa57218f1d490d29"></a><!-- doxytag: member="ompl::base::StateSamplerArray::size" ref="a8fcdcd7356483c19fa57218f1d490d29" args="(void) const " --> std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a8fcdcd7356483c19fa57218f1d490d29">size</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the count of samplers currently available. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bd5853897252edd44fc958542cc71f1"></a><!-- doxytag: member="ompl::base::StateSamplerArray::clear" ref="a1bd5853897252edd44fc958542cc71f1" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1StateSamplerArray.html#a1bd5853897252edd44fc958542cc71f1">clear</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all allocated samplers. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><h3>template<typename T><br/> class ompl::base::StateSamplerArray< T ></h3> <p>Class to ease the creation of a set of samplers. This is especially useful for multi-threaded planners. </p> <p>Definition at line <a class="el" href="StateSamplerArray_8h_source.html#l00088">88</a> of file <a class="el" href="StateSamplerArray_8h_source.html">StateSamplerArray.h</a>.</p> </div><hr/>The documentation for this class was generated from the following file:<ul> <li>src/ompl/base/<a class="el" href="StateSamplerArray_8h_source.html">StateSamplerArray.h</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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</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> <div class="footer span-22 push-2 last"> <a href="http://www.kavrakilab.org">Physical and Biological Computing Group</a> • <a href="http://www.cs.rice.edu">Department of Computer Science</a> • <a href="http://www.rice.edu">Rice University</a><br> <div class="gray">Generated on Sun Oct 9 2011 23:04:42 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div> </div> </div> </body> </html>