aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/3rdparty/lipi-toolkit/src/include/LTKWordRecoConfig.h
blob: 535b4c2a4457df3def7e71d38354d022c6a130fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*****************************************************************************************
* Copyright (c) 2007 Hewlett-Packard Development Company, L.P.
* Permission is hereby granted, free of charge, to any person obtaining a copy of 
* this software and associated documentation files (the "Software"), to deal in 
* the Software without restriction, including without limitation the rights to use, 
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the 
* Software, and to permit persons to whom the Software is furnished to do so, 
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
*****************************************************************************************/

/************************************************************************
 * SVN MACROS
 *
 * $LastChangedDate: 2008-07-18 15:00:39 +0530 (Fri, 18 Jul 2008) $
 * $Revision: 561 $
 * $Author: sharmnid $
 *
 ************************************************************************/
 
/************************************************************************
 * FILE DESCR: Definition of LTKWordRecoConfig holds the config data for 
 *			   the recognizer at the time of loading.
 *
 * CONTENTS:   
 *
 * AUTHOR:     Mudit Agrawal
 *
 * DATE:       Mar 2, 2005
 * CHANGE HISTORY:
 * Author		Date			Description of change
 * Deepu        24-MAR-2005     Added getGrammarPath
 * 
 ************************************************************************/

#ifndef __LTKWORDRECOCONFIG_H
#define __LTKWORDRECOCONFIG_H

#include "LTKInc.h"
#include "LTKTypes.h"

/**
* @class LTKWordRecoConfig
* <p> This class contains the config data for the recognizer at the time of loading </p>
*/

class LTKWordRecoConfig  
{
private:
	string m_classifierName;				//name of the classifier to be loaded

	string m_dictionaryPath;				//path where dictionaries are present

	string m_grammarPath;					//path where grammar is present

	string m_lipiRoot;						//specifies the lipi root directory

	string m_problemName;					//specifies the logical name for the problem of recognition. e.g. devanagari-word-recognition

	string m_profile;						//refers to main.cfg. This in turn refers to word.cfg and profile.cfg

	string m_script;						//script that is to be recognized

public:
	/**
	 * @name Constructors and Destructor
	 */
	// @{

	/**
	 * Default Constructor
	 */

	LTKWordRecoConfig();

	/**
	 * This constrcutor takes one paramater about the recognizer
	 * @param lipiRoot
	 */

	LTKWordRecoConfig(const string& lipiRoot);

	
	/** Destructor */

	~LTKWordRecoConfig();
	
	// @}

	/**
	 * @name Getter Functions
	 */
	// @{

	/**
	 * This function returns the classifier name
	 * @param void
	 *
	 * @return classifier name
	 */

	string getClassifierName() const;

	/**
	 * This function returns the Dictionary Path
	 * @param void
	 *
	 * @return Dictionary Path
	 */

	string getDictionaryPath() const;

	/**
	 * This function returns the Grammar Path
	 * @param void
	 *
	 * @return Grammar Path
	 */

	string getGrammarPath() const;

	/**
	 * This function returns the lipi root
	 * @param void
	 *
	 * @return lipi root
	 */

	string getLipiRoot() const;

	/**
	 * This function returns the profile
	 * @param void
	 *
	 * @return profile
	 */

	string getProfile() const;

	/**
	 * This function returns the script
	 * @param void
	 *
	 * @return script name
	 */

	string getScript() const;

	/**
	 * This function returns the problem Name
	 * @param void
	 *
	 * @return problem Name
	 */

	string getProblemName() const;

	/**
	 * @name Setter Functions
	 */
	// @{

	/**
	 * This function reads the main config file and inturn other config files also (defined in main.cfg)
	 * 
	 * @param path of the main config file
	 *
	 * @return SUCCESS on successful read operation of all config files
	 */

	int readConfigFile(const string& configFileName);

	/**
	 * @name Setter Functions
	 */
	// @{

	/**
	 * This function sets the lipi root 
	 * 
	 * @param lipi root
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setLipiRoot(const string& lipiRoot);



};


#endif