📄 class_easylocal__parameterbox.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>EasyLocal++ Documentation</title>
<link href="local.css" rel="stylesheet" type="text/css">
</head>
<body lang="en">
<table width="100%" border="0">
<tbody>
<tr>
<td colspan="2"><h1 class="nojustify">EasyLocal++ Documentation</h1>
<hr>
</td>
</tr>
<tr>
<td width="30" align="center"> </td>
<td>
<!-- Generated by Doxygen 1.2.5 on Sat Jun 9 18:59:30 2001 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>easylocal::ParameterBox Class Reference</h1><code>#include <<a class="el" href="EasyLocal_h-source.html">EasyLocal.h</a>></code>
<p>
Collaboration diagram for easylocal::ParameterBox:<p><center><img src="class_easylocal__ParameterBox_coll_graph.gif" border="0" usemap="#easylocal::ParameterBox_coll_map" alt="Collaboration graph"></center>
<map name="easylocal::ParameterBox_coll_map">
<area href="class_easylocal__ParameterData.html" shape="rect" coords="0,83,149,101">
<area href="union_easylocal__ValueType.html" shape="rect" coords="11,0,139,19">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_easylocal__ParameterBox-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a0">Put</a> (std::string name, std::string type, <a class="el" href="union_easylocal__ValueType.html">ValueType</a> value)
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a1">Put</a> (std::string name, unsigned long value)
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a2">Put</a> (std::string name, unsigned int value)
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a3">Put</a> (std::string name, double value)
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a4">Get</a> (std::string name, std::string type, <a class="el" href="union_easylocal__ValueType.html">ValueType</a> &value) const
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a5">Get</a> (std::string name, unsigned long &value) const
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a6">Get</a> (std::string name, unsigned int &value) const
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a7">Get</a> (std::string name, double &value) const
<li>void <a class="el" href="class_easylocal__ParameterBox.html#a8">Clear</a> ()
</ul>
<h2>Protected Attributes</h2>
<ul>
<li>std::list<<a class="el" href="class_easylocal__ParameterData.html">ParameterData</a>> <a class="el" href="class_easylocal__ParameterBox.html#n0">parameters</a>
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A paramter box maintains a list of parameters that could be passed to a runner.
<p>
<p>
Definition at line <a class="el" href="EasyLocal_h-source.html#l00462">462</a> of file <a class="el" href="EasyLocal_h-source.html">EasyLocal.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="a8" doxytag="easylocal::ParameterBox::Clear"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void easylocal::ParameterBox::Clear (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Deletes all the parameters stored in the parameter box.
<p>
Definition at line <a class="el" href="EasyLocal_cpp-source.html#l00267">267</a> of file <a class="el" href="EasyLocal_cpp-source.html">EasyLocal.cpp</a>. </td>
</tr>
</table>
<a name="a7" doxytag="easylocal::ParameterBox::Get"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void easylocal::ParameterBox::Get (
</b></td>
<td valign="bottom"><b>
std::string <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
double & <em>value</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the value of a double parameter.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
</td><td>
the name of the parameter to be retrieved </td></tr>
<tr><td valign=top><em>value</em>
</td><td>
the value of the parameter </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="EasyLocal_cpp-source.html#l00251">251</a> of file <a class="el" href="EasyLocal_cpp-source.html">EasyLocal.cpp</a>. </td>
</tr>
</table>
<a name="a6" doxytag="easylocal::ParameterBox::Get"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void easylocal::ParameterBox::Get (
</b></td>
<td valign="bottom"><b>
std::string <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned int & <em>value</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the value of a unsigned int parameter.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
</td><td>
the name of the parameter to be retrieved </td></tr>
<tr><td valign=top><em>value</em>
</td><td>
the value of the parameter </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="EasyLocal_cpp-source.html#l00232">232</a> of file <a class="el" href="EasyLocal_cpp-source.html">EasyLocal.cpp</a>. </td>
</tr>
</table>
<a name="a5" doxytag="easylocal::ParameterBox::Get"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void easylocal::ParameterBox::Get (
</b></td>
<td valign="bottom"><b>
std::string <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned long & <em>value</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the value of a unsigned long parameter.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
</td><td>
the name of the parameter to be retrieved </td></tr>
<tr><td valign=top><em>value</em>
</td><td>
the value of the parameter </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="EasyLocal_cpp-source.html#l00213">213</a> of file <a class="el" href="EasyLocal_cpp-source.html">EasyLocal.cpp</a>. </td>
</tr>
</table>
<a name="a4" doxytag="easylocal::ParameterBox::Get"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void easylocal::ParameterBox::Get (
</b></td>
<td valign="bottom"><b>
std::string <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
std::string <em>type</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="union_easylocal__ValueType.html">ValueType</a> & <em>value</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -