epoc32/include/mmf/common/speechrecognitiondataclient.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __SPEECHRECOGNITIONDATACLIENT_H__
williamr@2
    17
#define __SPEECHRECOGNITIONDATACLIENT_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
#include <s32strm.h>
williamr@2
    21
williamr@2
    22
//  INCLUDES
williamr@2
    23
#include <mmf/common/mmfcontrollerframework.h>
williamr@2
    24
#include <mmf/common/speechrecognitiondatacommon.h>
williamr@2
    25
williamr@2
    26
williamr@2
    27
// FORWARD DECLARATION
williamr@2
    28
class TDiagnostic;
williamr@2
    29
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
@publishedAll
williamr@2
    35
@released
williamr@2
    36
williamr@2
    37
Class to encapsulate a client recognition result.
williamr@2
    38
The result is formulated for client consumption.
williamr@2
    39
williamr@2
    40
@since  8.0
williamr@2
    41
*/
williamr@2
    42
class CSDClientResult : public CBase
williamr@2
    43
	{
williamr@2
    44
public:	 // Constructors and destructor
williamr@2
    45
	/**
williamr@2
    46
	Destructor.
williamr@2
    47
	*/
williamr@2
    48
	IMPORT_C ~CSDClientResult();
williamr@2
    49
williamr@2
    50
	/**
williamr@2
    51
	Two-phased constructor. Creates an uninitialised recognition result.
williamr@2
    52
williamr@2
    53
	Can leave with one of the system-wide error codes
williamr@2
    54
	
williamr@2
    55
	@return CSDClientResult object
williamr@2
    56
	*/
williamr@2
    57
	IMPORT_C static CSDClientResult* NewL();
williamr@2
    58
williamr@2
    59
	/**
williamr@2
    60
	Two-phased constructor. Creates an uninitialised recognition result. A copy of the newly created class
williamr@2
    61
	is pushed onto the cleanup stack.
williamr@2
    62
williamr@2
    63
	Can leave with one of the system-wide error codes.
williamr@2
    64
	
williamr@2
    65
	@return CSDClientResult object
williamr@2
    66
	*/
williamr@2
    67
	IMPORT_C static CSDClientResult* NewLC();
williamr@2
    68
williamr@2
    69
	/**
williamr@2
    70
	Two-phased constructor. Creates a result with a grammar and rule ID.
williamr@2
    71
williamr@2
    72
	Can leave with one of the system-wide error codes.
williamr@2
    73
williamr@2
    74
	@param  aGrammarID
williamr@2
    75
	        The grammar ID of the result.
williamr@2
    76
	@param  aRuleID
williamr@2
    77
	        The rule ID of the result.
williamr@2
    78
	        
williamr@2
    79
	@return CSDClientResult object.
williamr@2
    80
	*/
williamr@2
    81
	IMPORT_C static CSDClientResult* NewL(TGrammarID aGrammarID, TRuleID aRuleID);
williamr@2
    82
williamr@2
    83
	/**
williamr@2
    84
	Two-phased constructor. Creates a result with a grammar and rule ID. A copy of the newly created class
williamr@2
    85
	is pushed onto the cleanup stack.
williamr@2
    86
williamr@2
    87
	Can leave with one of the system-wide error codes.
williamr@2
    88
williamr@2
    89
	@param  aGrammarID
williamr@2
    90
	        The grammar ID of the result
williamr@2
    91
	@param  aRuleID
williamr@2
    92
	        The rule ID of the result
williamr@2
    93
	        
williamr@2
    94
	@return CSDClientResult object.
williamr@2
    95
	*/
williamr@2
    96
	IMPORT_C static CSDClientResult* NewLC(TGrammarID aGrammarID, TRuleID aRuleID);
williamr@2
    97
williamr@2
    98
	/**
williamr@2
    99
	Sets the grammar ID on the result.
williamr@2
   100
williamr@2
   101
	@param  aGrammarID
williamr@2
   102
	        The grammar identifier.
williamr@2
   103
williamr@2
   104
	@since 8.0
williamr@2
   105
	*/
williamr@2
   106
	IMPORT_C void SetGrammarID(TGrammarID aGrammarID);
williamr@2
   107
williamr@2
   108
	/**
williamr@2
   109
	Retrieves the grammar ID of the result.
williamr@2
   110
williamr@2
   111
	@return Grammar identifier.
williamr@2
   112
	@since  8.0
williamr@2
   113
	*/
williamr@2
   114
	IMPORT_C TGrammarID GrammarID() const;
williamr@2
   115
williamr@2
   116
	/**
williamr@2
   117
	Sets the rule ID of the result.
williamr@2
   118
williamr@2
   119
	@param  aRuleID
williamr@2
   120
	        The rule identifier.
williamr@2
   121
williamr@2
   122
	@since  8.0
williamr@2
   123
	*/
williamr@2
   124
	IMPORT_C void SetRuleID(TRuleID aRuleID);
williamr@2
   125
williamr@2
   126
	/**
williamr@2
   127
	Returns the rule ID of the result.
williamr@2
   128
williamr@2
   129
	@return The rule identifier.
williamr@2
   130
	@since  8.0
williamr@2
   131
	*/
williamr@2
   132
	IMPORT_C TRuleID RuleID() const;
williamr@2
   133
williamr@2
   134
	/**
williamr@2
   135
	@internalTechnology
williamr@2
   136
	
williamr@2
   137
	Writes the class to a stream.
williamr@2
   138
williamr@2
   139
	@param  aStream
williamr@2
   140
	        A RWriteStream to write the class to.
williamr@2
   141
williamr@2
   142
	@since  8.0
williamr@2
   143
	*/
williamr@2
   144
	void ExternalizeL(RWriteStream& aStream) const;
williamr@2
   145
	/**
williamr@2
   146
	@internalTechnology
williamr@2
   147
	
williamr@2
   148
	Reads the class from a stream.
williamr@2
   149
williamr@2
   150
	@param  aStream
williamr@2
   151
	        A RReadStream to read from.
williamr@2
   152
williamr@2
   153
	@since  8.0
williamr@2
   154
	*/
williamr@2
   155
	void InternalizeL(RReadStream& aStream);
williamr@2
   156
williamr@2
   157
private:
williamr@2
   158
	void ConstructL();
williamr@2
   159
	CSDClientResult();
williamr@2
   160
	CSDClientResult(TGrammarID aGrammarID, TRuleID aRuleID);
williamr@2
   161
williamr@2
   162
williamr@2
   163
private:
williamr@2
   164
	TGrammarID iGrammarID;
williamr@2
   165
	TRuleID iRuleID;
williamr@2
   166
	};
williamr@2
   167
williamr@2
   168
williamr@2
   169
/**
williamr@2
   170
@publishedAll
williamr@2
   171
@released
williamr@2
   172
williamr@2
   173
Class to encapsulate a client recogntion result set
williamr@2
   174
This is a lightweight result set formulated for client consumption
williamr@2
   175
williamr@2
   176
@since  8.0
williamr@2
   177
*/
williamr@2
   178
class CSDClientResultSet : public CBase
williamr@2
   179
	{
williamr@2
   180
public:	// Constructors and destructor
williamr@2
   181
	/**
williamr@2
   182
	Destructor.
williamr@2
   183
	*/
williamr@2
   184
	IMPORT_C ~CSDClientResultSet();
williamr@2
   185
williamr@2
   186
	/**
williamr@2
   187
	Two-phased constructor.
williamr@2
   188
	
williamr@2
   189
	@return CSDClientResultSet object.
williamr@2
   190
	*/
williamr@2
   191
	IMPORT_C static CSDClientResultSet* NewL();
williamr@2
   192
williamr@2
   193
	/**
williamr@2
   194
	Two-phased constructor. Pushes the newly created object onto the cleanup stack
williamr@2
   195
	
williamr@2
   196
	@return CSDClientResultSet object.
williamr@2
   197
	*/
williamr@2
   198
	IMPORT_C static CSDClientResultSet* NewLC();
williamr@2
   199
williamr@2
   200
williamr@2
   201
	/**
williamr@2
   202
	Sets the maximum number of best matches (N-best) expected in the recognition result after 
williamr@2
   203
	recognition.
williamr@2
   204
williamr@2
   205
	@param  aMaxResults
williamr@2
   206
	        The maximum number of matches expected in the recognition result.
williamr@2
   207
williamr@2
   208
	@since  8.0
williamr@2
   209
	*/
williamr@2
   210
	IMPORT_C void SetMaxResultsL(TInt aMaxResults);
williamr@2
   211
williamr@2
   212
	/**
williamr@2
   213
	Returns the current value of the max number of expected after recognition.
williamr@2
   214
williamr@2
   215
	@return The maximum number of best matches (N-best) expected in the recognition result.
williamr@2
   216
williamr@2
   217
	@since  8.0
williamr@2
   218
	*/
williamr@2
   219
	IMPORT_C TInt MaxResults() const;
williamr@2
   220
williamr@2
   221
	/**
williamr@2
   222
	Returns a result at a given index within the result set.
williamr@2
   223
williamr@2
   224
	@param  aIndex 
williamr@2
   225
	        The index of result to return.
williamr@2
   226
williamr@2
   227
	@return A pointer to CSDClientResult object.
williamr@2
   228
williamr@2
   229
	@since 8.0
williamr@2
   230
	*/
williamr@2
   231
	IMPORT_C const CSDClientResult& At(TInt aIndex) const;
williamr@2
   232
williamr@2
   233
	/**
williamr@2
   234
	Sets the number of results actually returned after recogntion.
williamr@2
   235
williamr@2
   236
	@param  aResultCount 
williamr@2
   237
	        The number of results returned by the recognizer.
williamr@2
   238
williamr@2
   239
	@since 8.0
williamr@2
   240
	*/
williamr@2
   241
	IMPORT_C void SetResultCount(TInt aResultCount);
williamr@2
   242
williamr@2
   243
	/**
williamr@2
   244
	Returns the number of results actually returned after recogntion.
williamr@2
   245
williamr@2
   246
	@return The number of results actually returned after recogntion.
williamr@2
   247
williamr@2
   248
	@since 8.0
williamr@2
   249
	*/
williamr@2
   250
	IMPORT_C TInt ResultCount() const;
williamr@2
   251
williamr@2
   252
	/**
williamr@2
   253
	Sets the diagnostic of this result set.
williamr@2
   254
williamr@2
   255
	@param  aDiagnostic 
williamr@2
   256
	        The reference to the diagostic object.
williamr@2
   257
williamr@2
   258
	@since 8.0
williamr@2
   259
	*/
williamr@2
   260
	IMPORT_C void SetDiagnostic(TDiagnostic& aDiagnostic);
williamr@2
   261
williamr@2
   262
	/**
williamr@2
   263
	Gets the diagnostic of this result set.
williamr@2
   264
williamr@2
   265
	@return A reference to TDiagnostic object.
williamr@2
   266
williamr@2
   267
	@since 8.0
williamr@2
   268
	*/
williamr@2
   269
	IMPORT_C const TDiagnostic& Diagnostic() const;
williamr@2
   270
williamr@2
   271
williamr@2
   272
	/**
williamr@2
   273
	Writes the state of the class to a stream.
williamr@2
   274
williamr@2
   275
	@param  aStream
williamr@2
   276
	        The stream to write to.
williamr@2
   277
williamr@2
   278
	@since  8.0
williamr@2
   279
	*/
williamr@2
   280
	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
williamr@2
   281
williamr@2
   282
	/**
williamr@2
   283
	Restores the state of the object from a stream.
williamr@2
   284
williamr@2
   285
	@param  aStream
williamr@2
   286
	        The stream to read from.
williamr@2
   287
williamr@2
   288
	@since  8.0
williamr@2
   289
	*/
williamr@2
   290
	IMPORT_C void InternalizeL(RReadStream& aStream);
williamr@2
   291
williamr@2
   292
private:
williamr@2
   293
	void ConstructL();
williamr@2
   294
	CSDClientResultSet();
williamr@2
   295
williamr@2
   296
private:
williamr@2
   297
	TInt iMaxResults;	// maximum number of results
williamr@2
   298
	TInt iResultCount; // number of recognition results
williamr@2
   299
	RPointerArray<CSDClientResult> iResultArray; // array of recognition results
williamr@2
   300
	TDiagnostic* iDiagnostic;	// diagnostic information
williamr@2
   301
	};
williamr@2
   302
	
williamr@2
   303
#endif  // __SPEECHRECOGNITIONDATACLIENT_H__
williamr@2
   304