<!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"/>
<title>DataConverter: FileConfigReader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">DataConverter&#160;<span id="projectnumber">1.0</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</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 id="searchli">
        <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="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">FileConfigReader Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="FileConfigReader" -->
<p>This class parses a converter configuration file.  
 <a href="classFileConfigReader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="FileConfigReader_8h_source.html">FileConfigReader.h</a>&gt;</code></p>

<p><a href="classFileConfigReader-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#ae83fe38cc761e9a0a7b95ae1ac0ecc43">FileConfigReader</a> (const string &amp;file_name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new object of the class.  <a href="#ae83fe38cc761e9a0a7b95ae1ac0ecc43"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#af4d6d93dfb299f95451d674a96963f37">~FileConfigReader</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Class destructor.  <a href="#af4d6d93dfb299f95451d674a96963f37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a271e567655d46ec23cdcca42c1deab91">UINTN</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#aac2a88c0bcab29cf36fe5bb43b5e373b">getOutputTraceLength</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the length of the trace to save.  <a href="#aac2a88c0bcab29cf36fe5bb43b5e373b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a271e567655d46ec23cdcca42c1deab91">UINTN</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#a563326884bf6888eb8986a05c29db8d4">getOutputTraceOffset</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of samples to ignore during the conversion.  <a href="#a563326884bf6888eb8986a05c29db8d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a271e567655d46ec23cdcca42c1deab91">UINTN</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#a86531cab49815921e99c1c10dc42961d">getOutputTracePerFile</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of traces to save in any output file.  <a href="#a86531cab49815921e99c1c10dc42961d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#ada0fff82d3ac61d387cd13f40ada5bad">getOutputPath</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the location where the output files will be saved.  <a href="#ada0fff82d3ac61d387cd13f40ada5bad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#a6cd39718f5bcfa0a29fd9a5e7b0f5e20">getOutputName</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of the output file to save.  <a href="#a6cd39718f5bcfa0a29fd9a5e7b0f5e20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#ac33a11b0630e7fd74be69179fc9b5634">getInputFormat</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the format of the input files (Lecroy, Agilent, txt).  <a href="#ac33a11b0630e7fd74be69179fc9b5634"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">vector&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#a36cc02e40332f97c5c8f8041247cea31">getFileList</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the list of the input files to convert with full path.  <a href="#a36cc02e40332f97c5c8f8041247cea31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#a66b21500ddf625da9b9aa665141bf75a">keyExists</a> (const string &amp;key) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a key exists in the list of parsed keys.  <a href="#a66b21500ddf625da9b9aa665141bf75a"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename ValueType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">ValueType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classFileConfigReader.html#a0c6b50cde92c7414955d52b6cb4504d8">getValueOfKey</a> (const string &amp;key, ValueType const &amp;defaultValue=ValueType()) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of a parsed key converted in ValueType.  <a href="#a0c6b50cde92c7414955d52b6cb4504d8"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class parses a converter configuration file. </p>
<p>The object created contains all the configuration settings used by the <a class="el" href="classFileReader.html" title="This class parses Lecroy or Agilent files.">FileReader</a> Class to parse Lecroy/Agilent files <br/>
 and used by the Converter to create the output files.<br/>
 The configuration file must contain lines in this format:<br/>
 </p>
<ul>
<li>the couple: keyValue = value </li>
<li>the special key <em>'file_list</em>:' followed by a full path list of the Lecroy/Agilent files<br/>
 </li>
<li>a comment line starts with '#' </li>
</ul>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae83fe38cc761e9a0a7b95ae1ac0ecc43"></a><!-- doxytag: member="FileConfigReader::FileConfigReader" ref="ae83fe38cc761e9a0a7b95ae1ac0ecc43" args="(const string &amp;file_name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FileConfigReader::FileConfigReader </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>file_name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates a new object of the class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">file_name</td><td>complete file name of the configuration file to parse </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af4d6d93dfb299f95451d674a96963f37"></a><!-- doxytag: member="FileConfigReader::~FileConfigReader" ref="af4d6d93dfb299f95451d674a96963f37" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FileConfigReader::~FileConfigReader </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Class destructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a36cc02e40332f97c5c8f8041247cea31"></a><!-- doxytag: member="FileConfigReader::getFileList" ref="a36cc02e40332f97c5c8f8041247cea31" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt; string &gt; FileConfigReader::getFileList </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the list of the input files to convert with full path. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the list of the input files to convert with full path </dd></dl>

</div>
</div>
<a class="anchor" id="ac33a11b0630e7fd74be69179fc9b5634"></a><!-- doxytag: member="FileConfigReader::getInputFormat" ref="ac33a11b0630e7fd74be69179fc9b5634" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FileConfigReader::getInputFormat </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the format of the input files (Lecroy, Agilent, txt). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the format of the input files (Lecroy, Agilent, txt) </dd></dl>

</div>
</div>
<a class="anchor" id="a6cd39718f5bcfa0a29fd9a5e7b0f5e20"></a><!-- doxytag: member="FileConfigReader::getOutputName" ref="a6cd39718f5bcfa0a29fd9a5e7b0f5e20" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string FileConfigReader::getOutputName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the name of the output file to save. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the name of the output file to save </dd></dl>

</div>
</div>
<a class="anchor" id="ada0fff82d3ac61d387cd13f40ada5bad"></a><!-- doxytag: member="FileConfigReader::getOutputPath" ref="ada0fff82d3ac61d387cd13f40ada5bad" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string FileConfigReader::getOutputPath </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the location where the output files will be saved. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the location where the output files will be saved </dd></dl>

</div>
</div>
<a class="anchor" id="aac2a88c0bcab29cf36fe5bb43b5e373b"></a><!-- doxytag: member="FileConfigReader::getOutputTraceLength" ref="aac2a88c0bcab29cf36fe5bb43b5e373b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="common_8h.html#a271e567655d46ec23cdcca42c1deab91">UINTN</a> FileConfigReader::getOutputTraceLength </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the length of the trace to save. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the trace to save in number of samples </dd></dl>

</div>
</div>
<a class="anchor" id="a563326884bf6888eb8986a05c29db8d4"></a><!-- doxytag: member="FileConfigReader::getOutputTraceOffset" ref="a563326884bf6888eb8986a05c29db8d4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="common_8h.html#a271e567655d46ec23cdcca42c1deab91">UINTN</a> FileConfigReader::getOutputTraceOffset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the number of samples to ignore during the conversion. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of samples to ignore during the conversion </dd></dl>

</div>
</div>
<a class="anchor" id="a86531cab49815921e99c1c10dc42961d"></a><!-- doxytag: member="FileConfigReader::getOutputTracePerFile" ref="a86531cab49815921e99c1c10dc42961d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="common_8h.html#a271e567655d46ec23cdcca42c1deab91">UINTN</a> FileConfigReader::getOutputTracePerFile </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the number of traces to save in any output file. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of traces to save in any output file </dd></dl>

</div>
</div>
<a class="anchor" id="a0c6b50cde92c7414955d52b6cb4504d8"></a><!-- doxytag: member="FileConfigReader::getValueOfKey" ref="a0c6b50cde92c7414955d52b6cb4504d8" args="(const string &amp;key, ValueType const &amp;defaultValue=ValueType()) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">ValueType FileConfigReader::getValueOfKey </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ValueType const &amp;&#160;</td>
          <td class="paramname"><em>defaultValue</em> = <code>ValueType()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the value of a parsed key converted in ValueType. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>name of the key </td></tr>
    <tr><td class="paramname">ValueType</td><td>data type of the value of the key </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the value of a parsed key converted in ValueType this function uses a template to get the value of the key converted in the desidered type. <br/>
 used type: unsigned int, string. </dd></dl>

</div>
</div>
<a class="anchor" id="a66b21500ddf625da9b9aa665141bf75a"></a><!-- doxytag: member="FileConfigReader::keyExists" ref="a66b21500ddf625da9b9aa665141bf75a" args="(const string &amp;key) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool FileConfigReader::keyExists </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Checks if a key exists in the list of parsed keys. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>name of the key </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the key was parsed, false otherwise </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="FileConfigReader_8h_source.html">FileConfigReader.h</a></li>
<li>FileConfigReader.cpp</li>
</ul>
</div>
<!-- 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></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>

<hr class="footer"/><address class="footer"><small>Generated on Tue Apr 19 2011 00:04:10 for DataConverter by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
