aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/lipi-toolkit/3rdparty/lipi-toolkit/src/include/LTKCaptureDevice.h
blob: 5acb9838b71ff27b49632af4dd40096f6b24530c (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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/******************************************************************************
* Copyright (c) 2006 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 LTKCaptureDevice which holds the information about
 * the digitizer.
 *
 * CONTENTS:   
 *
 * AUTHOR:     Balaji R.
 *
 * DATE:       December 23, 2004
 * CHANGE HISTORY:
 * Author		Date			Description of change
 *****************************************************************************/

#ifndef __LTKCAPTUREDEVICE_H
#define __LTKCAPTUREDEVICE_H

#include "LTKInc.h"

/**
 * @class LTKCaptureDevice
 * <p> This class contains meta-data about hardware that was used to acquire
 * the ink contained in a file. </p>
 */

class LTKCaptureDevice
{
private:

	int m_samplingRate;			//	sampling rate of the device

	int m_xDpi;					//	horizontal direction resolution of the device

	int m_yDpi;					//	vertical direction resolution of the device	

	float m_latency;			//	interval between the time of actual input 
								//  to that of its registration

	bool m_isUniformSamplingRate;	// flag to indicate if the sampling is uniform

public:

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

	/**
	 * Default Constructor
	 */

	LTKCaptureDevice();

	/**
	 * This constrcutor takes various paramaters about a digitizer.
	 * @param sRate   The sampling rate of bits
	 * @param uniform Indicates the consistency of sampling rate 
	 * @param lVaue   Device latency (in milliseconds) that applies to all channels
	 * @param xDpi    Dots per inch in horizontal direction.
	 * @param yDpi    Dots per inch in vertical direction.
	 */

	LTKCaptureDevice(int sRate, bool uniform, float lValue, int xDpi, int yDpi);

	/**
	 * Copy constructor
	 */

	LTKCaptureDevice(const LTKCaptureDevice& captureDevice);

	/** Destructor */

	~LTKCaptureDevice();

	// @}

	/** 
	 * @name Assignment operator
	 */
	// @{

	/**
	 * Assignment operator
	 * @param captureDevice The object that has to be copied by assignment
	 *
	 * @return LTKCaptureDevice object
	 */

	LTKCaptureDevice& operator=(const LTKCaptureDevice& captureDevice);
	// @}

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

	/**
	 * This function returns the sampling rate measured in samples/sec
	 * @param void
	 *
	 * @return Sampling rate of bits.
	 */

	int getSamplingRate() const;

	/**
	 * This fucntion returns the latency of the real-time channel,
	 * in msec, from physical action to the API time stamp.
	 * @param void
	 * 
	 * @return Basic device latency in milli seconds.
	 */

	float getLatency() const;

	/**
	 * This function returns dots per inch in X direction.
	 * @param void
	 * 
	 * @return X dpi of the device
	 */

	int getXDPI() const;

	/**
	 * This function returns dots per inch in Y direction.
	 * @param void
	 * 
	 * @return Y dpi of the device
	 */

	int getYDPI()  const;

	/**
	 * This function returns a boolean to indicate if the sampling rate is 
	 * regular or irregular
	 * @param void
	 * 
	 * @return If the device samples the points uniformly or non-uniformly
	 */

	bool isUniformSampling()  const;
	// @}

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

	/**
	 * This function sets the sampling rate of the device
	 * @param samplingRate Sampling rate of the device
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setSamplingRate(int samplingRate);

	/**
	 * This fucntion returns the latency of the outputs from the device
	 * in msec, from physical action to the API time stamp.
	 * @param latency Latency of the device
	 * 
	 * @return SUCCESS on successful set operation
	 */

	 int setLatency(float latency);

	/**
	 * This function sets the boolean to indicate the consistency of sampling rate.
	 * @param isUniform True if sampling ir regular, False if irregular
	 *
	 * @return SUCCESS on successful set operation
	 */

	void setUniformSampling(bool isUniform);

	/**
	 * This function sets the value for dots per inch to be taken in X direction.
	 * @param xDpi The dots per inch in X direction.
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setXDPI(int xDpi);

	/**
	 * This function sets the value for dots per inch to be taken in Y diretion.
	 * @param yDpi The dots per inch in Y direction.
	 *
	 * @return SUCCESS on successful set operation
	 */

	int setYDPI(int yDpi);
	// @}

};

#endif

//#ifndef __LTKCAPTUREDEVICE_H
//#define __LTKCAPTUREDEVICE_H