<!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::Interface 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_1msg.html">msg</a> </li>
<li class="navelem"><a class="el" href="classompl_1_1msg_1_1Interface.html">Interface</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">ompl::msg::Interface Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::msg::Interface" -->
<p>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></p>
<p><code>#include <<a class="el" href="Console_8h_source.html">Console.h</a>></code></p>
<p><a href="classompl_1_1msg_1_1Interface-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="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f325616b8f360a624fbdea93dc5bb61"></a><!-- doxytag: member="ompl::msg::Interface::Interface" ref="a7f325616b8f360a624fbdea93dc5bb61" args="(const std::string &prefix="")" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a7f325616b8f360a624fbdea93dc5bb61">Interface</a> (const std::string &prefix="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The text that will appear in front of every message forwarded by this <a class="el" href="classompl_1_1msg_1_1Interface.html" title="The piece of code that desires interaction with an action or an output handler should use an instance...">Interface</a> instance can be optionally set as a constructor argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4dd5a3d384aa0cc95d86d258dea0e773"></a><!-- doxytag: member="ompl::msg::Interface::setPrefix" ref="a4dd5a3d384aa0cc95d86d258dea0e773" args="(const std::string &prefix)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a4dd5a3d384aa0cc95d86d258dea0e773">setPrefix</a> (const std::string &prefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the text that will appear in front of every message forwarded by this <a class="el" href="classompl_1_1msg_1_1Interface.html" title="The piece of code that desires interaction with an action or an output handler should use an instance...">Interface</a> instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d93430824c4e4bc1bab80c6648b908b"></a><!-- doxytag: member="ompl::msg::Interface::getPrefix" ref="a4d93430824c4e4bc1bab80c6648b908b" args="(void) const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a4d93430824c4e4bc1bab80c6648b908b">getPrefix</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the text that appears in front of every forwarded message. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a545368346a008e4de3ea44ce21daccd5"></a><!-- doxytag: member="ompl::msg::Interface::inform" ref="a545368346a008e4de3ea44ce21daccd5" args="(const std::string &text) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a545368346a008e4de3ea44ce21daccd5">inform</a> (const std::string &text) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward information. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15876ea668c0bf423cc416d96526fa18"></a><!-- doxytag: member="ompl::msg::Interface::warn" ref="a15876ea668c0bf423cc416d96526fa18" args="(const std::string &text) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a15876ea668c0bf423cc416d96526fa18">warn</a> (const std::string &text) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward a warning. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9c7d9a3fd8a6358e6d8e27c73a52575"></a><!-- doxytag: member="ompl::msg::Interface::error" ref="ab9c7d9a3fd8a6358e6d8e27c73a52575" args="(const std::string &text) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#ab9c7d9a3fd8a6358e6d8e27c73a52575">error</a> (const std::string &text) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward an error. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad690e77cfd4c31b55cd221ed9c8ee94e"></a><!-- doxytag: member="ompl::msg::Interface::debug" ref="ad690e77cfd4c31b55cd221ed9c8ee94e" args="(const std::string &text) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#ad690e77cfd4c31b55cd221ed9c8ee94e">debug</a> (const std::string &text) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward a debug message. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f39f245bd2cb40362c85f416004db3e"></a><!-- doxytag: member="ompl::msg::Interface::inform" ref="a1f39f245bd2cb40362c85f416004db3e" args="(const char *msg,...) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a1f39f245bd2cb40362c85f416004db3e">inform</a> (const char *msg,...) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward information. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b828cfba790e44810784dc1ef1cb0a1"></a><!-- doxytag: member="ompl::msg::Interface::warn" ref="a3b828cfba790e44810784dc1ef1cb0a1" args="(const char *msg,...) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a3b828cfba790e44810784dc1ef1cb0a1">warn</a> (const char *msg,...) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward a warning. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb1538566045b21a29d1451416a22e53"></a><!-- doxytag: member="ompl::msg::Interface::error" ref="acb1538566045b21a29d1451416a22e53" args="(const char *msg,...) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#acb1538566045b21a29d1451416a22e53">error</a> (const char *msg,...) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward an error. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09d30f9199fd238fbee9cdc355c4174b"></a><!-- doxytag: member="ompl::msg::Interface::debug" ref="a09d30f9199fd238fbee9cdc355c4174b" args="(const char *msg,...) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a09d30f9199fd238fbee9cdc355c4174b">debug</a> (const char *msg,...) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward a debug message. <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="a3e2cf4cb57b18c547b03f1e8da24cf67"></a><!-- doxytag: member="ompl::msg::Interface::prefix_" ref="a3e2cf4cb57b18c547b03f1e8da24cf67" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1msg_1_1Interface.html#a3e2cf4cb57b18c547b03f1e8da24cf67">prefix_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The string that appears in front of very forwarded message. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>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. </p>
<p>Definition at line <a class="el" href="Console_8h_source.html#l00055">55</a> of file <a class="el" href="Console_8h_source.html">Console.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>src/ompl/util/<a class="el" href="Console_8h_source.html">Console.h</a></li>
<li>src/ompl/util/src/<a class="el" href="Console_8cpp_source.html">Console.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:32 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div>
</div>
</div>
</body>
</html>
