<!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::CompoundState 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_1base.html">base</a> </li>
<li class="navelem"><a class="el" href="classompl_1_1base_1_1CompoundState.html">CompoundState</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<div class="title">ompl::base::CompoundState Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::base::CompoundState" --><!-- doxytag: inherits="ompl::base::State" -->
<p>Definition of a compound state.
<a href="classompl_1_1base_1_1CompoundState.html#details">More...</a></p>
<p><code>#include <<a class="el" href="State_8h_source.html">State.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ompl::base::CompoundState:</div>
<div class="dyncontent">
<div class="center"><img src="classompl_1_1base_1_1CompoundState__inherit__graph.png" border="0" usemap="#ompl_1_1base_1_1CompoundState_inherit__map" alt="Inheritance graph"/></div>
<map name="ompl_1_1base_1_1CompoundState_inherit__map" id="ompl_1_1base_1_1CompoundState_inherit__map">
<area shape="rect" id="node5" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html" title="A state in SE(2): (x, y, yaw)" alt="" coords="425,5,679,35"/><area shape="rect" id="node7" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html" title="A state in SE(3): position = (x, y, z), quaternion = (x, y, z, w)" alt="" coords="425,59,679,88"/><area shape="rect" id="node9" href="classompl_1_1control_1_1ODEStateSpace_1_1StateType.html" title="ODE State. This is a compound state that allows accessing the properties of the bodies the state spac..." alt="" coords="417,112,687,141"/><area shape="rect" id="node2" href="classompl_1_1base_1_1State.html" title="Definition of an abstract state." alt="" coords="5,59,131,88"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classompl_1_1base_1_1CompoundState-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">const T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1CompoundState.html#ae51035c1a4c69165f2688d252b527ba7">as</a> (const unsigned int index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast a component of this instance to a desired type. <a href="#ae51035c1a4c69165f2688d252b527ba7"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1CompoundState.html#a8954043a8c8fc71031ffa3a98661b017">as</a> (const unsigned int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast a component of this instance to a desired type. <a href="#a8954043a8c8fc71031ffa3a98661b017"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52828af183d2b29bcf6e19dd4d501fe8"></a><!-- doxytag: member="ompl::base::CompoundState::operator[]" ref="a52828af183d2b29bcf6e19dd4d501fe8" args="(unsigned int i) const " -->
<a class="el" href="classompl_1_1base_1_1State.html">State</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1CompoundState.html#a52828af183d2b29bcf6e19dd4d501fe8">operator[]</a> (unsigned int i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access element i<sup>th</sup> component. This does not check whether the index is within bounds. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbfb1f1ff3d5eb2315f47c13fc79a86e"></a><!-- doxytag: member="ompl::base::CompoundState::components" ref="acbfb1f1ff3d5eb2315f47c13fc79a86e" args="" -->
<a class="el" href="classompl_1_1base_1_1State.html">State</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1CompoundState.html#acbfb1f1ff3d5eb2315f47c13fc79a86e">components</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The components that make up a compound state. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Definition of a compound state. </p>
<p>Definition at line <a class="el" href="State_8h_source.html#l00095">95</a> of file <a class="el" href="State_8h_source.html">State.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae51035c1a4c69165f2688d252b527ba7"></a><!-- doxytag: member="ompl::base::CompoundState::as" ref="ae51035c1a4c69165f2688d252b527ba7" args="(const unsigned int index) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">const T* ompl::base::CompoundState::as </td>
<td>(</td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cast a component of this instance to a desired type. </p>
<p><p>Make sure the type we are allocating is indeed a state </p>
</p>
<p>Definition at line <a class="el" href="State_8h_source.html#l00109">109</a> of file <a class="el" href="State_8h_source.html">State.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8954043a8c8fc71031ffa3a98661b017"></a><!-- doxytag: member="ompl::base::CompoundState::as" ref="a8954043a8c8fc71031ffa3a98661b017" args="(const unsigned int index)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* ompl::base::CompoundState::as </td>
<td>(</td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cast a component of this instance to a desired type. </p>
<p><p>Make sure the type we are allocating is indeed a state </p>
</p>
<p>Definition at line <a class="el" href="State_8h_source.html#l00119">119</a> of file <a class="el" href="State_8h_source.html">State.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/ompl/base/<a class="el" href="State_8h_source.html">State.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:31 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div>
</div>
</div>
</body>
</html>
