mirror of https://github.com/hmatuschek/libsdr
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
363 lines
18 KiB
HTML
363 lines
18 KiB
HTML
<!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.9.1"/>
|
|
<title>libsdr: sdr::Options Class 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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">libsdr
|
|
 <span id="projectnumber">0.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">A simple SDR library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<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 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">
|
|
<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" 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>
|
|
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></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)">
|
|
</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"><b>sdr</b></li><li class="navelem"><a class="el" href="classsdr_1_1_options.html">Options</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classsdr_1_1_options-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sdr::Options Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Convenience functions for command line arguments.
|
|
<a href="classsdr_1_1_options.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="options_8hh_source.html">options.hh</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsdr_1_1_options_1_1_definition.html">Definition</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Argument definition. <a href="structsdr_1_1_options_1_1_definition.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options_1_1_value.html">Value</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The argument value. <a href="classsdr_1_1_options_1_1_value.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a9ac110e66c7d6065c7035577bcf51923"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options.html#a9ac110e66c7d6065c7035577bcf51923">ArgType</a> { <a class="el" href="classsdr_1_1_options.html#a9ac110e66c7d6065c7035577bcf51923af5db5e6e229f1e46459310e3464bd1a1">FLAG</a>,
|
|
<a class="el" href="classsdr_1_1_options.html#a9ac110e66c7d6065c7035577bcf51923a2c66965e290f6a5b1edea96154e0fb9e">INTEGER</a>,
|
|
<a class="el" href="classsdr_1_1_options.html#a9ac110e66c7d6065c7035577bcf51923a9a98f630dcfbc1649e4e4446a4c91917">FLOAT</a>,
|
|
<a class="el" href="classsdr_1_1_options.html#a9ac110e66c7d6065c7035577bcf51923a34398a6bf19ef577442e10d24879b953">ANY</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a9ac110e66c7d6065c7035577bcf51923"><td class="mdescLeft"> </td><td class="mdescRight">Possible argument types. <a href="classsdr_1_1_options.html#a9ac110e66c7d6065c7035577bcf51923">More...</a><br /></td></tr>
|
|
<tr class="separator:a9ac110e66c7d6065c7035577bcf51923"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:ab72fb640172a6109e34c8a5366563753"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options.html#ab72fb640172a6109e34c8a5366563753">Options</a> ()</td></tr>
|
|
<tr class="memdesc:ab72fb640172a6109e34c8a5366563753"><td class="mdescLeft"> </td><td class="mdescRight">Empty constructor. <a href="#ab72fb640172a6109e34c8a5366563753">More...</a><br /></td></tr>
|
|
<tr class="separator:ab72fb640172a6109e34c8a5366563753"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42f37b349c199d9a412e97cb0effea01"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options.html#a42f37b349c199d9a412e97cb0effea01">has</a> (const char *name)</td></tr>
|
|
<tr class="memdesc:a42f37b349c199d9a412e97cb0effea01"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the specified option was found (long name). <a href="#a42f37b349c199d9a412e97cb0effea01">More...</a><br /></td></tr>
|
|
<tr class="separator:a42f37b349c199d9a412e97cb0effea01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf0c8e6106bcca067b0f11dba15fb050"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsdr_1_1_options_1_1_value.html">Value</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options.html#abf0c8e6106bcca067b0f11dba15fb050">get</a> (const char *name)</td></tr>
|
|
<tr class="memdesc:abf0c8e6106bcca067b0f11dba15fb050"><td class="mdescLeft"> </td><td class="mdescRight">Returns the argument of the specified option (long name). <a href="#abf0c8e6106bcca067b0f11dba15fb050">More...</a><br /></td></tr>
|
|
<tr class="separator:abf0c8e6106bcca067b0f11dba15fb050"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8e2d6ea59da75b95d5b249a8db4ea0e2"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options.html#a8e2d6ea59da75b95d5b249a8db4ea0e2">parse</a> (const <a class="el" href="structsdr_1_1_options_1_1_definition.html">Definition</a> defs[], int argc, char *argv[], <a class="el" href="classsdr_1_1_options.html">Options</a> &options)</td></tr>
|
|
<tr class="memdesc:a8e2d6ea59da75b95d5b249a8db4ea0e2"><td class="mdescLeft"> </td><td class="mdescRight">Parse the given arguments (<code>argc</code>, <code>argv</code>) using the definitions <code>defs</code> and stores the results into <code>options</code>. <a href="#a8e2d6ea59da75b95d5b249a8db4ea0e2">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e2d6ea59da75b95d5b249a8db4ea0e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a513891211cfd8459198d61aa9f896110"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options.html#a513891211cfd8459198d61aa9f896110">print_help</a> (std::ostream &stream, const <a class="el" href="structsdr_1_1_options_1_1_definition.html">Definition</a> defs[])</td></tr>
|
|
<tr class="memdesc:a513891211cfd8459198d61aa9f896110"><td class="mdescLeft"> </td><td class="mdescRight">Serializes a help text derived from given the definitions into <code>stream</code>. <a href="#a513891211cfd8459198d61aa9f896110">More...</a><br /></td></tr>
|
|
<tr class="separator:a513891211cfd8459198d61aa9f896110"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:ae59c6b922121a19ff9ad59200b51f48c"><td class="memItemLeft" align="right" valign="top">std::map< std::string, <a class="el" href="classsdr_1_1_options_1_1_value.html">Value</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_options.html#ae59c6b922121a19ff9ad59200b51f48c">_options</a></td></tr>
|
|
<tr class="memdesc:ae59c6b922121a19ff9ad59200b51f48c"><td class="mdescLeft"> </td><td class="mdescRight">The table of option names and argument values. <a href="#ae59c6b922121a19ff9ad59200b51f48c">More...</a><br /></td></tr>
|
|
<tr class="separator:ae59c6b922121a19ff9ad59200b51f48c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Convenience functions for command line arguments. </p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a class="anchor" id="a9ac110e66c7d6065c7035577bcf51923"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classsdr_1_1_options.html#a9ac110e66c7d6065c7035577bcf51923">sdr::Options::ArgType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Possible argument types. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a9ac110e66c7d6065c7035577bcf51923af5db5e6e229f1e46459310e3464bd1a1"></a>FLAG </td><td class="fielddoc">
|
|
<p>No argument (flag). </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="a9ac110e66c7d6065c7035577bcf51923a2c66965e290f6a5b1edea96154e0fb9e"></a>INTEGER </td><td class="fielddoc">
|
|
<p>Integer argument. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="a9ac110e66c7d6065c7035577bcf51923a9a98f630dcfbc1649e4e4446a4c91917"></a>FLOAT </td><td class="fielddoc">
|
|
<p>Floating point argument. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="a9ac110e66c7d6065c7035577bcf51923a34398a6bf19ef577442e10d24879b953"></a>ANY </td><td class="fielddoc">
|
|
<p>Any argument (string). </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ab72fb640172a6109e34c8a5366563753"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Options::Options </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Empty constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="abf0c8e6106bcca067b0f11dba15fb050"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsdr_1_1_options_1_1_value.html">Options::Value</a> & Options::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the argument of the specified option (long name). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a42f37b349c199d9a412e97cb0effea01"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Options::has </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> if the specified option was found (long name). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8e2d6ea59da75b95d5b249a8db4ea0e2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Options::parse </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structsdr_1_1_options_1_1_definition.html">Definition</a> </td>
|
|
<td class="paramname"><em>defs</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>argc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>argv</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classsdr_1_1_options.html">Options</a> & </td>
|
|
<td class="paramname"><em>options</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parse the given arguments (<code>argc</code>, <code>argv</code>) using the definitions <code>defs</code> and stores the results into <code>options</code>. </p>
|
|
<p>Returns <code>false</code> on error. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a513891211cfd8459198d61aa9f896110"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Options::print_help </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream & </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structsdr_1_1_options_1_1_definition.html">Definition</a> </td>
|
|
<td class="paramname"><em>defs</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Serializes a help text derived from given the definitions into <code>stream</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="ae59c6b922121a19ff9ad59200b51f48c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::map<std::string, <a class="el" href="classsdr_1_1_options_1_1_value.html">Value</a>> sdr::Options::_options</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The table of option names and argument values. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="options_8hh_source.html">options.hh</a></li>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/options.cc</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jun 2 2015 18:28:39 for libsdr by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|