documentation/classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: EnumOption&lt; T &gt; Class Template Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">Compute Library
  43    &#160;<span id="projectnumber">18.05</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">EnumOption&lt; T &gt; Class Template Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Implementation of a simple option that accepts a value from a fixed set.
 126  <a href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for EnumOption&lt; T &gt;:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1test_1_1framework_1_1_enum_option__coll__graph.svg" width="156" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 137 Public Member Functions</h2></td></tr>
 138 <tr class="memitem:a4acdb5a6b659c4041bc8cc6581c72e60"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml#a4acdb5a6b659c4041bc8cc6581c72e60">EnumOption</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, std::set&lt; T &gt; allowed_values)</td></tr>
 139 <tr class="memdesc:a4acdb5a6b659c4041bc8cc6581c72e60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct option with allowed values.  <a href="#a4acdb5a6b659c4041bc8cc6581c72e60">More...</a><br /></td></tr>
 140 <tr class="separator:a4acdb5a6b659c4041bc8cc6581c72e60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:aaeb5fadb98a067c61c4d456b5c9a4f80"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml#aaeb5fadb98a067c61c4d456b5c9a4f80">EnumOption</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, std::set&lt; T &gt; allowed_values, T default_value)</td></tr>
 142 <tr class="memdesc:aaeb5fadb98a067c61c4d456b5c9a4f80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct option with allowed values, a fixed number of accepted values and default values for the option.  <a href="#aaeb5fadb98a067c61c4d456b5c9a4f80">More...</a><br /></td></tr>
 143 <tr class="separator:aaeb5fadb98a067c61c4d456b5c9a4f80"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:aba9622f1f4bc66fcba246f30d4175a4f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">parse</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml#a56e1c8bae880a4eedf8d23194eca95ca">value</a>) override</td></tr>
 145 <tr class="memdesc:aba9622f1f4bc66fcba246f30d4175a4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the given string.  <a href="#aba9622f1f4bc66fcba246f30d4175a4f">More...</a><br /></td></tr>
 146 <tr class="separator:aba9622f1f4bc66fcba246f30d4175a4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ae6038fe1a77c4b08a678530410f41efa"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">help</a> () const override</td></tr>
 148 <tr class="memdesc:ae6038fe1a77c4b08a678530410f41efa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Help message for the option.  <a href="#ae6038fe1a77c4b08a678530410f41efa">More...</a><br /></td></tr>
 149 <tr class="separator:ae6038fe1a77c4b08a678530410f41efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:a56e1c8bae880a4eedf8d23194eca95ca"><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml#a56e1c8bae880a4eedf8d23194eca95ca">value</a> () const </td></tr>
 151 <tr class="memdesc:a56e1c8bae880a4eedf8d23194eca95ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the selected value.  <a href="#a56e1c8bae880a4eedf8d23194eca95ca">More...</a><br /></td></tr>
 152 <tr class="separator:a56e1c8bae880a4eedf8d23194eca95ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="inherit_header pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml">SimpleOption&lt; T &gt;</a></td></tr>
 154 <tr class="memitem:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a53b7b0b7aee13285e6d841dc184c054b">SimpleOption</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, T default_value)</td></tr>
 155 <tr class="memdesc:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the option with the given default value.  <a href="#a53b7b0b7aee13285e6d841dc184c054b">More...</a><br /></td></tr>
 156 <tr class="separator:a53b7b0b7aee13285e6d841dc184c054b inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">parse</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a20f4a96fd8932e0b4d89c65f95991bc9">value</a>) override</td></tr>
 158 <tr class="memdesc:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the given string.  <a href="#aba9622f1f4bc66fcba246f30d4175a4f">More...</a><br /></td></tr>
 159 <tr class="separator:aba9622f1f4bc66fcba246f30d4175a4f inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">help</a> () const override</td></tr>
 161 <tr class="memdesc:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Help message for the option.  <a href="#ae6038fe1a77c4b08a678530410f41efa">More...</a><br /></td></tr>
 162 <tr class="separator:ae6038fe1a77c4b08a678530410f41efa inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:a20f4a96fd8932e0b4d89c65f95991bc9 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a20f4a96fd8932e0b4d89c65f95991bc9">value</a> () const </td></tr>
 164 <tr class="memdesc:a20f4a96fd8932e0b4d89c65f95991bc9 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the option value.  <a href="#a20f4a96fd8932e0b4d89c65f95991bc9">More...</a><br /></td></tr>
 165 <tr class="separator:a20f4a96fd8932e0b4d89c65f95991bc9 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memTemplParams" colspan="2">template&lt;&gt; </td></tr>
 167 <tr class="memitem:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">parse</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a20f4a96fd8932e0b4d89c65f95991bc9">value</a>)</td></tr>
 168 <tr class="memdesc:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the given string.  <a href="#afeee88c6cc79c347f803741da7f325f0">More...</a><br /></td></tr>
 169 <tr class="separator:afeee88c6cc79c347f803741da7f325f0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_simple_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="inherit_header pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1test_1_1framework_1_1_option')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml">Option</a></td></tr>
 171 <tr class="memitem:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>)</td></tr>
 172 <tr class="memdesc:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a8432d7cd1d4ea8732a64e9df51147cbf">More...</a><br /></td></tr>
 173 <tr class="separator:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">Option</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, bool <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a56603b3aba78712e979f0989a4831457">is_required</a>, bool <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#ade5bfc64a698142cd97e226adf6ab1d7">is_set</a>)</td></tr>
 175 <tr class="memdesc:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6340a62771cbbb113fccaf3425f2ae48">More...</a><br /></td></tr>
 176 <tr class="separator:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">~Option</a> ()=default</td></tr>
 178 <tr class="memdesc:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#af340fed9faa9f79d3bf2e385c50d1ca0">More...</a><br /></td></tr>
 179 <tr class="separator:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:a37627d5d5bba7f4a8690c71c2ab3cb07 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr>
 181 <tr class="memdesc:a37627d5d5bba7f4a8690c71c2ab3cb07 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the option.  <a href="#a37627d5d5bba7f4a8690c71c2ab3cb07">More...</a><br /></td></tr>
 182 <tr class="separator:a37627d5d5bba7f4a8690c71c2ab3cb07 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">set_required</a> (bool <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a56603b3aba78712e979f0989a4831457">is_required</a>)</td></tr>
 184 <tr class="memdesc:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether the option is required.  <a href="#a564afafa4220cd36afbe388fcd24549b">More...</a><br /></td></tr>
 185 <tr class="separator:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">set_help</a> (std::string <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a>)</td></tr>
 187 <tr class="memdesc:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the help message for the option.  <a href="#a48a2672f362eeed9a3e93403f4d3de37">More...</a><br /></td></tr>
 188 <tr class="separator:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:a56603b3aba78712e979f0989a4831457 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a56603b3aba78712e979f0989a4831457">is_required</a> () const </td></tr>
 190 <tr class="memdesc:a56603b3aba78712e979f0989a4831457 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the option required?  <a href="#a56603b3aba78712e979f0989a4831457">More...</a><br /></td></tr>
 191 <tr class="separator:a56603b3aba78712e979f0989a4831457 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 192 <tr class="memitem:ade5bfc64a698142cd97e226adf6ab1d7 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#ade5bfc64a698142cd97e226adf6ab1d7">is_set</a> () const </td></tr>
 193 <tr class="memdesc:ade5bfc64a698142cd97e226adf6ab1d7 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has a value been assigned to the option?  <a href="#ade5bfc64a698142cd97e226adf6ab1d7">More...</a><br /></td></tr>
 194 <tr class="separator:ade5bfc64a698142cd97e226adf6ab1d7 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
 195 </table>
 196 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 197 <div class="textblock"><h3>template&lt;typename T&gt;<br />
 198 class arm_compute::test::framework::EnumOption&lt; T &gt;</h3>
 199
 200 <p>Implementation of a simple option that accepts a value from a fixed set. </p>
 201
 202 <p>Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00042">42</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>.</p>
 203 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 204 <a class="anchor" id="a4acdb5a6b659c4041bc8cc6581c72e60"></a>
 205 <div class="memitem">
 206 <div class="memproto">
 207 <table class="mlabels">
 208   <tr>
 209   <td class="mlabels-left">
 210       <table class="memname">
 211         <tr>
 212           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml">EnumOption</a> </td>
 213           <td>(</td>
 214           <td class="paramtype">std::string&#160;</td>
 215           <td class="paramname"><em>name</em>, </td>
 216         </tr>
 217         <tr>
 218           <td class="paramkey"></td>
 219           <td></td>
 220           <td class="paramtype">std::set&lt; T &gt;&#160;</td>
 221           <td class="paramname"><em>allowed_values</em>&#160;</td>
 222         </tr>
 223         <tr>
 224           <td></td>
 225           <td>)</td>
 226           <td></td><td></td>
 227         </tr>
 228       </table>
 229   </td>
 230   <td class="mlabels-right">
 231 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 232   </tr>
 233 </table>
 234 </div><div class="memdoc">
 235
 236 <p>Construct option with allowed values. </p>
 237 <dl class="params"><dt>Parameters</dt><dd>
 238   <table class="params">
 239     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr>
 240     <tr><td class="paramdir">[in]</td><td class="paramname">allowed_values</td><td>Set of allowed values for the option. </td></tr>
 241   </table>
 242   </dd>
 243 </dl>
 244
 245 <p>Definition at line <a class="el" href="_enum_option_8h_source.xhtml#l00074">74</a> of file <a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a>.</p>
 246 <div class="fragment"><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    : SimpleOption&lt;T&gt;{ std::move(<a class="code" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>) }, _allowed_values{ std::move(allowed_values) }</div><div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_option_xhtml_a37627d5d5bba7f4a8690c71c2ab3cb07"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">arm_compute::test::framework::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_8cpp_source.xhtml#l00042">Option.cpp:42</a></div></div>
 247 </div><!-- fragment -->
 248 </div>
 249 </div>
 250 <a class="anchor" id="aaeb5fadb98a067c61c4d456b5c9a4f80"></a>
 251 <div class="memitem">
 252 <div class="memproto">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml">EnumOption</a> </td>
 256           <td>(</td>
 257           <td class="paramtype">std::string&#160;</td>
 258           <td class="paramname"><em>name</em>, </td>
 259         </tr>
 260         <tr>
 261           <td class="paramkey"></td>
 262           <td></td>
 263           <td class="paramtype">std::set&lt; T &gt;&#160;</td>
 264           <td class="paramname"><em>allowed_values</em>, </td>
 265         </tr>
 266         <tr>
 267           <td class="paramkey"></td>
 268           <td></td>
 269           <td class="paramtype">T&#160;</td>
 270           <td class="paramname"><em>default_value</em>&#160;</td>
 271         </tr>
 272         <tr>
 273           <td></td>
 274           <td>)</td>
 275           <td></td><td></td>
 276         </tr>
 277       </table>
 278 </div><div class="memdoc">
 279
 280 <p>Construct option with allowed values, a fixed number of accepted values and default values for the option. </p>
 281 <dl class="params"><dt>Parameters</dt><dd>
 282   <table class="params">
 283     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr>
 284     <tr><td class="paramdir">[in]</td><td class="paramname">allowed_values</td><td>Set of allowed values for the option. </td></tr>
 285     <tr><td class="paramdir">[in]</td><td class="paramname">default_value</td><td>Default value. </td></tr>
 286   </table>
 287   </dd>
 288 </dl>
 289
 290 </div>
 291 </div>
 292 <h2 class="groupheader">Member Function Documentation</h2>
 293 <a class="anchor" id="ae6038fe1a77c4b08a678530410f41efa"></a>
 294 <div class="memitem">
 295 <div class="memproto">
 296 <table class="mlabels">
 297   <tr>
 298   <td class="mlabels-left">
 299       <table class="memname">
 300         <tr>
 301           <td class="memname">std::string help </td>
 302           <td>(</td>
 303           <td class="paramname"></td><td>)</td>
 304           <td> const</td>
 305         </tr>
 306       </table>
 307   </td>
 308   <td class="mlabels-right">
 309 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 310   </tr>
 311 </table>
 312 </div><div class="memdoc">
 313
 314 <p>Help message for the option. </p>
 315 <dl class="section return"><dt>Returns</dt><dd>String representing the help message for the specific subclass. </dd></dl>
 316
 317 <p>Implements <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">Option</a>.</p>
 318
 319 </div>
 320 </div>
 321 <a class="anchor" id="aba9622f1f4bc66fcba246f30d4175a4f"></a>
 322 <div class="memitem">
 323 <div class="memproto">
 324 <table class="mlabels">
 325   <tr>
 326   <td class="mlabels-left">
 327       <table class="memname">
 328         <tr>
 329           <td class="memname">bool parse </td>
 330           <td>(</td>
 331           <td class="paramtype">std::string&#160;</td>
 332           <td class="paramname"><em>value</em></td><td>)</td>
 333           <td></td>
 334         </tr>
 335       </table>
 336   </td>
 337   <td class="mlabels-right">
 338 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 339   </tr>
 340 </table>
 341 </div><div class="memdoc">
 342
 343 <p>Parses the given string. </p>
 344 <dl class="params"><dt>Parameters</dt><dd>
 345   <table class="params">
 346     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>String representation as passed on the command line.</td></tr>
 347   </table>
 348   </dd>
 349 </dl>
 350 <dl class="section return"><dt>Returns</dt><dd>True if the value could be parsed by the specific subclass. </dd></dl>
 351
 352 <p>Implements <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">Option</a>.</p>
 353
 354 </div>
 355 </div>
 356 <a class="anchor" id="a56e1c8bae880a4eedf8d23194eca95ca"></a>
 357 <div class="memitem">
 358 <div class="memproto">
 359       <table class="memname">
 360         <tr>
 361           <td class="memname">const T&amp; value </td>
 362           <td>(</td>
 363           <td class="paramname"></td><td>)</td>
 364           <td> const</td>
 365         </tr>
 366       </table>
 367 </div><div class="memdoc">
 368
 369 <p>Get the selected value. </p>
 370 <dl class="section return"><dt>Returns</dt><dd>get the selected enum value. </dd></dl>
 371
 372 <p>Referenced by <a class="el" href="_common_options_8cpp_source.xhtml#l00099">CommonOptions::create_printers()</a>, and <a class="el" href="main_8cpp_source.xhtml#l00063">main()</a>.</p>
 373
 374 </div>
 375 </div>
 376 <hr/>The documentation for this class was generated from the following file:<ul>
 377 <li>tests/framework/command_line/<a class="el" href="_enum_option_8h_source.xhtml">EnumOption.h</a></li>
 378 </ul>
 379 </div><!-- contents -->
 380 </div><!-- doc-content -->
 381 <!-- start footer part -->
 382 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 383   <ul>
 384     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml">framework</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_enum_option.xhtml">EnumOption</a></li>
 385     <li class="footer">Generated on Wed May 23 2018 11:36:44 for Compute Library by
 386     <a href="http://www.doxygen.org/index.html">
 387     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 388   </ul>
 389 </div>
 390 </body>
 391 </html>