252 lines
13 KiB
HTML
252 lines
13 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: blfwk::Progress 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('classblfwk_1_1_progress.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="#pub-attribs">Public Attributes</a> |
|
|
<a href="classblfwk_1_1_progress-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">blfwk::Progress Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Contains the callback function for progress and abort phase.
|
|
<a href="classblfwk_1_1_progress.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_command_8h_source.html">Command.h</a>></code></p>
|
|
<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:a6bd2a4b609067598ae66443c84c312c6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bd2a4b609067598ae66443c84c312c6"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#a6bd2a4b609067598ae66443c84c312c6">Progress</a> ()</td></tr>
|
|
<tr class="memdesc:a6bd2a4b609067598ae66443c84c312c6"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a6bd2a4b609067598ae66443c84c312c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22fdff62e531d87b5f3a36e14e2ad057"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22fdff62e531d87b5f3a36e14e2ad057"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#a22fdff62e531d87b5f3a36e14e2ad057">Progress</a> (void(*callback)(int, int, int), bool *<a class="el" href="classblfwk_1_1_progress.html#aebd319a5fa62be9ef953d29ef7584830">abortPhase</a>)</td></tr>
|
|
<tr class="memdesc:a22fdff62e531d87b5f3a36e14e2ad057"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with initial callback. <br /></td></tr>
|
|
<tr class="separator:a22fdff62e531d87b5f3a36e14e2ad057"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ca54904334a795fbd1ea2be680011e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ca54904334a795fbd1ea2be680011e0"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#a4ca54904334a795fbd1ea2be680011e0">~Progress</a> ()</td></tr>
|
|
<tr class="memdesc:a4ca54904334a795fbd1ea2be680011e0"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a4ca54904334a795fbd1ea2be680011e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429b2c0cae9de7a5f04952cfd17843f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#a429b2c0cae9de7a5f04952cfd17843f7">progressCallback</a> (int percentage)</td></tr>
|
|
<tr class="memdesc:a429b2c0cae9de7a5f04952cfd17843f7"><td class="mdescLeft"> </td><td class="mdescRight">execute the progress callback function. <a href="#a429b2c0cae9de7a5f04952cfd17843f7">More...</a><br /></td></tr>
|
|
<tr class="separator:a429b2c0cae9de7a5f04952cfd17843f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebd319a5fa62be9ef953d29ef7584830"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebd319a5fa62be9ef953d29ef7584830"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#aebd319a5fa62be9ef953d29ef7584830">abortPhase</a> (void)</td></tr>
|
|
<tr class="memdesc:aebd319a5fa62be9ef953d29ef7584830"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the data phase is canceled. <br /></td></tr>
|
|
<tr class="separator:aebd319a5fa62be9ef953d29ef7584830"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fc912651119a802e0bcb6a0b381077f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#a6fc912651119a802e0bcb6a0b381077f">registerCallback</a> (void(*callback)(int, int, int), bool *<a class="el" href="classblfwk_1_1_progress.html#aebd319a5fa62be9ef953d29ef7584830">abortPhase</a>)</td></tr>
|
|
<tr class="separator:a6fc912651119a802e0bcb6a0b381077f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ab33039c5a99c87f4bb197d8a77787841"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab33039c5a99c87f4bb197d8a77787841"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#ab33039c5a99c87f4bb197d8a77787841">m_segmentIndex</a></td></tr>
|
|
<tr class="memdesc:ab33039c5a99c87f4bb197d8a77787841"><td class="mdescLeft"> </td><td class="mdescRight">Index of data segment in progressing. <br /></td></tr>
|
|
<tr class="separator:ab33039c5a99c87f4bb197d8a77787841"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65a6a64463a6c491d471f0b9f0fce8d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65a6a64463a6c491d471f0b9f0fce8d8"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_progress.html#a65a6a64463a6c491d471f0b9f0fce8d8">m_segmentCount</a></td></tr>
|
|
<tr class="memdesc:a65a6a64463a6c491d471f0b9f0fce8d8"><td class="mdescLeft"> </td><td class="mdescRight">The number of data segments. <br /></td></tr>
|
|
<tr class="separator:a65a6a64463a6c491d471f0b9f0fce8d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Contains the callback function for progress and abort phase. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a429b2c0cae9de7a5f04952cfd17843f7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void blfwk::Progress::progressCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>percentage</em></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>execute the progress callback function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">percentage</td><td>the percentage of current executed progress. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6fc912651119a802e0bcb6a0b381077f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void blfwk::Progress::registerCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(int, int, int) </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>abortPhase</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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>initialized the progress callback function and the variable of controlling data phase.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">callback</td><td>The progress callback function.</td></tr>
|
|
<tr><td class="paramname">abortPhase</td><td>The pointer pointing to a variable controlling whether abort current data phase. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="_command_8h_source.html">Command.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>blfwk</b></li><li class="navelem"><a class="el" href="classblfwk_1_1_progress.html">Progress</a></li>
|
|
<li class="footer">Generated on Mon Mar 7 2016 16:49:51 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>
|