<!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>FONTAINE: OrthographyResults.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<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">FONTAINE <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 Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>OrthographyResults.h</h1> </div>
</div>
<div class="contents">
<a href="OrthographyResults_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// The Fontaine Font Analysis Project </span>
<a name="l00003"></a>00003 <span class="comment">// </span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (c) 2009 by Edward H. Trager</span>
<a name="l00005"></a>00005 <span class="comment">// All Rights Reserved</span>
<a name="l00006"></a>00006 <span class="comment">// </span>
<a name="l00007"></a>00007 <span class="comment">// Released under the GNU GPL version 2.0 or later.</span>
<a name="l00008"></a>00008 <span class="comment">// </span>
<a name="l00009"></a>00009
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012 <span class="comment">// OrthographyAnalysis</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="preprocessor">#ifndef ORTHOGRAPHY_RESULTS</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#define ORTHOGRAPHY_RESULTS</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <string></span>
<a name="l00018"></a>00018 <span class="preprocessor">#include <set></span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <vector></span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="OrthographyData_8h.html">OrthographyData.h</a>"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="Utf8String_8h.html">Utf8String.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <string.h></span>
<a name="l00025"></a>00025
<a name="l00026"></a><a class="code" href="classOrthographyResults.html">00026</a> <span class="keyword">class </span><a class="code" href="classOrthographyResults.html">OrthographyResults</a>{
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">public</span>:
<a name="l00029"></a>00029
<a name="l00030"></a><a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaacca1dfe8f1c7094df14bf7f569544d8480a">00030</a> <span class="keyword">enum</span> <a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaacc">SUPPORTLEVEL</a> { <a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaacca1dfe8f1c7094df14bf7f569544d8480a">UNSUPPORTED</a>=0, <a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaacca0ca71727c387a9a1d0dafc3c00b0c745">FRAGMENTARY</a>, <a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaaccaf57f557c78ccfa2bfc0a9e96c1e952e8">PARTIAL</a>, <a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaacca02f54bc9ecf3d2d1c99b14d3493fe12d">FULL</a> };
<a name="l00031"></a>00031 <span class="comment">//</span>
<a name="l00032"></a>00032 <span class="comment">// Minimum allowable coverage to be considered</span>
<a name="l00033"></a>00033 <span class="comment">// as having "partial support":</span>
<a name="l00034"></a>00034 <span class="comment">// </span>
<a name="l00035"></a><a class="code" href="classOrthographyResults.html#a1c1534f9fa2dfb264cc86f780e735a8c">00035</a> <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classOrthographyResults.html#a1c1534f9fa2dfb264cc86f780e735a8c">minCoverage</a>=80;
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">//</span>
<a name="l00038"></a>00038 <span class="comment">// Comparison Functor:</span>
<a name="l00039"></a>00039 <span class="comment">//</span>
<a name="l00040"></a><a class="code" href="structOrthographyResults_1_1compare.html">00040</a> <span class="keyword">struct </span><a class="code" href="structOrthographyResults_1_1compare.html">compare</a>{
<a name="l00041"></a><a class="code" href="structOrthographyResults_1_1compare.html#a56a5f8c58b0bd4c4c883916035f88c7f">00041</a> <span class="keywordtype">bool</span> <a class="code" href="structOrthographyResults_1_1compare.html#a56a5f8c58b0bd4c4c883916035f88c7f">operator()</a>(<span class="keyword">const</span> <a class="code" href="classOrthographyResults.html">OrthographyResults</a> *o1,<span class="keyword">const</span> <a class="code" href="classOrthographyResults.html">OrthographyResults</a> *o2)<span class="keyword"> const</span>{
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keywordflow">return</span> strcmp(o1-><a class="code" href="classOrthographyResults.html#afcd69d90aecda73af54855ed6c8b2b4c">_pData</a>-><a class="code" href="classOrthographyData.html#a20591f9a381cf06e12160ccbf42580d5">commonName</a>,o2-><a class="code" href="classOrthographyResults.html#afcd69d90aecda73af54855ed6c8b2b4c">_pData</a>-><a class="code" href="classOrthographyData.html#a20591f9a381cf06e12160ccbf42580d5">commonName</a>) < 0;
<a name="l00044"></a>00044
<a name="l00045"></a>00045 }
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">private</span>:
<a name="l00049"></a>00049
<a name="l00050"></a><a class="code" href="classOrthographyResults.html#afcd69d90aecda73af54855ed6c8b2b4c">00050</a> <span class="keyword">const</span> <a class="code" href="classOrthographyData.html">OrthographyData</a> *<a class="code" href="classOrthographyResults.html#afcd69d90aecda73af54855ed6c8b2b4c">_pData</a>;
<a name="l00051"></a>00051
<a name="l00052"></a><a class="code" href="classOrthographyResults.html#a79ce54cdd08d9f6d7cc3bef18f2b99f2">00052</a> <a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> <a class="code" href="classOrthographyResults.html#a79ce54cdd08d9f6d7cc3bef18f2b99f2">_hits</a>;
<a name="l00053"></a><a class="code" href="classOrthographyResults.html#afcc8b27f86cb0ce1f6fdeede0eb7adeb">00053</a> <a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> <a class="code" href="classOrthographyResults.html#afcc8b27f86cb0ce1f6fdeede0eb7adeb">_tries</a>;
<a name="l00054"></a><a class="code" href="classOrthographyResults.html#a75426ae4aa38d62093ee2e7222be920f">00054</a> <a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaacc">SUPPORTLEVEL</a> <a class="code" href="classOrthographyResults.html#a75426ae4aa38d62093ee2e7222be920f">_supportLevel</a>;
<a name="l00055"></a>00055
<a name="l00056"></a><a class="code" href="classOrthographyResults.html#a3fac74c6b1e9589808908da0ec0efaba">00056</a> std::vector<UTF32> <a class="code" href="classOrthographyResults.html#a3fac74c6b1e9589808908da0ec0efaba">_missingValues</a>;
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">// Report missing state flag:</span>
<a name="l00059"></a><a class="code" href="classOrthographyResults.html#a025d8ec8f37d3a70bf098c7bf926fcd8">00059</a> <span class="keywordtype">bool</span> <a class="code" href="classOrthographyResults.html#a025d8ec8f37d3a70bf098c7bf926fcd8">_reportMissing</a>;
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">public</span>:
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">//</span>
<a name="l00064"></a>00064 <span class="comment">// Constructors:</span>
<a name="l00065"></a>00065 <span class="comment">//</span>
<a name="l00066"></a>00066 <a class="code" href="classOrthographyResults.html#ab95eee5ed09884dd615511f6a6f63004">OrthographyResults</a>(<span class="keyword">const</span> <a class="code" href="classOrthographyData.html">OrthographyData</a> *<a class="code" href="namespaceAladdinFreePublicLicense.html#a13951d9b098b78427527cd2da8d8648f">pData</a>,<a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> hits,<a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> tries,std::vector<UTF32> &missing);
<a name="l00067"></a>00067 <a class="code" href="classOrthographyResults.html#ab95eee5ed09884dd615511f6a6f63004">OrthographyResults</a>(<span class="keyword">const</span> <a class="code" href="classOrthographyData.html">OrthographyData</a> *<a class="code" href="namespaceAladdinFreePublicLicense.html#a13951d9b098b78427527cd2da8d8648f">pData</a>,<a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> hits, <a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> tries);
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">//</span>
<a name="l00070"></a>00070 <span class="comment">// Destructor</span>
<a name="l00071"></a>00071 <span class="comment">//</span>
<a name="l00072"></a>00072 <a class="code" href="classOrthographyResults.html#a4ecf7a2aaf3ab4fc38649abb21c093f2">~OrthographyResults</a>();
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> <a class="code" href="classOrthographyResults.html#ab2e8b34225d85f248eba8dd886f9b616">getHits</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00075"></a>00075 <a class="code" href="OrthographyData_8h.html#ae1e6edbbc26d6fbc71a90190d0266018">UINT32</a> <a class="code" href="classOrthographyResults.html#a34467a5ebb887735bcfcd4e205c3858e">getTries</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00076"></a>00076 <span class="keywordtype">int</span> <a class="code" href="classOrthographyResults.html#a46c761fe5b191e7c95b990216702d541">getPercentCoverage</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00077"></a>00077 <a class="code" href="classOrthographyResults.html#a4713051284bbb832b28ab80206cdaacc">SUPPORTLEVEL</a> <a class="code" href="classOrthographyResults.html#a820397028b6b22f451a08bdcf30f35af">getSupportLevel</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00078"></a>00078 <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="classOrthographyResults.html#a2524326a3385643da2acde874ea4cbbf">getSupportLevelAsCString</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00079"></a>00079 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOrthographyResults.html#a2f16ebd528e9eb4a77f037d6985a94b3">getCommonName</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00080"></a>00080 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOrthographyResults.html#aed23341491514c0c178eb4d3e0e9009c">getNativeName</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00081"></a>00081 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOrthographyResults.html#a50291e3f1661df527f36b282fa295447">getSampleCharacters</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00082"></a>00082 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOrthographyResults.html#a268ba144b70b83db18f90ffb0035a16a">getSampleSentence</a>(<span class="keywordtype">int</span> nth) <span class="keyword">const</span>;
<a name="l00083"></a>00083 std::string <a class="code" href="classOrthographyResults.html#a31427b85ca3e9e739955dcac967a52e9">getMissingValuesAsString</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 std::string <a class="code" href="classOrthographyResults.html#a12dd16373cbb4be99794873a70ad8dfb">getReport</a>(<span class="keywordtype">bool</span> reportMissing) <span class="keyword">const</span>;
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordtype">void</span> <a class="code" href="classOrthographyResults.html#a7180d34692e1aae3d722675373fd72cc">setReportOnMissing</a>(<span class="keywordtype">bool</span> x);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">private</span>:
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOrthographyResults.html#a9d2c4d94c0a1ef067a30288715ddfbdf">UTF32ValueToUTF8</a>( <a class="code" href="Utf8String_8h.html#a0ae75062ae07deca9402a1fb245818b7">UTF32</a> UTF32Value ) <span class="keyword">const</span>;
<a name="l00092"></a>00092
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for FONTAINE by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
