<!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::msg Namespace 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_1msg.html">msg</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ompl::msg Namespace Reference</div> </div>
</div>
<div class="contents">
<p>Message namespace. This contains classes needed to output error messages (or logging) from within the library.
<a href="#details">More...</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_1msg_1_1Interface.html">Interface</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The piece of code that desires interaction with an action or an output handler should use an instance of this class. This class connects to the active <a class="el" href="classompl_1_1msg_1_1OutputHandler.html" title="Generic class to handle output from a piece of code.">OutputHandler</a> (if any) and forwards messages. <a href="classompl_1_1msg_1_1Interface.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1OutputHandler.html">OutputHandler</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic class to handle output from a piece of code. <a href="classompl_1_1msg_1_1OutputHandler.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1OutputHandlerSTD.html">OutputHandlerSTD</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default implementation of <a class="el" href="classompl_1_1msg_1_1OutputHandler.html" title="Generic class to handle output from a piece of code.">OutputHandler</a>. This sends the information to the console. <a href="classompl_1_1msg_1_1OutputHandlerSTD.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1OutputHandlerFile.html">OutputHandlerFile</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementation of <a class="el" href="classompl_1_1msg_1_1OutputHandler.html" title="Generic class to handle output from a piece of code.">OutputHandler</a> that saves messages in a file. <a href="classompl_1_1msg_1_1OutputHandlerFile.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90cbd14492fec0d953082f4ce5721f3c"></a><!-- doxytag: member="ompl::msg::noOutputHandler" ref="a90cbd14492fec0d953082f4ce5721f3c" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceompl_1_1msg.html#a90cbd14492fec0d953082f4ce5721f3c">noOutputHandler</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function instructs ompl that no messages should be outputted. Equivalent to setOutputHandler(NULL) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add51f5be665288ddbb3be7e372b5f31d"></a><!-- doxytag: member="ompl::msg::restorePreviousOutputHandler" ref="add51f5be665288ddbb3be7e372b5f31d" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceompl_1_1msg.html#add51f5be665288ddbb3be7e372b5f31d">restorePreviousOutputHandler</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Restore the output handler that was previously in use (if any) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66fd8fd39855d4166ff40164fe4d9d6b"></a><!-- doxytag: member="ompl::msg::useOutputHandler" ref="a66fd8fd39855d4166ff40164fe4d9d6b" args="(OutputHandler *oh)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceompl_1_1msg.html#a66fd8fd39855d4166ff40164fe4d9d6b">useOutputHandler</a> (<a class="el" href="classompl_1_1msg_1_1OutputHandler.html">OutputHandler</a> *oh)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the instance of the <a class="el" href="classompl_1_1msg_1_1OutputHandler.html" title="Generic class to handle output from a piece of code.">OutputHandler</a> to use. By default, this is <a class="el" href="classompl_1_1msg_1_1OutputHandlerSTD.html" title="Default implementation of OutputHandler. This sends the information to the console.">OutputHandlerSTD</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac32f8f123774d2644538b9ce7ebd24e6"></a><!-- doxytag: member="ompl::msg::getOutputHandler" ref="ac32f8f123774d2644538b9ce7ebd24e6" args="(void)" -->
<a class="el" href="classompl_1_1msg_1_1OutputHandler.html">OutputHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceompl_1_1msg.html#ac32f8f123774d2644538b9ce7ebd24e6">getOutputHandler</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the instance of the <a class="el" href="classompl_1_1msg_1_1OutputHandler.html" title="Generic class to handle output from a piece of code.">OutputHandler</a> currently used. This is NULL in case there is no output handler. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Message namespace. This contains classes needed to output error messages (or logging) from within the library. </p>
</div></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
>
1668
