| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!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.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: ToggleOption 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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.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;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">20.02.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1utils_1_1_toggle_option.xhtml','');}); |
| /* @license-end */ |
| </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> </div> |
| <div class="headertitle"> |
| <div class="title">ToggleOption Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Implementation of an option that can be either true or false. |
| <a href="classarm__compute_1_1utils_1_1_toggle_option.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_toggle_option_8h_source.xhtml">ToggleOption.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for ToggleOption:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1utils_1_1_toggle_option__coll__graph.svg" width="256" height="279"><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.xhtml">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:ae27b8b254e5e02265bd1032771aa303e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml#ae27b8b254e5e02265bd1032771aa303e">ToggleOption</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, bool default_value)</td></tr> |
| <tr class="memdesc:ae27b8b254e5e02265bd1032771aa303e"><td class="mdescLeft"> </td><td class="mdescRight">Construct the option with the given default value. <a href="#ae27b8b254e5e02265bd1032771aa303e">More...</a><br /></td></tr> |
| <tr class="separator:ae27b8b254e5e02265bd1032771aa303e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba9622f1f4bc66fcba246f30d4175a4f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">parse</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a>) override</td></tr> |
| <tr class="memdesc:aba9622f1f4bc66fcba246f30d4175a4f"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string. <a href="#aba9622f1f4bc66fcba246f30d4175a4f">More...</a><br /></td></tr> |
| <tr class="separator:aba9622f1f4bc66fcba246f30d4175a4f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6038fe1a77c4b08a678530410f41efa"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">help</a> () const override</td></tr> |
| <tr class="memdesc:ae6038fe1a77c4b08a678530410f41efa"><td class="mdescLeft"> </td><td class="mdescRight">Help message for the option. <a href="#ae6038fe1a77c4b08a678530410f41efa">More...</a><br /></td></tr> |
| <tr class="separator:ae6038fe1a77c4b08a678530410f41efa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a53b7b0b7aee13285e6d841dc184c054b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml#a53b7b0b7aee13285e6d841dc184c054b">SimpleOption</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, T default_value)</td></tr> |
| <tr class="memdesc:a53b7b0b7aee13285e6d841dc184c054b"><td class="mdescLeft"> </td><td class="mdescRight">Construct the option with the given default value. <a href="#a53b7b0b7aee13285e6d841dc184c054b">More...</a><br /></td></tr> |
| <tr class="separator:a53b7b0b7aee13285e6d841dc184c054b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1utils_1_1_simple_option')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml">SimpleOption< bool ></a></td></tr> |
| <tr class="memitem:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a53b7b0b7aee13285e6d841dc184c054b">SimpleOption</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, bool default_value)</td></tr> |
| <tr class="memdesc:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Construct the option with the given default value. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a53b7b0b7aee13285e6d841dc184c054b">More...</a><br /></td></tr> |
| <tr class="separator:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">parse</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a>) override</td></tr> |
| <tr class="memdesc:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">More...</a><br /></td></tr> |
| <tr class="separator:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">parse</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a>)</td></tr> |
| <tr class="memdesc:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">More...</a><br /></td></tr> |
| <tr class="separator:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">help</a> () const override</td></tr> |
| <tr class="memdesc:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Help message for the option. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">More...</a><br /></td></tr> |
| <tr class="separator:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5d906b55180c260032ce43d6c5d4d06 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">const bool & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> () const</td></tr> |
| <tr class="memdesc:ab5d906b55180c260032ce43d6c5d4d06 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Get the option value. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">More...</a><br /></td></tr> |
| <tr class="separator:ab5d906b55180c260032ce43d6c5d4d06 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>)</td></tr> |
| <tr class="memdesc:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">More...</a><br /></td></tr> |
| <tr class="separator:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a>)</td></tr> |
| <tr class="memdesc:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">More...</a><br /></td></tr> |
| <tr class="separator:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_simple_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1utils_1_1_option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1utils_1_1_option')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml">Option</a></td></tr> |
| <tr class="memitem:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>)</td></tr> |
| <tr class="memdesc:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">More...</a><br /></td></tr> |
| <tr class="separator:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a>)</td></tr> |
| <tr class="memdesc:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">More...</a><br /></td></tr> |
| <tr class="separator:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">~Option</a> ()=default</td></tr> |
| <tr class="memdesc:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="classarm__compute_1_1utils_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">More...</a><br /></td></tr> |
| <tr class="separator:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a> () const</td></tr> |
| <tr class="memdesc:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Name of the option. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">More...</a><br /></td></tr> |
| <tr class="separator:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">set_required</a> (bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>)</td></tr> |
| <tr class="memdesc:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Set whether the option is required. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">More...</a><br /></td></tr> |
| <tr class="separator:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">set_help</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a>)</td></tr> |
| <tr class="memdesc:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Set the help message for the option. <a href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">More...</a><br /></td></tr> |
| <tr class="separator:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5fcbfe1e97213aae098a4c0dc48ffe5 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a> () const</td></tr> |
| <tr class="memdesc:ae5fcbfe1e97213aae098a4c0dc48ffe5 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Is the option required? <a href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">More...</a><br /></td></tr> |
| <tr class="separator:ae5fcbfe1e97213aae098a4c0dc48ffe5 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d75095e0ce4d0cc3ed6bc4733664a74 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a> () const</td></tr> |
| <tr class="memdesc:a8d75095e0ce4d0cc3ed6bc4733664a74 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="mdescLeft"> </td><td class="mdescRight">Has a value been assigned to the option? <a href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">More...</a><br /></td></tr> |
| <tr class="separator:a8d75095e0ce4d0cc3ed6bc4733664a74 inherit pub_methods_classarm__compute_1_1utils_1_1_option"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Implementation of an option that can be either true or false. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_toggle_option_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_toggle_option_8h_source.xhtml">ToggleOption.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ae27b8b254e5e02265bd1032771aa303e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae27b8b254e5e02265bd1032771aa303e">◆ </a></span>ToggleOption()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml">ToggleOption</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>default_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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct the option with the given default value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">default_value</td><td>Default value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_toggle_option_8h_source.xhtml#l00052">52</a> of file <a class="el" href="_toggle_option_8h_source.xhtml">ToggleOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  : SimpleOption<bool></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::move(<a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>), default_value</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_option_8h_source.xhtml#l00115">Option::name()</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae6038fe1a77c4b08a678530410f41efa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae6038fe1a77c4b08a678530410f41efa">◆ </a></span>help()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string help </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Help message for the option. </p> |
| <dl class="section return"><dt>Returns</dt><dd>String representing the help message for the specific subclass. </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">Option</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_toggle_option_8h_source.xhtml#l00076">76</a> of file <a class="el" href="_toggle_option_8h_source.xhtml">ToggleOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> <span class="stringliteral">"--"</span> + <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>() + <span class="stringliteral">", --no-"</span> + <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>() + <span class="stringliteral">" - "</span> + _help;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_option_8h_source.xhtml#l00115">Option::name()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aba9622f1f4bc66fcba246f30d4175a4f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba9622f1f4bc66fcba246f30d4175a4f">◆ </a></span>parse()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool parse </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parses the given string. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>String representation as passed on the command line.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if the value could be parsed by the specific subclass. </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">Option</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_toggle_option_8h_source.xhtml#l00060">60</a> of file <a class="el" href="_toggle_option_8h_source.xhtml">ToggleOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">if</span>(<a class="code" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> == <span class="stringliteral">"true"</span>)</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  _value = <span class="keyword">true</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  _is_set = <span class="keyword">true</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span>(<a class="code" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">value</a> == <span class="stringliteral">"false"</span>)</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  _value = <span class="keyword">false</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  _is_set = <span class="keyword">true</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> _is_set;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_simple_option_xhtml_ab5d906b55180c260032ce43d6c5d4d06"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ab5d906b55180c260032ce43d6c5d4d06">arm_compute::utils::SimpleOption< bool >::value</a></div><div class="ttdeci">const bool & value() const</div><div class="ttdoc">Get the option value.</div><div class="ttdef"><b>Definition:</b> <a href="_simple_option_8h_source.xhtml#l00112">SimpleOption.h:112</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a53b7b0b7aee13285e6d841dc184c054b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a53b7b0b7aee13285e6d841dc184c054b">◆ </a></span>SimpleOption()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml">SimpleOption</a></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>Construct the option with the given default value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">default_value</td><td>Default value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_simple_option_8h_source.xhtml#l00076">76</a> of file <a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  : <a class="code" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a>{ std::move(<a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>), <span class="keyword">false</span>, <span class="keyword">true</span> }, _value{ std::move(default_value) }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1utils_1_1_simple_option_xhtml_a8432d7cd1d4ea8732a64e9df51147cbf"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">arm_compute::utils::SimpleOption< bool >::Option</a></div><div class="ttdeci">Option(std::string name)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00105">Option.h:105</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>utils/command_line/<a class="el" href="_toggle_option_8h_source.xhtml">ToggleOption.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"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1utils.xhtml">utils</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml">ToggleOption</a></li> |
| <li class="footer">Generated on Thu Mar 5 2020 16:07:20 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |