You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

243 lines
19 KiB

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Pin: LEVEL_BASE::KNOBVALUE&lt; TYPE &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Pin
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceLEVEL__BASE.html">LEVEL_BASE</a></li><li class="navelem"><a class="el" href="classLEVEL__BASE_1_1KNOBVALUE.html">KNOBVALUE</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classLEVEL__BASE_1_1KNOBVALUE-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LEVEL_BASE::KNOBVALUE&lt; TYPE &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__KNOB__API.html">KNOB: Commandline Option Handling</a> &raquo; <a class="el" href="group__KNOB__BASIC.html">KNOB: Basics</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af47b5363d2b75bfb7825c1f6c6be02f2"><td class="memItemLeft" align="right" valign="top"><a id="af47b5363d2b75bfb7825c1f6c6be02f2"></a>
STATIC TYPE&#160;</td><td class="memItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:af47b5363d2b75bfb7825c1f6c6be02f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb8bf6c355071fd068f24b6debf7fcc6"><td class="memItemLeft" align="right" valign="top"><a id="aeb8bf6c355071fd068f24b6debf7fcc6"></a>
STATIC std::string&#160;</td><td class="memItemRight" valign="bottom"><b>ToString</b> (const TYPE &amp;value, const std::string &amp;origString)</td></tr>
<tr class="separator:aeb8bf6c355071fd068f24b6debf7fcc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae17611d21926a434d023499f645f7286"><td class="memItemLeft" align="right" valign="top"><a id="ae17611d21926a434d023499f645f7286"></a>
STATIC TYPE&#160;</td><td class="memItemRight" valign="bottom"><b>Accumulate</b> (TYPE &amp;lVal, const TYPE &amp;rVal)</td></tr>
<tr class="separator:ae17611d21926a434d023499f645f7286"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade083d4e51caf6de943e279fa39e9bfd"><td class="memItemLeft" align="right" valign="top"><a id="ade083d4e51caf6de943e279fa39e9bfd"></a>
STATIC const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:ade083d4e51caf6de943e279fa39e9bfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b5486f4767ab8c497e9ef1cedb7216b"><td class="memItemLeft" align="right" valign="top"><a id="a0b5486f4767ab8c497e9ef1cedb7216b"></a>
const TYPE &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Value</b> () const</td></tr>
<tr class="separator:a0b5486f4767ab8c497e9ef1cedb7216b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52c61a89c11c2ad63def3da73d05fdc8"><td class="memItemLeft" align="right" valign="top"><a id="a52c61a89c11c2ad63def3da73d05fdc8"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>ValueString</b> () const</td></tr>
<tr class="separator:a52c61a89c11c2ad63def3da73d05fdc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03c1e32ee2a8cbaeab9246c77aaa3473"><td class="memItemLeft" align="right" valign="top"><a id="a03c1e32ee2a8cbaeab9246c77aaa3473"></a>
<a class="el" href="classLEVEL__BASE_1_1KNOBVALUE.html">KNOBVALUE</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>Next</b> () const</td></tr>
<tr class="separator:a03c1e32ee2a8cbaeab9246c77aaa3473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae8cf13d80bba1d4253e9c9211841c75"><td class="memItemLeft" align="right" valign="top"><a id="aae8cf13d80bba1d4253e9c9211841c75"></a>
VOID&#160;</td><td class="memItemRight" valign="bottom"><b>Overwrite</b> (const std::string &amp;valstring)</td></tr>
<tr class="separator:aae8cf13d80bba1d4253e9c9211841c75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7475b983200b26f3294fed8c9c7ad589"><td class="memItemLeft" align="right" valign="top"><a id="a7475b983200b26f3294fed8c9c7ad589"></a>
VOID&#160;</td><td class="memItemRight" valign="bottom"><b>Accumulate</b> (const std::string &amp;valstring)</td></tr>
<tr class="separator:a7475b983200b26f3294fed8c9c7ad589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad99a7e687b160e396c77532e04159f28"><td class="memItemLeft" align="right" valign="top"><a id="ad99a7e687b160e396c77532e04159f28"></a>
VOID&#160;</td><td class="memItemRight" valign="bottom"><b>Append</b> (<a class="el" href="classLEVEL__BASE_1_1KNOBVALUE.html">KNOBVALUE</a> *next)</td></tr>
<tr class="separator:ad99a7e687b160e396c77532e04159f28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af92530c6c4187f0d4e6278384022ea7c"><td class="memTemplParams" colspan="2">template&lt;&gt; </td></tr>
<tr class="memitem:af92530c6c4187f0d4e6278384022ea7c"><td class="memTemplItemLeft" align="right" valign="top">GLOBALTEMPLATEFUN BOOL&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classLEVEL__BASE_1_1KNOBVALUE.html#af92530c6c4187f0d4e6278384022ea7c">Accumulate</a> (BOOL &amp;lVal, const BOOL &amp;rVal)</td></tr>
<tr class="separator:af92530c6c4187f0d4e6278384022ea7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92665c18f6d3b4a7a62b591b703a960b"><td class="memTemplParams" colspan="2"><a id="a92665c18f6d3b4a7a62b591b703a960b"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a92665c18f6d3b4a7a62b591b703a960b"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:a92665c18f6d3b4a7a62b591b703a960b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d6cd6b14f4cf36cd168ea72793039bb"><td class="memTemplParams" colspan="2"><a id="a0d6cd6b14f4cf36cd168ea72793039bb"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a0d6cd6b14f4cf36cd168ea72793039bb"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a0d6cd6b14f4cf36cd168ea72793039bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2805784ce3d377095cead4488d2354bc"><td class="memTemplParams" colspan="2"><a id="a2805784ce3d377095cead4488d2354bc"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a2805784ce3d377095cead4488d2354bc"><td class="memTemplItemLeft" align="right" valign="top">BOOL&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:a2805784ce3d377095cead4488d2354bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c5a6094609151afce6c0da0072fb691"><td class="memTemplParams" colspan="2"><a id="a2c5a6094609151afce6c0da0072fb691"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a2c5a6094609151afce6c0da0072fb691"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a2c5a6094609151afce6c0da0072fb691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa707b6980a0d5ad6046c586761de48cd"><td class="memTemplParams" colspan="2"><a id="aa707b6980a0d5ad6046c586761de48cd"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:aa707b6980a0d5ad6046c586761de48cd"><td class="memTemplItemLeft" align="right" valign="top">UINT32&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:aa707b6980a0d5ad6046c586761de48cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab37d59e37d67df6f92ff6335aaa0665d"><td class="memTemplParams" colspan="2"><a id="ab37d59e37d67df6f92ff6335aaa0665d"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ab37d59e37d67df6f92ff6335aaa0665d"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:ab37d59e37d67df6f92ff6335aaa0665d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d1d149306619a7e57985229e6fcdac5"><td class="memTemplParams" colspan="2"><a id="a1d1d149306619a7e57985229e6fcdac5"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a1d1d149306619a7e57985229e6fcdac5"><td class="memTemplItemLeft" align="right" valign="top">INT32&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:a1d1d149306619a7e57985229e6fcdac5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a514a6c560e785db3c31361f9dccee4cc"><td class="memTemplParams" colspan="2"><a id="a514a6c560e785db3c31361f9dccee4cc"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a514a6c560e785db3c31361f9dccee4cc"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a514a6c560e785db3c31361f9dccee4cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1e364c18577879d734f4548654723a6"><td class="memTemplParams" colspan="2"><a id="aa1e364c18577879d734f4548654723a6"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:aa1e364c18577879d734f4548654723a6"><td class="memTemplItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:aa1e364c18577879d734f4548654723a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a808ba1e3db1562a001afbc9f00b97a04"><td class="memTemplParams" colspan="2"><a id="a808ba1e3db1562a001afbc9f00b97a04"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a808ba1e3db1562a001afbc9f00b97a04"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a808ba1e3db1562a001afbc9f00b97a04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0efedb6233feaf9829213d1f5ac34f0"><td class="memTemplParams" colspan="2"><a id="ab0efedb6233feaf9829213d1f5ac34f0"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ab0efedb6233feaf9829213d1f5ac34f0"><td class="memTemplItemLeft" align="right" valign="top">INT64&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:ab0efedb6233feaf9829213d1f5ac34f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b81d23847e9aaa67fa203dbc7031447"><td class="memTemplParams" colspan="2"><a id="a1b81d23847e9aaa67fa203dbc7031447"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a1b81d23847e9aaa67fa203dbc7031447"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a1b81d23847e9aaa67fa203dbc7031447"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab15ac2b1f9dbdfd09ada8ca5d116f237"><td class="memTemplParams" colspan="2"><a id="ab15ac2b1f9dbdfd09ada8ca5d116f237"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ab15ac2b1f9dbdfd09ada8ca5d116f237"><td class="memTemplItemLeft" align="right" valign="top">FLT32&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:ab15ac2b1f9dbdfd09ada8ca5d116f237"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9945b22567f04bbe3442c5f55408cc7a"><td class="memTemplParams" colspan="2"><a id="a9945b22567f04bbe3442c5f55408cc7a"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a9945b22567f04bbe3442c5f55408cc7a"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a9945b22567f04bbe3442c5f55408cc7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae78e0c1f2c6c60a8056403e4fd444942"><td class="memTemplParams" colspan="2"><a id="ae78e0c1f2c6c60a8056403e4fd444942"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ae78e0c1f2c6c60a8056403e4fd444942"><td class="memTemplItemLeft" align="right" valign="top">FLT64&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:ae78e0c1f2c6c60a8056403e4fd444942"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65bdff367ba6a40733700eaf2bc50601"><td class="memTemplParams" colspan="2"><a id="a65bdff367ba6a40733700eaf2bc50601"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a65bdff367ba6a40733700eaf2bc50601"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a65bdff367ba6a40733700eaf2bc50601"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a202cfcb7851a142ef86f002d553843c4"><td class="memTemplParams" colspan="2"><a id="a202cfcb7851a142ef86f002d553843c4"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a202cfcb7851a142ef86f002d553843c4"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classLEVEL__BASE_1_1ADDRESS__RANGE.html">ADDRESS_RANGE</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FromString</b> (const std::string &amp;strvalue)</td></tr>
<tr class="separator:a202cfcb7851a142ef86f002d553843c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a019318fcf8c5403341da6fc2b2b03a54"><td class="memTemplParams" colspan="2"><a id="a019318fcf8c5403341da6fc2b2b03a54"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:a019318fcf8c5403341da6fc2b2b03a54"><td class="memTemplItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Type</b> ()</td></tr>
<tr class="separator:a019318fcf8c5403341da6fc2b2b03a54"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class TYPE&gt;<br />
class LEVEL_BASE::KNOBVALUE&lt; TYPE &gt;</h3>
<p>typed and string representation a value</p>
<p>Interface requirements for TYPE:</p><ul>
<li>TYPE FromString(const string &amp;) ... conversion from string to TYPE; this is always needed;</li>
<li>string ToString(const TYPE &amp;) ..... conversion from TYPE to string default implementation uses the original string; specialization can be used to override this;</li>
<li>TYPE Accumulate(TYPE &amp; lVal, const TYPE &amp; rVal). add rVal to lVal and return new lVal; by defult implemented as operator +=. Only used for accumulate mode </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af92530c6c4187f0d4e6278384022ea7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af92530c6c4187f0d4e6278384022ea7c">&#9670;&nbsp;</a></span>Accumulate()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GLOBALTEMPLATEFUN BOOL <a class="el" href="classLEVEL__BASE_1_1KNOBVALUE.html">LEVEL_BASE::KNOBVALUE</a>&lt; BOOL &gt;::Accumulate </td>
<td>(</td>
<td class="paramtype">BOOL &amp;&#160;</td>
<td class="paramname"><em>lVal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const BOOL &amp;&#160;</td>
<td class="paramname"><em>rVal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Specialization of the Accumulate(TYPE &amp;, const TYPE &amp;) method for [TYPE=BOOL]. Implemented as logical OR of values. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>knob.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>