| class CApaDataRecognizerType : public CBase |
Abstract base class for a recognizer.
Concrete recognizers need to define and implement a derived class; specifically, they need to provide an implementation of the DoRecognizeL(), SupportedDataTypeL() and PreferredBufSize() functions.
The class is implemented as part of a DLL. The ordinal 1 function of the DLL must construct an instance of, and return a pointer to, a CApaDataRecognizerType derived class.
| Public Member Functions | |
|---|---|
| ~CApaDataRecognizerType() | |
| TInt | Confidence() |
| IMPORT_C CApaDataRecognizerType * | CreateDataRecognizerL(TUid) |
| CDataRecognizerExtension * | DataRecognizerExtension() |
| IMPORT_C void | Lock() |
| TInt | Locked() |
| IMPORT_C TDataType | MimeType() |
| TInt | MimeTypesCount() |
| IMPORT_C TUint | PreferredBufSize() |
| TInt | Priority() |
| IMPORT_C TDataRecognitionResult | RecognizeL(const TDesC &, const TDesC8 &) |
| TDataRecognitionResult | RecognizeL(TDataToRecognize &) |
| IMPORT_C TDataType | SupportedDataTypeL(TInt) |
| TUid | TypeUid() |
| IMPORT_C void | Unlock() |
| IMPORT_C void | UpdateDataTypesL() |
| Protected Member Functions | |
|---|---|
| CApaDataRecognizerType(TUid, TInt) | |
| IMPORT_C RFile * | FilePassedByHandleL() |
| Private Member Functions | |
|---|---|
| IMPORT_C void | DoRecognizeL(const TDesC &, const TDesC8 &) |
| IMPORT_C void | Reserved_1() |
| Public Member Enumerations | |
|---|---|
| enum | TRecognitionConfidence { ECertain = KMaxTInt, EProbable = 100, EPossible = 0, EUnlikely = -100, ENotRecognized = KMinTInt } |
| enum | TRecognizerPriority { EHigh = 100, ENormal = 0, ELow = -100 } |
| Protected Attributes | |
|---|---|
| TInt | iConfidence |
| TInt | iCountDataTypes |
| TDataType | iDataType |
| const TInt | iPriority |
| const TUid | iTypeUid |
| Private Attributes | |
|---|---|
| CDataRecognizerExtension * | iDataRecognizerExtn |
| TInt | iLock |
| IMPORT_C | CApaDataRecognizerType | ( | TUid | aUid, |
| TInt | aPriority | |||
| ) | [protected] | |||
| TInt | Confidence | ( | ) | const [inline] |
Gets the recognizer's confidence rating for the most recently recognized data.
The confidence rating. This is one of the TRecognitionConfidence enumeration values.
| IMPORT_C CApaDataRecognizerType * | CreateDataRecognizerL | ( | TUid | aImplUid | ) | [static] |
| TUid aImplUid |
| IMPORT_C void | DoRecognizeL | ( | const TDesC & | aName, |
| const TDesC8 & | aBuffer | |||
| ) | [private, virtual] | |||
| TInt | MimeTypesCount | ( | ) | const [inline] |
Gets the number of data (MIME) types supported by this recognizer.
The number of data types.
| TInt | Priority | ( | ) | const [inline] |
Gets the recognizer's priority.
The priority defines the likelihood that the recognizer will successfully identify data. This is one of the CApaDataRecognizerType::TRecognizerPriority enumerators.
The priority value.
| IMPORT_C TDataRecognitionResult | RecognizeL | ( | const TDesC & | aName, |
| const TDesC8 & | aBuffer | |||
| ) | ||||
| TDataRecognitionResult | RecognizeL | ( | TDataToRecognize & | aDataToRecognize | ) |
| TDataToRecognize & aDataToRecognize |
| IMPORT_C TDataType | SupportedDataTypeL | ( | TInt | aIndex | ) | const [pure virtual] |
Gets one of the data (MIME) types that the recognizer can recognize.
The data (MIME) type.
| TInt aIndex | An index that identifies the data type. Typically, the minimum value is zero and the maximum value is the value of MimeTypesCount() - 1. |
A set of values describing the probability that the recognizer assigns to its belief that the most recently sampled data is of the type ascribed to it.
| ECertain = KMaxTInt |
The data is definitely of the data type. |
| EProbable = 100 |
A level of confidence between ECertain and EPossible. |
| EPossible = 0 |
The data is possibly of the data type. |
| EUnlikely = -100 |
A level of confidence between EPossible and ENotRecognized. |
| ENotRecognized = KMinTInt |
The data is not recognized. |
A set of values used to indicate the probability that the recognizer will successfully identify data. The Application Architecture framework uses this set to determine the order in which recognizers are invoked.
| EHigh = 100 |
The highest recognizer priority. Recognizers with this priority are invoked before those with any other priority. |
| ENormal = 0 |
The normal recognizer priority. Recognizers with this priority are invoked after those with a EHigh priority but before those with a ELow priority. |
| ELow = -100 |
The lowest recognizer priority. |
| TInt | iConfidence | [protected] |
The recognizer's confidence rating of the most recently recognized data.
Users of the derived class use Confidence() to get this value.
| TInt | iCountDataTypes | [protected] |
The number of data (MIME) types supported by this recognizer. Typically, this is set during construction of an instance of the derived class.
Users of the derived class use MimeTypesCount() to get this value.
| CDataRecognizerExtension * | iDataRecognizerExtn | [private] |
| TDataType | iDataType | [protected] |
The data (MIME) type of the most recently recognized data.
Users of the derived class use MimeType() to get this value.