<!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::control::RealVectorControlSpace Class 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_1control.html">control</a> </li>
<li class="navelem"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html">RealVectorControlSpace</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">ompl::control::RealVectorControlSpace Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::control::RealVectorControlSpace" --><!-- doxytag: inherits="ompl::control::ControlSpace" -->
<p>A control space representing R<sup>n</sup>. The distance function is the L2 norm.
<a href="classompl_1_1control_1_1RealVectorControlSpace.html#details">More...</a></p>
<p><code>#include <<a class="el" href="RealVectorControlSpace_8h_source.html">RealVectorControlSpace.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ompl::control::RealVectorControlSpace:</div>
<div class="dyncontent">
<div class="center"><img src="classompl_1_1control_1_1RealVectorControlSpace__inherit__graph.png" border="0" usemap="#ompl_1_1control_1_1RealVectorControlSpace_inherit__map" alt="Inheritance graph"/></div>
<map name="ompl_1_1control_1_1RealVectorControlSpace_inherit__map" id="ompl_1_1control_1_1RealVectorControlSpace_inherit__map">
<area shape="rect" id="node5" href="classompl_1_1control_1_1ODEControlSpace.html" title="Representation of controls applied in ODE environments. This is an array of double values..." alt="" coords="23,160,236,189"/><area shape="rect" id="node2" href="classompl_1_1control_1_1ControlSpace.html" title="A control space representing the space of applicable controls." alt="" coords="37,5,221,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classompl_1_1control_1_1RealVectorControlSpace-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace_1_1ControlType.html">ControlType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The definition of a control in R<sup>n</sup> <a href="classompl_1_1control_1_1RealVectorControlSpace_1_1ControlType.html#details">More...</a><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="a0bacd31455e2745eb5efd291210482a8"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::RealVectorControlSpace" ref="a0bacd31455e2745eb5efd291210482a8" args="(const base::StateSpacePtr &stateSpace, unsigned int dim)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a0bacd31455e2745eb5efd291210482a8">RealVectorControlSpace</a> (const <a class="el" href="classompl_1_1base_1_1StateSpacePtr.html">base::StateSpacePtr</a> &stateSpace, unsigned int dim)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor takes the state space the controls correspond to and the dimension of the space of controls, <em>dim</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab21eee94cc69d207ab578b69a423660c"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::setBounds" ref="ab21eee94cc69d207ab578b69a423660c" args="(const base::RealVectorBounds &bounds)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#ab21eee94cc69d207ab578b69a423660c">setBounds</a> (const <a class="el" href="classompl_1_1base_1_1RealVectorBounds.html">base::RealVectorBounds</a> &bounds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the bounds (min max values for each dimension) for the control. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d702054b347a53b7d0565baaf62d1e1"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::getBounds" ref="a1d702054b347a53b7d0565baaf62d1e1" args="(void) const " -->
const <a class="el" href="classompl_1_1base_1_1RealVectorBounds.html">base::RealVectorBounds</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a1d702054b347a53b7d0565baaf62d1e1">getBounds</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounds (min max values for each dimension) for the control. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3867333250717f53618542f344557ba"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::getDimension" ref="aa3867333250717f53618542f344557ba" args="(void) const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#aa3867333250717f53618542f344557ba">getDimension</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the dimension of this control space. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ab9e55d9332c2e6609f706ab90e3676"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::copyControl" ref="a4ab9e55d9332c2e6609f706ab90e3676" args="(Control *destination, const Control *source) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a4ab9e55d9332c2e6609f706ab90e3676">copyControl</a> (<a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *destination, const <a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *source) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy a control to another. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44f0c2bff20cc1704f4c66a975339340"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::equalControls" ref="a44f0c2bff20cc1704f4c66a975339340" args="(const Control *control1, const Control *control2) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a44f0c2bff20cc1704f4c66a975339340">equalControls</a> (const <a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *control1, const <a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *control2) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if two controls are the same. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9d6cdfc86837c785d1ae28c882c5eca"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::allocControlSampler" ref="ad9d6cdfc86837c785d1ae28c882c5eca" args="(void) const " -->
virtual <a class="el" href="classompl_1_1control_1_1ControlSamplerPtr.html">ControlSamplerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#ad9d6cdfc86837c785d1ae28c882c5eca">allocControlSampler</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a control sampler. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a354fdf75df038f1464c14c20d2844d47"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::allocControl" ref="a354fdf75df038f1464c14c20d2844d47" args="(void) const " -->
virtual <a class="el" href="classompl_1_1control_1_1Control.html">Control</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a354fdf75df038f1464c14c20d2844d47">allocControl</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate memory for a control. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a700733ab5a157781fee992511ffd6d91"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::freeControl" ref="a700733ab5a157781fee992511ffd6d91" args="(Control *control) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a700733ab5a157781fee992511ffd6d91">freeControl</a> (<a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *control) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the memory of a control. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4d4f0c7d37c7a7118cd2bee1ed4f435"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::nullControl" ref="aa4d4f0c7d37c7a7118cd2bee1ed4f435" args="(Control *control) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#aa4d4f0c7d37c7a7118cd2bee1ed4f435">nullControl</a> (<a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *control) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Make the control have no effect if it were to be applied to a state for any amount of time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5ed085564053a3ac9acb4f31eacef65"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::printControl" ref="ab5ed085564053a3ac9acb4f31eacef65" args="(const Control *control, std::ostream &out) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#ab5ed085564053a3ac9acb4f31eacef65">printControl</a> (const <a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *control, std::ostream &out) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a control to a stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0404c9dabcb7b26ebfc241855d0b40c"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::getValueAddressAtIndex" ref="ad0404c9dabcb7b26ebfc241855d0b40c" args="(Control *control, const unsigned int index) const " -->
virtual double * </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#ad0404c9dabcb7b26ebfc241855d0b40c">getValueAddressAtIndex</a> (<a class="el" href="classompl_1_1control_1_1Control.html">Control</a> *control, const unsigned int index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Many controls contain a number of double values. This function provides a means to get the memory address of a double value from a control <em>control</em> located at position <em>index</em>. The first double value is returned for <em>index</em> = 0. If <em>index</em> is too large (does not point to any double values in the control), the return value is NULL. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a328ae638e5b1fc2103eaf47231f0bf4d"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::printSettings" ref="a328ae638e5b1fc2103eaf47231f0bf4d" args="(std::ostream &out) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a328ae638e5b1fc2103eaf47231f0bf4d">printSettings</a> (std::ostream &out) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the settings for this control space to a stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32231228057f9acaed7a3f46f3052093"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::setup" ref="a32231228057f9acaed7a3f46f3052093" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a32231228057f9acaed7a3f46f3052093">setup</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform final setup steps. This function is automatically called by the <a class="el" href="classompl_1_1control_1_1SpaceInformation.html" title="Space information containing necessary information for planning with controls. setup() needs to be ca...">SpaceInformation</a>. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a176e9568fbe1c7fd557e8890360d7be9"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::dimension_" ref="a176e9568fbe1c7fd557e8890360d7be9" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#a176e9568fbe1c7fd557e8890360d7be9">dimension_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The dimension of the state space. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2f518294c75aab253d63237605bf9ff"></a><!-- doxytag: member="ompl::control::RealVectorControlSpace::bounds_" ref="aa2f518294c75aab253d63237605bf9ff" args="" -->
<a class="el" href="classompl_1_1base_1_1RealVectorBounds.html">base::RealVectorBounds</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1control_1_1RealVectorControlSpace.html#aa2f518294c75aab253d63237605bf9ff">bounds_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The bounds on controls. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A control space representing R<sup>n</sup>. The distance function is the L2 norm. </p>
<p>Definition at line <a class="el" href="RealVectorControlSpace_8h_source.html#l00063">63</a> of file <a class="el" href="RealVectorControlSpace_8h_source.html">RealVectorControlSpace.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>src/ompl/control/spaces/<a class="el" href="RealVectorControlSpace_8h_source.html">RealVectorControlSpace.h</a></li>
<li>src/ompl/control/spaces/src/<a class="el" href="RealVectorControlSpace_8cpp_source.html">RealVectorControlSpace.cpp</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:43 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
e7618febbb9cbed15bb79e326774c050
>
files
>
748
