<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>mrpt::utils::TParameters Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1utils.html">utils</a> </li>
<li class="navelem"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html">TParameters</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">mrpt::utils::TParameters Struct Reference<div class="ingroups"><a class="el" href="group__mrpt__base__grp.html">[mrpt-base]</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::utils::TParameters" --><!-- doxytag: inherits="map< std::string, T >" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>For usage when passing a dynamic number of (numeric) arguments to a function, by name. </p>
<div class="fragment"><pre class="fragment"> TParameters<double> p; <span class="comment">// or TParametersDouble</span>
p[<span class="stringliteral">"v_max"</span>] = 1.0; <span class="comment">// Write</span>
...
cout << p[<span class="stringliteral">"w_max"</span>]; <span class="comment">// Read, even if "p" was const.</span>
</pre></div><p>A default list of parameters can be passed to the constructor as a sequence of pairs "name, value", which MUST end in a NULL name string. Names MUST BE "const char*" (that is, "old plain strings" are OK), not <a class="el" href="classstd_1_1string.html" title="STL class.">std::string</a> objects!. See this example:</p>
<div class="fragment"><pre class="fragment"> TParameters<double> p(<span class="stringliteral">"par1"</span>,2.0, <span class="stringliteral">"par2"</span>,-4.5, <span class="stringliteral">"par3"</span>,9.0, NULL); <span class="comment">// MUST end with a NULL</span>
</pre></div><p><b>VERY IMPORTANT:</b> If you use the NULL-ended constructor above, make sure all the values are of the proper type or it will crash in runtime. For example, in a TParametersDouble all values must be double's, so if you type "10" the compiler will make it an "int". Instead, write "10.0".</p>
<dl class="see"><dt><b>See also:</b></dt><dd>the example in MRPT/samples/params-by-name </dd></dl>
</div>
<p><code>#include <<a class="el" href="_t_parameters_8h_source.html">mrpt/utils/TParameters.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::utils::TParameters:</div>
<div class="dyncontent">
<div class="center"><img src="structmrpt_1_1utils_1_1_t_parameters__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_t_parameters_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1_t_parameters_inherit__map" id="mrpt_1_1utils_1_1_t_parameters_inherit__map">
<area shape="rect" id="node7" href="structmrpt_1_1utils_1_1_t_parameters.html" title="mrpt::utils::TParameters\< double \>" alt="" coords="5,264,229,291"/><area shape="rect" id="node2" href="classstd_1_1map.html" title="std::map\< std::string, T \>" alt="" coords="32,96,203,123"/><area shape="rect" id="node4" href="classstd_1_1map.html" title="STL class." alt="" coords="81,5,153,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="structmrpt_1_1utils_1_1_t_parameters-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">typedef <a class="el" href="classstd_1_1map.html">std::map</a>< <a class="el" href="classstd_1_1string.html">std::string</a>, T > </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#aaa3e460b0bcbf1a7288bdbc37179688d">BASE</a></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a437c0f304145a2629ab42dbaf91b3390">TParameters</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor (initializes empty) <a href="#a437c0f304145a2629ab42dbaf91b3390"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a63e540638c71d87217b496b910a12894">TParameters</a> (const char *nam1,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor with a list of initial values (see the description and use example in <a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html" title="For usage when passing a dynamic number of (numeric) arguments to a function, by name.">mrpt::utils::TParameters</a>) <a href="#a63e540638c71d87217b496b910a12894"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a77a1cbc7e2a4a565ac49e8f0403eff1c">has</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a8c8b755b7848fd23bdca395b527bfd25">operator[]</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A const version of the [] operator, for usage as read-only. <a href="#a8c8b755b7848fd23bdca395b527bfd25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#ae3c017856eca006e9b60a55f037e5e76">getWithDefaultVal</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s, const T &defaultVal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A const version of the [] operator and with a default value in case the parameter is not set (for usage as read-only). <a href="#ae3c017856eca006e9b60a55f037e5e76"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a12668850c281c3695bd120880e420171">operator[]</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The write (non-const) version of the [] operator. <a href="#a12668850c281c3695bd120880e420171"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#ab0809883b3ce420fbbcff847e18b92bb">dumpToConsole</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dumps to console the output from <a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a4e72b6c660a030a6baf7b334e28515ca" title="Returns a multi-like string representation of the parameters like : 'nam = val = val2...'.">getAsString()</a> <a href="#ab0809883b3ce420fbbcff847e18b92bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a4e72b6c660a030a6baf7b334e28515ca">getAsString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a multi-like string representation of the parameters like : 'nam = val = val2...'. <a href="#a4e72b6c660a030a6baf7b334e28515ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a9da58d442d9b0d54e2330d2cfb159a67">getAsString</a> (<a class="el" href="classstd_1_1string.html">std::string</a> &s) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a multi-like string representation of the parameters like : 'nam = val = val2...'. <a href="#a9da58d442d9b0d54e2330d2cfb159a67"></a><br/></td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="aaa3e460b0bcbf1a7288bdbc37179688d"></a><!-- doxytag: member="mrpt::utils::TParameters::BASE" ref="aaa3e460b0bcbf1a7288bdbc37179688d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classstd_1_1map.html">std::map</a><<a class="el" href="classstd_1_1string.html">std::string</a>,T> <a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#aaa3e460b0bcbf1a7288bdbc37179688d">mrpt::utils::TParameters::BASE</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00066">66</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a437c0f304145a2629ab42dbaf91b3390"></a><!-- doxytag: member="mrpt::utils::TParameters::TParameters" ref="a437c0f304145a2629ab42dbaf91b3390" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::TParameters::TParameters </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor (initializes empty) </p>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00068">68</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
</div>
</div>
<a class="anchor" id="a63e540638c71d87217b496b910a12894"></a><!-- doxytag: member="mrpt::utils::TParameters::TParameters" ref="a63e540638c71d87217b496b910a12894" args="(const char *nam1,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::TParameters::TParameters </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>nam1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor with a list of initial values (see the description and use example in <a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html" title="For usage when passing a dynamic number of (numeric) arguments to a function, by name.">mrpt::utils::TParameters</a>) </p>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00070">70</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab0809883b3ce420fbbcff847e18b92bb"></a><!-- doxytag: member="mrpt::utils::TParameters::dumpToConsole" ref="ab0809883b3ce420fbbcff847e18b92bb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::TParameters::dumpToConsole </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dumps to console the output from <a class="el" href="structmrpt_1_1utils_1_1_t_parameters.html#a4e72b6c660a030a6baf7b334e28515ca" title="Returns a multi-like string representation of the parameters like : 'nam = val = val2...'.">getAsString()</a> </p>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00111">111</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4e72b6c660a030a6baf7b334e28515ca"></a><!-- doxytag: member="mrpt::utils::TParameters::getAsString" ref="a4e72b6c660a030a6baf7b334e28515ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> mrpt::utils::TParameters::getAsString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a multi-like string representation of the parameters like : 'nam = val = val2...'. </p>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00114">114</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
<p>Referenced by <a class="el" href="_t_parameters_8h_source.html#l00111">mrpt::utils::TParameters< double >::dumpToConsole()</a>, and <a class="el" href="_t_parameters_8h_source.html#l00114">mrpt::utils::TParameters< double >::getAsString()</a>.</p>
</div>
</div>
<a class="anchor" id="a9da58d442d9b0d54e2330d2cfb159a67"></a><!-- doxytag: member="mrpt::utils::TParameters::getAsString" ref="a9da58d442d9b0d54e2330d2cfb159a67" args="(std::string &s) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::TParameters::getAsString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a multi-like string representation of the parameters like : 'nam = val = val2...'. </p>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00117">117</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae3c017856eca006e9b60a55f037e5e76"></a><!-- doxytag: member="mrpt::utils::TParameters::getWithDefaultVal" ref="ae3c017856eca006e9b60a55f037e5e76" args="(const std::string &s, const T &defaultVal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T mrpt::utils::TParameters::getWithDefaultVal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>defaultVal</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A const version of the [] operator and with a default value in case the parameter is not set (for usage as read-only). </p>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00101">101</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
<p>Referenced by <a class="el" href="graph__tools__impl_8h_source.html#l00038">mrpt::opengl::graph_tools::graph_visualize()</a>.</p>
</div>
</div>
<a class="anchor" id="a77a1cbc7e2a4a565ac49e8f0403eff1c"></a><!-- doxytag: member="mrpt::utils::TParameters::has" ref="a77a1cbc7e2a4a565ac49e8f0403eff1c" args="(const std::string &s) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::TParameters::has </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00089">89</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8c8b755b7848fd23bdca395b527bfd25"></a><!-- doxytag: member="mrpt::utils::TParameters::operator[]" ref="a8c8b755b7848fd23bdca395b527bfd25" args="(const std::string &s) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T mrpt::utils::TParameters::operator[] </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A const version of the [] operator, for usage as read-only. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classstd_1_1logic__error.html" title="STL class.">std::logic_error</a></td><td>On parameter not present. Please, check existence with "has" before reading. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00093">93</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
<p>Referenced by <a class="el" href="_t_parameters_8h_source.html#l00070">mrpt::utils::TParameters< double >::TParameters()</a>, and <a class="el" href="_t_parameters_8h_source.html#l00108">mrpt::utils::TParameters< double >::operator[]()</a>.</p>
</div>
</div>
<a class="anchor" id="a12668850c281c3695bd120880e420171"></a><!-- doxytag: member="mrpt::utils::TParameters::operator[]" ref="a12668850c281c3695bd120880e420171" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T& mrpt::utils::TParameters::operator[] </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The write (non-const) version of the [] operator. </p>
<p>Definition at line <a class="el" href="_t_parameters_8h_source.html#l00108">108</a> of file <a class="el" href="_t_parameters_8h_source.html">TParameters.h</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
