swh:1:snp:e6d42e6731ce66e3c09de07ac49964c03139e990
Raw File
Tip revision: 26b818c8be2be41dd673d938b403c5c7562635de authored by Travis CI on 28 November 2019, 13:55:12 UTC
Deploy code docs to GitHub Pages Travis build: 305
Tip revision: 26b818c
struct_ox_1_1_tomato_options.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Tomato: Ox::TomatoOptions&lt; TYPE &gt; Struct Template 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="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Tomato
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_ox_1_1_tomato_options.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_ox_1_1_tomato_options-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Ox::TomatoOptions&lt; TYPE &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_ox_factory_of_fitters_8h_source.html">OxFactoryOfFitters.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a76497b53cadad720af7ff0f83b99096b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#a76497b53cadad720af7ff0f83b99096b">init</a> ()</td></tr>
<tr class="separator:a76497b53cadad720af7ff0f83b99096b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71193c5376cb6a732895c160d312d85c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#a71193c5376cb6a732895c160d312d85c">TomatoOptions</a> ()</td></tr>
<tr class="separator:a71193c5376cb6a732895c160d312d85c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c33d9488b728af994565639f75d9bba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#a5c33d9488b728af994565639f75d9bba">TomatoOptions</a> (const std::string &amp;filePath)</td></tr>
<tr class="separator:a5c33d9488b728af994565639f75d9bba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f291fb0d37adaf6d4b2167e9c75af3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#a6f291fb0d37adaf6d4b2167e9c75af3e">~TomatoOptions</a> ()</td></tr>
<tr class="separator:a6f291fb0d37adaf6d4b2167e9c75af3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41d923f3ffea2007a75217f4f651219b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#a41d923f3ffea2007a75217f4f651219b">exportToYaml</a> ()</td></tr>
<tr class="separator:a41d923f3ffea2007a75217f4f651219b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa834ee2985662cdefbdbe4279481b33"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#aaa834ee2985662cdefbdbe4279481b33">exportToYaml</a> (std::string filePath)</td></tr>
<tr class="separator:aaa834ee2985662cdefbdbe4279481b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a17d988d7ac73abef1ad2d79575ab30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#a3a17d988d7ac73abef1ad2d79575ab30">printCurrent</a> ()</td></tr>
<tr class="separator:a3a17d988d7ac73abef1ad2d79575ab30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5b8f4b3fd18b6824188ddf0f39ab781"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ox_1_1_tomato_options.html#ac5b8f4b3fd18b6824188ddf0f39ab781">findInArray</a> (int size, const char *nameArray[], std::string name)</td></tr>
<tr class="separator:ac5b8f4b3fd18b6824188ddf0f39ab781"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ad123055506ec1c4c73b397a5f771d2e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad123055506ec1c4c73b397a5f771d2e7"></a>
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>files_magnitude</b></td></tr>
<tr class="separator:ad123055506ec1c4c73b397a5f771d2e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd13f26343647d05164a33cb5b4163f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd13f26343647d05164a33cb5b4163f3"></a>
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>files_phase</b></td></tr>
<tr class="separator:acd13f26343647d05164a33cb5b4163f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeffcb3fc69397596ce852699a2f3b05d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeffcb3fc69397596ce852699a2f3b05d"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>dir_magnitude</b></td></tr>
<tr class="separator:aeffcb3fc69397596ce852699a2f3b05d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92cabcc150b94b5b4c3dbea6e8ecb846"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92cabcc150b94b5b4c3dbea6e8ecb846"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>dir_phase</b></td></tr>
<tr class="separator:a92cabcc150b94b5b4c3dbea6e8ecb846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af31a50b6e23004912a1512812c823a29"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af31a50b6e23004912a1512812c823a29"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>dir_output_map</b></td></tr>
<tr class="separator:af31a50b6e23004912a1512812c823a29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8e2816968affd97a0ba0b13c44c4c02"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8e2816968affd97a0ba0b13c44c4c02"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>dir_output_fitparams</b></td></tr>
<tr class="separator:ab8e2816968affd97a0ba0b13c44c4c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657de7a6c7607a1727ed38d79306ecd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a657de7a6c7607a1727ed38d79306ecd1"></a>
std::vector&lt; MeasureType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>signal_magnitude</b></td></tr>
<tr class="separator:a657de7a6c7607a1727ed38d79306ecd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76d334a72a2e2df16e140441cc79ab3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76d334a72a2e2df16e140441cc79ab3e"></a>
std::vector&lt; MeasureType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>signal_phase</b></td></tr>
<tr class="separator:a76d334a72a2e2df16e140441cc79ab3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d4ad4476a8817e68ead08d1b0645033"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d4ad4476a8817e68ead08d1b0645033"></a>
calculatorsType_t&#160;</td><td class="memItemRight" valign="bottom"><b>parameter_to_map</b></td></tr>
<tr class="separator:a0d4ad4476a8817e68ead08d1b0645033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a943b1f0402f72d794bf21c62c3333f8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a943b1f0402f72d794bf21c62c3333f8b"></a>
paramType_t&#160;</td><td class="memItemRight" valign="bottom"><b>parameter_type</b></td></tr>
<tr class="separator:a943b1f0402f72d794bf21c62c3333f8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d1d2149185ef71968980cf8c6afcf14"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d1d2149185ef71968980cf8c6afcf14"></a>
fittersType_t&#160;</td><td class="memItemRight" valign="bottom"><b>fitting_method</b></td></tr>
<tr class="separator:a2d1d2149185ef71968980cf8c6afcf14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a5e32c79e597006aaaa79600ddaa564"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a5e32c79e597006aaaa79600ddaa564"></a>
modelType_t&#160;</td><td class="memItemRight" valign="bottom"><b>model_type</b></td></tr>
<tr class="separator:a4a5e32c79e597006aaaa79600ddaa564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cf923d6d04fb8cb510db2623e93119d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cf923d6d04fb8cb510db2623e93119d"></a>
signCalculatorsType_t&#160;</td><td class="memItemRight" valign="bottom"><b>sign_calc_method</b></td></tr>
<tr class="separator:a2cf923d6d04fb8cb510db2623e93119d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9da2993961d10c848b0860284900c869"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9da2993961d10c848b0860284900c869"></a>
startPointCalculatorsType_t&#160;</td><td class="memItemRight" valign="bottom"><b>start_point_calc_method</b></td></tr>
<tr class="separator:a9da2993961d10c848b0860284900c869"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2ac4c46e46b4d183c6944771701040b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2ac4c46e46b4d183c6944771701040b"></a>
MeasureType&#160;</td><td class="memItemRight" valign="bottom"><b>fTolerance</b></td></tr>
<tr class="separator:ae2ac4c46e46b4d183c6944771701040b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b864c01b6b0b4e4d5a56470f6c5f004"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b864c01b6b0b4e4d5a56470f6c5f004"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>max_function_evals</b></td></tr>
<tr class="separator:a9b864c01b6b0b4e4d5a56470f6c5f004"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a367c540e5413f8ffa3a6bc6ef5781b45"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a367c540e5413f8ffa3a6bc6ef5781b45"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>use_gradient</b></td></tr>
<tr class="separator:a367c540e5413f8ffa3a6bc6ef5781b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7ac986b6ad257e73eda3d524f85fe85"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7ac986b6ad257e73eda3d524f85fe85"></a>
std::vector&lt; MeasureType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>inversion_times</b></td></tr>
<tr class="separator:ab7ac986b6ad257e73eda3d524f85fe85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae70219d5c42877178575baa5d6ae51c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae70219d5c42877178575baa5d6ae51c3"></a>
std::vector&lt; MeasureType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>echo_times</b></td></tr>
<tr class="separator:ae70219d5c42877178575baa5d6ae51c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0eced6fbbc1270e5d437a18ba950c06c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0eced6fbbc1270e5d437a18ba950c06c"></a>
std::vector&lt; MeasureType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>start_point</b></td></tr>
<tr class="separator:a0eced6fbbc1270e5d437a18ba950c06c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9352986deb21ca97d4fd34daf564241"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9352986deb21ca97d4fd34daf564241"></a>
std::vector&lt; MeasureType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>noise</b></td></tr>
<tr class="separator:ae9352986deb21ca97d4fd34daf564241"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af81d1a55409036109d253b313d59e972"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af81d1a55409036109d253b313d59e972"></a>
MeasureType&#160;</td><td class="memItemRight" valign="bottom"><b>mean_cut_off</b></td></tr>
<tr class="separator:af81d1a55409036109d253b313d59e972"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab245e10cf32b36c48d66208a5f505099"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab245e10cf32b36c48d66208a5f505099"></a>
MeasureType&#160;</td><td class="memItemRight" valign="bottom"><b>map_scale_factor</b></td></tr>
<tr class="separator:ab245e10cf32b36c48d66208a5f505099"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa762826a11ff767aa969bd66c29b577f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa762826a11ff767aa969bd66c29b577f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>use_colorbar</b></td></tr>
<tr class="separator:aa762826a11ff767aa969bd66c29b577f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54efb4945f2857ee4ed9e1d5552fc3dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54efb4945f2857ee4ed9e1d5552fc3dd"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>number_of_threads</b></td></tr>
<tr class="separator:a54efb4945f2857ee4ed9e1d5552fc3dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab20a779c5a8dd371ec9356e3f9ce79c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab20a779c5a8dd371ec9356e3f9ce79c9"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>output_map_series_number</b></td></tr>
<tr class="separator:ab20a779c5a8dd371ec9356e3f9ce79c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58664e816cde6eff746bd5abe4fe2d1c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58664e816cde6eff746bd5abe4fe2d1c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>output_fitparams_series_number</b></td></tr>
<tr class="separator:a58664e816cde6eff746bd5abe4fe2d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a008c932c7d65248d2d82e0e654993384"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a008c932c7d65248d2d82e0e654993384"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>calculation_time</b></td></tr>
<tr class="separator:a008c932c7d65248d2d82e0e654993384"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename TYPE&gt;<br/>
struct Ox::TomatoOptions&lt; TYPE &gt;</h3>

<p>Here you can configure different fitting methods </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">TYPE</td><td></td></tr>
  </table>
  </dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a71193c5376cb6a732895c160d312d85c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; MeasureType &gt;::<a class="el" href="struct_ox_1_1_tomato_options.html">TomatoOptions</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>constructor with defaults </p>

</div>
</div>
<a class="anchor" id="a5c33d9488b728af994565639f75d9bba"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; MeasureType &gt;::<a class="el" href="struct_ox_1_1_tomato_options.html">TomatoOptions</a> </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>filePath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>constructor with parser </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6f291fb0d37adaf6d4b2167e9c75af3e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; MeasureType &gt;::~<a class="el" href="struct_ox_1_1_tomato_options.html">TomatoOptions</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>destructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a41d923f3ffea2007a75217f4f651219b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; MeasureType &gt;::exportToYaml </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="aaa834ee2985662cdefbdbe4279481b33"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; MeasureType &gt;::exportToYaml </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>filePath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="ac5b8f4b3fd18b6824188ddf0f39ab781"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; MeasureType &gt;::findInArray </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>nameArray</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>useful in looking for params defined in factories </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td></td></tr>
    <tr><td class="paramname">nameArray</td><td></td></tr>
    <tr><td class="paramname">name</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="a76497b53cadad720af7ff0f83b99096b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TYPE&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; TYPE &gt;::init </td>
          <td>(</td>
          <td class="paramname"></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>initialise the defaults done this way to work around delegating constructors in cpp98 </p>

</div>
</div>
<a class="anchor" id="a3a17d988d7ac73abef1ad2d79575ab30"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MeasureType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="struct_ox_1_1_tomato_options.html">Ox::TomatoOptions</a>&lt; MeasureType &gt;::printCurrent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>print current state of the struct </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>lib/<a class="el" href="_ox_factory_of_calculators_8h_source.html">OxFactoryOfCalculators.h</a></li>
<li>lib/<a class="el" href="_tomato_options_8h_source.html">TomatoOptions.h</a></li>
<li>lib/<a class="el" href="_tomato_options_8hxx_source.html">TomatoOptions.hxx</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>Ox</b></li><li class="navelem"><a class="el" href="struct_ox_1_1_tomato_options.html">TomatoOptions</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
back to top