331 lines
15 KiB
HTML
331 lines
15 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.11"/>
|
|
<title>Kinetis Bootloader Host: elftosb::OptionContext 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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 id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Kinetis Bootloader Host
|
|
 <span id="projectnumber">2.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">Host Tools for Kinetis devices</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<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>Introduction</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>
|
|
<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="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('classelftosb_1_1_option_context.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classelftosb_1_1_option_context-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">elftosb::OptionContext Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Pure abstract interface class to a table of options.
|
|
<a href="classelftosb_1_1_option_context.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="apps_2elftosb_2common_2_option_context_8h_source.html">OptionContext.h</a>></code></p>
|
|
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for elftosb::OptionContext:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="classelftosb_1_1_option_context__inherit__graph.svg" width="198" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<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:a5d00c2591de414fc455048f2938f831e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d00c2591de414fc455048f2938f831e"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_context.html#a5d00c2591de414fc455048f2938f831e">~OptionContext</a> ()</td></tr>
|
|
<tr class="memdesc:a5d00c2591de414fc455048f2938f831e"><td class="mdescLeft"> </td><td class="mdescRight">Make the dtor virtual. <br /></td></tr>
|
|
<tr class="separator:a5d00c2591de414fc455048f2938f831e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a469ea9d9205d041830ea14f618845f5f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_context.html#a469ea9d9205d041830ea14f618845f5f">hasOption</a> (const std::string &name) const =0</td></tr>
|
|
<tr class="memdesc:a469ea9d9205d041830ea14f618845f5f"><td class="mdescLeft"> </td><td class="mdescRight">Detemine whether the named option is present in the table. <a href="#a469ea9d9205d041830ea14f618845f5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a469ea9d9205d041830ea14f618845f5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff659da41d49788cc5e1d4047bd672bd"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classelftosb_1_1_value.html">Value</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_context.html#aff659da41d49788cc5e1d4047bd672bd">getOption</a> (const std::string &name) const =0</td></tr>
|
|
<tr class="memdesc:aff659da41d49788cc5e1d4047bd672bd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the option's value. <a href="#aff659da41d49788cc5e1d4047bd672bd">More...</a><br /></td></tr>
|
|
<tr class="separator:aff659da41d49788cc5e1d4047bd672bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a559af695c2ca057929cb6c851eae9251"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_context.html#a559af695c2ca057929cb6c851eae9251">setOption</a> (const std::string &name, <a class="el" href="classelftosb_1_1_value.html">Value</a> *value)=0</td></tr>
|
|
<tr class="memdesc:a559af695c2ca057929cb6c851eae9251"><td class="mdescLeft"> </td><td class="mdescRight">Adds or changes an option's value. <a href="#a559af695c2ca057929cb6c851eae9251">More...</a><br /></td></tr>
|
|
<tr class="separator:a559af695c2ca057929cb6c851eae9251"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a857c8b33dda03bd4b53e5527446f50f6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_context.html#a857c8b33dda03bd4b53e5527446f50f6">deleteOption</a> (const std::string &name)=0</td></tr>
|
|
<tr class="memdesc:a857c8b33dda03bd4b53e5527446f50f6"><td class="mdescLeft"> </td><td class="mdescRight">Removes an option from the table. <a href="#a857c8b33dda03bd4b53e5527446f50f6">More...</a><br /></td></tr>
|
|
<tr class="separator:a857c8b33dda03bd4b53e5527446f50f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Pure abstract interface class to a table of options. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a857c8b33dda03bd4b53e5527446f50f6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void elftosb::OptionContext::deleteOption </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes an option from the table. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name of the option to remove. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classelftosb_1_1_option_dictionary.html#a5db75b348e96c3cf920e6615edf9dabe">elftosb::OptionDictionary</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aff659da41d49788cc5e1d4047bd672bd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const <a class="el" href="classelftosb_1_1_value.html">Value</a>* elftosb::OptionContext::getOption </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the option's value. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name of the option. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The value for the option named <em>name</em>. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">NULL</td><td>No option is in the table with that name. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classelftosb_1_1_option_dictionary.html#a8420e8239de77c045a52d2725f77541a">elftosb::OptionDictionary</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a469ea9d9205d041830ea14f618845f5f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool elftosb::OptionContext::hasOption </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Detemine whether the named option is present in the table. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name of the option to query. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">true</td><td>The option is present and has a value. </td></tr>
|
|
<tr><td class="paramname">false</td><td>No option with that name is in the table. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classelftosb_1_1_option_dictionary.html#a06eecc97dde1bdf31d47a3f0f21371d5">elftosb::OptionDictionary</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a559af695c2ca057929cb6c851eae9251"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void elftosb::OptionContext::setOption </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classelftosb_1_1_value.html">Value</a> * </td>
|
|
<td class="paramname"><em>value</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds or changes an option's value. </p>
|
|
<p>If the option was not already present in the table, it is added. Otherwise the old value is replaced.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The option's name. </td></tr>
|
|
<tr><td class="paramname">value</td><td>New value for the option. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classelftosb_1_1_option_dictionary.html#a854d1a5cc670b0d1d747d73f82d0b8bd">elftosb::OptionDictionary</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="apps_2elftosb_2common_2_option_context_8h_source.html">apps/elftosb/common/OptionContext.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>elftosb</b></li><li class="navelem"><a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a></li>
|
|
<li class="footer">Generated on Mon Mar 7 2016 16:49:52 for Kinetis Bootloader Host by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|