aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/3rdparty/lipi-toolkit/src/include/LTKShapeRecoConfig.h
blob: 1c9bc299b1541c9358a8d6e3383ad796293873c3 (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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*****************************************************************************************
* 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 LTKShapeRecoConfig which holds the configuration information read 
 *			   from the configuration files
 *
 * CONTENTS:   
 *
 * AUTHOR:     Balaji R.
 *
 * DATE:       December 23, 2004
 * CHANGE HISTORY:
 * Author		Date			Description of change
 ************************************************************************/

#ifndef __LTKSHAPERECOCONFIG_H
#define __LTKSHAPERECOCONFIG_H

#include "LTKTypes.h"

/**
 * @class LTKShapeRecoConfig
 * <p> This class contains data about the location of the configuration files which are to be
 * loaded during the instanatiation of various shape recognizers. It is passed as an argument during
 * the instantiation of a shape recognizer</p>
 */

class LTKShapeRecoConfig
{

private:

	string m_lipiRoot;				//	root path of the lipi tool kit

	string m_shapeSet;				//	shapeset of the recognition problem

	string m_profile;				//	profile of the recognition problem

	string m_shapeRecognizerName;	//	logical name of the shape recognizer

	int m_numShapes;				//	number of shapes in the recognition problem

public:

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

	/**
	 * Default Constructor
	 */

	LTKShapeRecoConfig();

	/**
	 * This constructor takes various arguments which are used to intialize the members of
	 * this class during its instantiation.
	 * @param lipiRoot Root path of Lipi Toolkit
	 * @param shapeSet Shape set
	 * @param profile Profile name
	 * @param shapeRecongizerName Name of the shape recognizer
	 * @param numShapes number of shapes in the recognition problem
	 */

	LTKShapeRecoConfig(const string& lipiRoot, const string& shapeSet, const string& profile, 
		      const string& shapeRecognizerName, int numShapes);

	/**
	 * Destructor
	 */

	~LTKShapeRecoConfig();

	// @}

	/**
	 * @name Methods
	 */

	// @{

	/**
	 * This function reads the configuration information from the config files
	 * @param configFile - full path of the main configuration file
	 *
	 * @return SUCCESS on successful read operation
	 */

	int readConfigInfo(const string& configFile);

	// @}

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

	/**
	 * This function returns the Lipi Root
	 * @param void
	 *
	 * @return Lipi Root.
	 */

	const string& getLipiRoot();

	/**
	 * This function returns the Shape Set Directory name
	 * @param void
	 *
	 * @return Shape Set Directory name.
	 */

	const string& getShapeSet();

	/**
	 * This function returns the Profile Directory name
	 * @param void
	 *
	 * @return Profile Directory name.
	 */

	const string& getProfile();

	/**
	 * This function returns the shape recognizer name
	 * @param void
	 *
	 * @return shape recognizer name.
	 */

	const string& getShapeRecognizerName();

	/**
	 * This function returns the number of shapes in the recognition problem
	 * @param void
	 *
	 * @return number of shapes in the recognition problem.
	 */

	int getNumShapes();

	// @}

	/**
	 * @name Setter Functions
	 */

	// @{

	/**
	 * This function sets the Lipi Root Path
	 * @param lipiRootStr Lipi Root Path
	 */

	int setLipiRoot(const string& lipiRootStr);

	/**
	 * This function sets the Shape Set Directory name
	 * @param shapeSetStr Shape Set Directory name
	 */

	int setShapeSet(const string& shapeSetStr);

	/**
	 * This function sets the Profile Directory name
	 * @param profileStr Profile Directory name
	 */

	int setProfile(const string& profileStr);

	/**
	 * This function sets shape recognizer name
	 * @param shapeRecognizerName shape recognizer name
	 */

	int setShapeRecognizerName(const string& shapeRecognizerName);

	/**
	 * This function sets number of shapes in the recognition problem
	 * @param numShapes number of shapes in the recognition problem
	 */

	int setNumShapes(int numShapes);

	// @}

};

#endif

//#ifndef __LTKSHAPERECOCONFIG_H
//#define __LTKSHAPERECOCONFIG_H