arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1test_1_1framework_1_1_simple_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: SimpleOption&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_simple_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">SimpleOption&lt; T &gt; Class Template Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Implementation of an option that accepts a single value.  
126  <a href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for SimpleOption&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_simple_option__coll__graph.svg" width="156" height="112"><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:a53b7b0b7aee13285e6d841dc184c054b"><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>
139 <tr class="memdesc:a53b7b0b7aee13285e6d841dc184c054b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the option with the given default value.  <a href="#a53b7b0b7aee13285e6d841dc184c054b">More...</a><br /></td></tr>
140 <tr class="separator:a53b7b0b7aee13285e6d841dc184c054b"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <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_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>
142 <tr class="memdesc:aba9622f1f4bc66fcba246f30d4175a4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the given string.  <a href="#aba9622f1f4bc66fcba246f30d4175a4f">More...</a><br /></td></tr>
143 <tr class="separator:aba9622f1f4bc66fcba246f30d4175a4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <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_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">help</a> () const override</td></tr>
145 <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>
146 <tr class="separator:ae6038fe1a77c4b08a678530410f41efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a20f4a96fd8932e0b4d89c65f95991bc9"><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>
148 <tr class="memdesc:a20f4a96fd8932e0b4d89c65f95991bc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the option value.  <a href="#a20f4a96fd8932e0b4d89c65f95991bc9">More...</a><br /></td></tr>
149 <tr class="separator:a20f4a96fd8932e0b4d89c65f95991bc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:afeee88c6cc79c347f803741da7f325f0"><td class="memTemplParams" colspan="2">template&lt;&gt; </td></tr>
151 <tr class="memitem:afeee88c6cc79c347f803741da7f325f0"><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>
152 <tr class="memdesc:afeee88c6cc79c347f803741da7f325f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the given string.  <a href="#afeee88c6cc79c347f803741da7f325f0">More...</a><br /></td></tr>
153 <tr class="separator:afeee88c6cc79c347f803741da7f325f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <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>
155 <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>
156 <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>
157 <tr class="separator:a8432d7cd1d4ea8732a64e9df51147cbf inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <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>
159 <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>
160 <tr class="separator:a6340a62771cbbb113fccaf3425f2ae48 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <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>
162 <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>
163 <tr class="separator:af340fed9faa9f79d3bf2e385c50d1ca0 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
164 <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>
165 <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>
166 <tr class="separator:a37627d5d5bba7f4a8690c71c2ab3cb07 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <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>
168 <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>
169 <tr class="separator:a564afafa4220cd36afbe388fcd24549b inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <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>
171 <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>
172 <tr class="separator:a48a2672f362eeed9a3e93403f4d3de37 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <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>
174 <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>
175 <tr class="separator:a56603b3aba78712e979f0989a4831457 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <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>
177 <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>
178 <tr class="separator:ade5bfc64a698142cd97e226adf6ab1d7 inherit pub_methods_classarm__compute_1_1test_1_1framework_1_1_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
179 </table>
180 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
181 <div class="textblock"><h3>template&lt;typename T&gt;<br />
182 class arm_compute::test::framework::SimpleOption&lt; T &gt;</h3>
183
184 <p>Implementation of an option that accepts a single value. </p>
185
186 <p>Definition at line <a class="el" href="_simple_option_8h_source.xhtml#l00041">41</a> of file <a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>.</p>
187 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
188 <a class="anchor" id="a53b7b0b7aee13285e6d841dc184c054b"></a>
189 <div class="memitem">
190 <div class="memproto">
191 <table class="mlabels">
192   <tr>
193   <td class="mlabels-left">
194       <table class="memname">
195         <tr>
196           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml">SimpleOption</a> </td>
197           <td>(</td>
198           <td class="paramtype">std::string&#160;</td>
199           <td class="paramname"><em>name</em>, </td>
200         </tr>
201         <tr>
202           <td class="paramkey"></td>
203           <td></td>
204           <td class="paramtype">T&#160;</td>
205           <td class="paramname"><em>default_value</em>&#160;</td>
206         </tr>
207         <tr>
208           <td></td>
209           <td>)</td>
210           <td></td><td></td>
211         </tr>
212       </table>
213   </td>
214   <td class="mlabels-right">
215 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
216   </tr>
217 </table>
218 </div><div class="memdoc">
219
220 <p>Construct the option with the given default value. </p>
221 <dl class="params"><dt>Parameters</dt><dd>
222   <table class="params">
223     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr>
224     <tr><td class="paramdir">[in]</td><td class="paramname">default_value</td><td>Default value. </td></tr>
225   </table>
226   </dd>
227 </dl>
228
229 <p>Definition at line <a class="el" href="_simple_option_8h_source.xhtml#l00078">78</a> of file <a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>.</p>
230 <div class="fragment"><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    : <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a>{ std::move(<a class="code" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>), <span class="keyword">false</span>, <span class="keyword">true</span> }, _value{ std::move(default_value) }</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;{</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;}</div><div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_option_xhtml_a8432d7cd1d4ea8732a64e9df51147cbf"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">arm_compute::test::framework::Option::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_8cpp_source.xhtml#l00032">Option.cpp:32</a></div></div>
231 <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>
232 </div><!-- fragment -->
233 </div>
234 </div>
235 <h2 class="groupheader">Member Function Documentation</h2>
236 <a class="anchor" id="ae6038fe1a77c4b08a678530410f41efa"></a>
237 <div class="memitem">
238 <div class="memproto">
239 <table class="mlabels">
240   <tr>
241   <td class="mlabels-left">
242       <table class="memname">
243         <tr>
244           <td class="memname">std::string help </td>
245           <td>(</td>
246           <td class="paramname"></td><td>)</td>
247           <td> const</td>
248         </tr>
249       </table>
250   </td>
251   <td class="mlabels-right">
252 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
253   </tr>
254 </table>
255 </div><div class="memdoc">
256
257 <p>Help message for the option. </p>
258 <dl class="section return"><dt>Returns</dt><dd>String representing the help message for the specific subclass. </dd></dl>
259
260 <p>Implements <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">Option</a>.</p>
261
262 <p>Definition at line <a class="el" href="_simple_option_8h_source.xhtml#l00108">108</a> of file <a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>.</p>
263
264 <p>References <a class="el" href="_option_8cpp_source.xhtml#l00042">Option::name()</a>.</p>
265 <div class="fragment"><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;{</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    <span class="keywordflow">return</span> <span class="stringliteral">&quot;--&quot;</span> + <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>() + <span class="stringliteral">&quot;=VALUE - &quot;</span> + _help;</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;}</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>
266 </div><!-- fragment -->
267 </div>
268 </div>
269 <a class="anchor" id="aba9622f1f4bc66fcba246f30d4175a4f"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="mlabels">
273   <tr>
274   <td class="mlabels-left">
275       <table class="memname">
276         <tr>
277           <td class="memname">bool parse </td>
278           <td>(</td>
279           <td class="paramtype">std::string&#160;</td>
280           <td class="paramname"><em>value</em></td><td>)</td>
281           <td></td>
282         </tr>
283       </table>
284   </td>
285   <td class="mlabels-right">
286 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
287   </tr>
288 </table>
289 </div><div class="memdoc">
290
291 <p>Parses the given string. </p>
292 <dl class="params"><dt>Parameters</dt><dd>
293   <table class="params">
294     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>String representation as passed on the command line.</td></tr>
295   </table>
296   </dd>
297 </dl>
298 <dl class="section return"><dt>Returns</dt><dd>True if the value could be parsed by the specific subclass. </dd></dl>
299
300 <p>Implements <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">Option</a>.</p>
301
302 <p>Definition at line <a class="el" href="_simple_option_8h_source.xhtml#l00084">84</a> of file <a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>.</p>
303 <div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;{</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <span class="keywordflow">try</span></div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    {</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        std::stringstream stream{ std::move(<a class="code" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a20f4a96fd8932e0b4d89c65f95991bc9">value</a>) };</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        stream &gt;&gt; _value;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;        _is_set = !stream.fail();</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        <span class="keywordflow">return</span> _is_set;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    }</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    <span class="keywordflow">catch</span>(<span class="keyword">const</span> std::invalid_argument &amp;)</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    {</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    }</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;}</div><div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_simple_option_xhtml_a20f4a96fd8932e0b4d89c65f95991bc9"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a20f4a96fd8932e0b4d89c65f95991bc9">arm_compute::test::framework::SimpleOption::value</a></div><div class="ttdeci">const T &amp; value() const </div><div class="ttdoc">Get the option value. </div><div class="ttdef"><b>Definition:</b> <a href="_simple_option_8h_source.xhtml#l00114">SimpleOption.h:114</a></div></div>
304 </div><!-- fragment -->
305 </div>
306 </div>
307 <a class="anchor" id="afeee88c6cc79c347f803741da7f325f0"></a>
308 <div class="memitem">
309 <div class="memproto">
310 <table class="mlabels">
311   <tr>
312   <td class="mlabels-left">
313       <table class="memname">
314         <tr>
315           <td class="memname">bool parse </td>
316           <td>(</td>
317           <td class="paramtype">std::string&#160;</td>
318           <td class="paramname"><em>value</em></td><td>)</td>
319           <td></td>
320         </tr>
321       </table>
322   </td>
323   <td class="mlabels-right">
324 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
325   </tr>
326 </table>
327 </div><div class="memdoc">
328
329 <p>Parses the given string. </p>
330 <dl class="params"><dt>Parameters</dt><dd>
331   <table class="params">
332     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>String representation as passed on the command line.</td></tr>
333   </table>
334   </dd>
335 </dl>
336 <dl class="section return"><dt>Returns</dt><dd>True if the value could be parsed by the specific subclass. </dd></dl>
337
338 <p>Implements <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">Option</a>.</p>
339
340 <p>Definition at line <a class="el" href="_simple_option_8h_source.xhtml#l00100">100</a> of file <a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>.</p>
341 <div class="fragment"><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;{</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    _value  = std::move(<a class="code" href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a20f4a96fd8932e0b4d89c65f95991bc9">value</a>);</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    _is_set = <span class="keyword">true</span>;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;}</div><div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_simple_option_xhtml_a20f4a96fd8932e0b4d89c65f95991bc9"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_simple_option.xhtml#a20f4a96fd8932e0b4d89c65f95991bc9">arm_compute::test::framework::SimpleOption::value</a></div><div class="ttdeci">const T &amp; value() const </div><div class="ttdoc">Get the option value. </div><div class="ttdef"><b>Definition:</b> <a href="_simple_option_8h_source.xhtml#l00114">SimpleOption.h:114</a></div></div>
342 </div><!-- fragment -->
343 </div>
344 </div>
345 <a class="anchor" id="a20f4a96fd8932e0b4d89c65f95991bc9"></a>
346 <div class="memitem">
347 <div class="memproto">
348 <table class="mlabels">
349   <tr>
350   <td class="mlabels-left">
351       <table class="memname">
352         <tr>
353           <td class="memname">const T &amp; value </td>
354           <td>(</td>
355           <td class="paramname"></td><td>)</td>
356           <td> const</td>
357         </tr>
358       </table>
359   </td>
360   <td class="mlabels-right">
361 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
362   </tr>
363 </table>
364 </div><div class="memdoc">
365
366 <p>Get the option value. </p>
367 <dl class="section return"><dt>Returns</dt><dd>the option value. </dd></dl>
368
369 <p>Definition at line <a class="el" href="_simple_option_8h_source.xhtml#l00114">114</a> of file <a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a>.</p>
370
371 <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>
372 <div class="fragment"><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;{</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    <span class="keywordflow">return</span> _value;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;}</div></div><!-- fragment -->
373 </div>
374 </div>
375 <hr/>The documentation for this class was generated from the following file:<ul>
376 <li>tests/framework/command_line/<a class="el" href="_simple_option_8h_source.xhtml">SimpleOption.h</a></li>
377 </ul>
378 </div><!-- contents -->
379 </div><!-- doc-content -->
380 <!-- start footer part -->
381 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
382   <ul>
383     <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_simple_option.xhtml">SimpleOption</a></li>
384     <li class="footer">Generated on Wed May 23 2018 11:36:44 for Compute Library by
385     <a href="http://www.doxygen.org/index.html">
386     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
387   </ul>
388 </div>
389 </body>
390 </html>