Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/example_recognizer_8cpp-source.html
Week 12 contribution of SDK documentation_content. See release notes for details. Fixes Bug 1892, Bug 1522, Bug 1520, Bug 394, Bug 1319, Bug 344, Bug 1897
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/AppFramework/Recogniser/exampleRecognizer.cpp Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/AppFramework/Recogniser/exampleRecognizer.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">// EXAMPLE RECOGNIZER </span>
<a name="l00015"></a>00015 <span class="comment">// This example code demonstrates how to write a simple data recognizer.</span>
<a name="l00016"></a>00016 <span class="comment">//</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#include <eikenv.h></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <implementationproxy.h></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// User include</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "exampleRecognizer.h"</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">const</span> TInt KNumDataTypes = 1;
<a name="l00026"></a>00026 <span class="keyword">const</span> TUid KExampleDllUid = {0xE8000002};
<a name="l00027"></a>00027 <span class="keyword">const</span> TInt KImplementationUid = 0x101F7DA1;
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">// An example mime type</span>
<a name="l00030"></a>00030 _LIT8(KExampleTextMimeType, <span class="stringliteral">"text/example"</span>);
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">/*</span>
<a name="l00033"></a>00033 <span class="comment">Constructor - sets the number of supported mime types, </span>
<a name="l00034"></a>00034 <span class="comment">the recognizer's priority and its UID.</span>
<a name="l00035"></a>00035 <span class="comment">*/</span>
<a name="l00036"></a><a class="code" href="class_c_example_new_recognizer.html#933a0383bea3071dabdfce8a53493c9a">00036</a> <a class="code" href="class_c_example_new_recognizer.html#933a0383bea3071dabdfce8a53493c9a">CExampleNewRecognizer::CExampleNewRecognizer</a>():CApaDataRecognizerType(KExampleDllUid, CApaDataRecognizerType::EHigh)
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 iCountDataTypes = KNumDataTypes;
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">/*</span>
<a name="l00042"></a>00042 <span class="comment">Specifies this recognizer's preferred data buffer size passed to DoRecognizeL().</span>
<a name="l00043"></a>00043 <span class="comment">The actual value used will be the maximum of all recognizers.</span>
<a name="l00044"></a>00044 <span class="comment">*/</span>
<a name="l00045"></a><a class="code" href="class_c_example_new_recognizer.html#d5f530475f7458bf47f3ccedd5b0df2c">00045</a> TUint <a class="code" href="class_c_example_new_recognizer.html#d5f530475f7458bf47f3ccedd5b0df2c">CExampleNewRecognizer::PreferredBufSize</a>()
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 <span class="keywordflow">return</span> 24;
<a name="l00048"></a>00048 }
<a name="l00049"></a>00049
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">/*</span>
<a name="l00052"></a>00052 <span class="comment">Returns the indexed data type that the recognizer can recognize. </span>
<a name="l00053"></a>00053 <span class="comment">In this case, only 1 is supported. </span>
<a name="l00054"></a>00054 <span class="comment">*/</span>
<a name="l00055"></a><a class="code" href="class_c_example_new_recognizer.html#811d7d944137653d931980feb884004b">00055</a> TDataType <a class="code" href="class_c_example_new_recognizer.html#811d7d944137653d931980feb884004b">CExampleNewRecognizer::SupportedDataTypeL</a>(TInt <span class="comment">/*aIndex*/</span>)<span class="keyword"> const</span>
<a name="l00056"></a>00056 <span class="keyword"> </span>{
<a name="l00057"></a>00057 <span class="keywordflow">return</span> TDataType(KExampleTextMimeType);
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">/*</span>
<a name="l00061"></a>00061 <span class="comment">Attempts to recognize the data type, given the filename and data buffer.</span>
<a name="l00062"></a>00062 <span class="comment">*/</span>
<a name="l00063"></a>00063 <span class="keywordtype">void</span> CExampleNewRecognizer::DoRecognizeL(<span class="keyword">const</span> TDesC& aName, <span class="keyword">const</span> TDesC8& aBuffer)
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065 _LIT8(KExampleData, <span class="stringliteral">"example"</span>);
<a name="l00066"></a>00066 _LIT(KDotExample, <span class="stringliteral">".Example"</span>);
<a name="l00067"></a>00067
<a name="l00068"></a>00068 TParse parse;
<a name="l00069"></a>00069 parse.Set(aName,NULL,NULL);
<a name="l00070"></a>00070 TPtrC ext=parse.Ext(); <span class="comment">// extract the extension from the filename</span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keywordflow">if</span> (ext.CompareF(KDotExample)==0 && aBuffer.FindF(KExampleData)!=KErrNotFound)
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074 iConfidence=ECertain;
<a name="l00075"></a>00075 iDataType=TDataType(KExampleTextMimeType);
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">/*</span>
<a name="l00080"></a>00080 <span class="comment">The ECom implementation creation function.</span>
<a name="l00081"></a>00081 <span class="comment">*/</span>
<a name="l00082"></a><a class="code" href="class_c_example_new_recognizer.html#29ec4835d1660cb5bce9c2271827db7a">00082</a> CApaDataRecognizerType* <a class="code" href="class_c_example_new_recognizer.html#29ec4835d1660cb5bce9c2271827db7a">CExampleNewRecognizer::CreateRecognizerL</a>()
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 <span class="keywordflow">return</span> <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_example_new_recognizer.html">CExampleNewRecognizer</a>;
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/*</span>
<a name="l00088"></a>00088 <span class="comment">Standard ECom framework code </span>
<a name="l00089"></a>00089 <span class="comment">*/</span>
<a name="l00090"></a>00090 <span class="keyword">const</span> TImplementationProxy ImplementationTable[] =
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 IMPLEMENTATION_PROXY_ENTRY(KImplementationUid,<a class="code" href="class_c_example_new_recognizer.html#29ec4835d1660cb5bce9c2271827db7a">CExampleNewRecognizer::CreateRecognizerL</a>)
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">/*</span>
<a name="l00096"></a>00096 <span class="comment">Standard ECom framework code </span>
<a name="l00097"></a>00097 <span class="comment">*/</span>
<a name="l00098"></a>00098 EXPORT_C <span class="keyword">const</span> TImplementationProxy* ImplementationGroupProxy(TInt& aTableCount)
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 aTableCount = <span class="keyword">sizeof</span>(ImplementationTable) / <span class="keyword">sizeof</span>(TImplementationProxy);
<a name="l00101"></a>00101 <span class="keywordflow">return</span> ImplementationTable;
<a name="l00102"></a>00102 }
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:54 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>