CSpeechRecognitionCustomCommandParser Class Reference

class CSpeechRecognitionCustomCommandParser : public CMMFCustomCommandParserBase

This is the main class of Speech Recognition Custom Commands Parser.

8.0

Inherits from

Public Member Functions
~CSpeechRecognitionCustomCommandParser()
voidHandleRequest(TMMFMessage &)
IMPORT_C CSpeechRecognitionCustomCommandParser *NewL(MSpeechRecognitionCustomCommandImplementor &)
Private Member Functions
CSpeechRecognitionCustomCommandParser(MSpeechRecognitionCustomCommandImplementor &)
voidDoAddPronunciationL(TMMFMessage &)
voidDoAddRuleL(TMMFMessage &)
voidDoCancel()
voidDoCommitChangesL()
voidDoCopyGrammarIDArrayL(TMMFMessage &)
voidDoCopyIntArrayL(TMMFMessage &, const RArray< TInt > &)
voidDoCopyLexiconIDArrayL(TMMFMessage &)
voidDoCopyModelBankIDArrayL(TMMFMessage &)
voidDoCopyModelIDArrayL(TMMFMessage &)
voidDoCopyPronunciationIDArrayL(TMMFMessage &)
voidDoCopyResultSetL(TMMFMessage &)
voidDoCopyRuleIDArrayL(TMMFMessage &)
voidDoCreateGrammarL(TMMFMessage &)
voidDoCreateLexiconL(TMMFMessage &)
voidDoCreateModelBankL(TMMFMessage &)
voidDoEndRecSessionL()
voidDoExternalizeResultSetL()
voidDoExtractIntArrayFromData1L(TMMFMessage &, RArray< TInt > &)
voidDoExtractIntArrayFromData2L(TMMFMessage &, RArray< TInt > &)
voidDoExtractIntArrayL(TDes8 &, RArray< TInt > &)
voidDoGetAllClientGrammarIDsL()
voidDoGetAllClientLexiconIDsL()
voidDoGetAllClientModelBankIDsL()
voidDoGetAllGrammarIDsL()
voidDoGetAllLexiconIDsL()
voidDoGetAllModelBankIDsL()
voidDoGetAllModelIDsL(TMMFMessage &)
voidDoGetAllPronunciationIDsL(TMMFMessage &)
voidDoGetAllRuleIDsL(TMMFMessage &)
voidDoGetAvailableStorageL(TMMFMessage &)
voidDoGetEnginePropertiesL(TMMFMessage &)
voidDoGetModelCountL(TMMFMessage &)
voidDoGetRuleValidityL(TMMFMessage &)
voidDoGetUtteranceDurationL(TMMFMessage &)
voidDoHandleRequestL(TMMFMessage &)
voidDoLoadEngineParametersL(TMMFMessage &)
voidDoLoadGrammarL(TMMFMessage &)
voidDoLoadLexiconL(TMMFMessage &)
voidDoLoadModelsL(TMMFMessage &)
voidDoPlayUtteranceL(TMMFMessage &)
voidDoRecognizeL(TMMFMessage &)
voidDoRecordL(TMMFMessage &)
voidDoRemoveGrammarL(TMMFMessage &)
voidDoRemoveLexiconL(TMMFMessage &)
voidDoRemoveModelBankL(TMMFMessage &)
voidDoRemoveModelL(TMMFMessage &)
voidDoRemovePronunciationL(TMMFMessage &)
voidDoRemoveRuleL(TMMFMessage &)
voidDoSetClientUidL(TMMFMessage &)
voidDoStartRecSessionL(TMMFMessage &)
voidDoTrainL(TMMFMessage &)
voidDoUnloadRuleL(TMMFMessage &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CMMFCustomCommandParserBase::CMMFCustomCommandParserBase(TUid)
CMMFCustomCommandParserBase::InterfaceId()
CMMFCustomCommandParserBase::~CMMFCustomCommandParserBase()
Private Attributes
RArray< TGrammarID >iGrammarIDs
MSpeechRecognitionCustomCommandImplementor &iImplementor
RArray< TLexiconID >iLexiconIDs
RArray< TModelBankID >iModelBankIDs
RArray< TModelID >iModelIDs
RArray< TPronunciationID >iPronunciationIDs
CBufFlat *iResultCopyBuffer
CSDClientResultSet *iResultSet
RArray< TRuleID >iRuleIDs

Constructor & Destructor Documentation

CSpeechRecognitionCustomCommandParser(MSpeechRecognitionCustomCommandImplementor &)

CSpeechRecognitionCustomCommandParser(MSpeechRecognitionCustomCommandImplementor &aImplementor)[private]

C++ constructor for a CSpeechRecognitionCustomCommandParser class.

8.0

Parameters

MSpeechRecognitionCustomCommandImplementor & aImplementorA reference to a custom commands implementor.

~CSpeechRecognitionCustomCommandParser()

IMPORT_C~CSpeechRecognitionCustomCommandParser()

Destructor.

8.0

Member Functions Documentation

DoAddPronunciationL(TMMFMessage &)

voidDoAddPronunciationL(TMMFMessage &aMessage)[private]

Adds a new pronunciation for the given model into the specified lexicon.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoAddRuleL(TMMFMessage &)

voidDoAddRuleL(TMMFMessage &aMessage)[private]

Adds a new rule for the given pronunciation into the specified grammar.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCancel()

voidDoCancel()[private]

Cancels the current operation.

8.0

DoCommitChangesL()

voidDoCommitChangesL()[private]

Commits uncommitted database operations to the database.

8.0

DoCopyGrammarIDArrayL(TMMFMessage &)

voidDoCopyGrammarIDArrayL(TMMFMessage &aMessage)[private]

Copies the grammar ID array stored by a previous GetAllGrammarIDs call.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCopyIntArrayL(TMMFMessage &, const RArray< TInt > &)

voidDoCopyIntArrayL(TMMFMessage &aMessage,
const RArray< TInt > &aArray
)[private]

Copies the specified integer array given into a TMMFMessage.

8.0

Parameters

TMMFMessage & aMessageThe message to copy the array into.
const RArray< TInt > & aArrayThe array to copy from.

DoCopyLexiconIDArrayL(TMMFMessage &)

voidDoCopyLexiconIDArrayL(TMMFMessage &aMessage)[private]

Copies the lexicon ID array stored by a previous GetAllLexiconIDs call.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCopyModelBankIDArrayL(TMMFMessage &)

voidDoCopyModelBankIDArrayL(TMMFMessage &aMessage)[private]

Copies the modelBank ID array stored by a previous GetAllModelBankIDs call.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCopyModelIDArrayL(TMMFMessage &)

voidDoCopyModelIDArrayL(TMMFMessage &aMessage)[private]

Copy the model ID array stored by a previous GetAllModelIDs call.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCopyPronunciationIDArrayL(TMMFMessage &)

voidDoCopyPronunciationIDArrayL(TMMFMessage &aMessage)[private]

Copies the pronunciation ID array stored by a previous GetAllPronunciationIDs call.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCopyResultSetL(TMMFMessage &)

voidDoCopyResultSetL(TMMFMessage &aMessage)[private]

Copies the previously externalised result set into a message. The message must be the same size as the stored externalized result set.

Parameters

TMMFMessage & aMessage

DoCopyRuleIDArrayL(TMMFMessage &)

voidDoCopyRuleIDArrayL(TMMFMessage &aMessage)[private]

Copies the rule ID array stored by a previous GetAllRuleIDs call.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCreateGrammarL(TMMFMessage &)

voidDoCreateGrammarL(TMMFMessage &aMessage)[private]

Creates a new grammar.

8.0

Parameters

TMMFMessage & aMessageA message containing the information of the request.

DoCreateLexiconL(TMMFMessage &)

voidDoCreateLexiconL(TMMFMessage &aMessage)[private]

Creates a new lexicon.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoCreateModelBankL(TMMFMessage &)

voidDoCreateModelBankL(TMMFMessage &aMessage)[private]

Creates a new model bank.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoEndRecSessionL()

voidDoEndRecSessionL()[private]

Ends the current recognition session. Resources allocated for recognition are freed.

8.0

DoExternalizeResultSetL()

voidDoExternalizeResultSetL()[private]

Externalises the result set into a descriptor, so that it can be copied into an array.

DoExtractIntArrayFromData1L(TMMFMessage &, RArray< TInt > &)

voidDoExtractIntArrayFromData1L(TMMFMessage &aMessage,
RArray< TInt > &aArray
)[private]

Extracts an array from first parameter of TMMFMessage.

8.0

Parameters

TMMFMessage & aMessageThe message to copy the array from.
RArray< TInt > & aArrayThe array to copy into.

DoExtractIntArrayFromData2L(TMMFMessage &, RArray< TInt > &)

voidDoExtractIntArrayFromData2L(TMMFMessage &aMessage,
RArray< TInt > &aArray
)[private]

Extracts an array from second parameter of TMMFMessage.

8.0

Parameters

TMMFMessage & aMessageThe message to copy array from.
RArray< TInt > & aArrayThe array to copy into.

DoExtractIntArrayL(TDes8 &, RArray< TInt > &)

voidDoExtractIntArrayL(TDes8 &aDescriptor,
RArray< TInt > &aArray
)[private]

Extracts an integer array from the descriptor.

8.0

Parameters

TDes8 & aDescriptorThe descriptor containing an integer.
RArray< TInt > & aArrayThe array to copy into.

DoGetAllClientGrammarIDsL()

voidDoGetAllClientGrammarIDsL()[private]

Returns all grammar IDs that belong to the current client, whose UID was set with SetClientUid().

8.0

DoGetAllClientLexiconIDsL()

voidDoGetAllClientLexiconIDsL()[private]

Returns all lexicon IDs that belong to the current client, whose UID was set with SetClientUid().

8.0

DoGetAllClientModelBankIDsL()

voidDoGetAllClientModelBankIDsL()[private]

Returns all model bank IDs that belong to the current client, whose UID was set with SetClientUid().

8.0

DoGetAllGrammarIDsL()

voidDoGetAllGrammarIDsL()[private]

Returns all grammar IDs that exist (for all clients).

An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

8.0

DoGetAllLexiconIDsL()

voidDoGetAllLexiconIDsL()[private]

Returns all lexicon IDs that exist (for all clients).

8.0

DoGetAllModelBankIDsL()

voidDoGetAllModelBankIDsL()[private]

Returns all model bank IDs that exist (for all clients).

8.0

DoGetAllModelIDsL(TMMFMessage &)

voidDoGetAllModelIDsL(TMMFMessage &aMessage)[private]

Returns all model IDs that exist in the specified model bank.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoGetAllPronunciationIDsL(TMMFMessage &)

voidDoGetAllPronunciationIDsL(TMMFMessage &aMessage)[private]

Returns all pronunciation IDs that exist in the specified lexicon.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoGetAllRuleIDsL(TMMFMessage &)

voidDoGetAllRuleIDsL(TMMFMessage &aMessage)[private]

Returns all rule IDs that exist in the specified grammar.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoGetAvailableStorageL(TMMFMessage &)

voidDoGetAvailableStorageL(TMMFMessage &aMessage)[private]

Returns the number of models available for training system wide, based on available disk space.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoGetEnginePropertiesL(TMMFMessage &)

voidDoGetEnginePropertiesL(TMMFMessage &aMessage)[private]

Returns the engine properties.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoGetModelCountL(TMMFMessage &)

voidDoGetModelCountL(TMMFMessage &aMessage)[private]

Returns the number of models in the specified model bank.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoGetRuleValidityL(TMMFMessage &)

voidDoGetRuleValidityL(TMMFMessage &aMessage)[private]

Checks if the rule is valid or not.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoGetUtteranceDurationL(TMMFMessage &)

voidDoGetUtteranceDurationL(TMMFMessage &aMessage)[private]

Returns the duration of the utterance for the specified model.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoHandleRequestL(TMMFMessage &)

voidDoHandleRequestL(TMMFMessage &aMessage)[private]

Private method to handle the request from the client.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoLoadEngineParametersL(TMMFMessage &)

voidDoLoadEngineParametersL(TMMFMessage &aMessage)[private]

Loads the specified parameters into the engine.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoLoadGrammarL(TMMFMessage &)

voidDoLoadGrammarL(TMMFMessage &aMessage)[private]

Loads the specified grammar into the recognizer; done prior to recognition.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoLoadLexiconL(TMMFMessage &)

voidDoLoadLexiconL(TMMFMessage &aMessage)[private]

Loads the specified lexicon into the recognizer; done prior to recognition.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoLoadModelsL(TMMFMessage &)

voidDoLoadModelsL(TMMFMessage &aMessage)[private]

Loads the specified model bank into the recognizer; done prior to recognition.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoPlayUtteranceL(TMMFMessage &)

voidDoPlayUtteranceL(TMMFMessage &aMessage)[private]

Plays the previously trained utterance.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRecognizeL(TMMFMessage &)

voidDoRecognizeL(TMMFMessage &aMessage)[private]

Initiates recognition; performed following loading of model bank, lexicon, and grammar.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRecordL(TMMFMessage &)

voidDoRecordL(TMMFMessage &aMessage)[private]

Records user utterance for training and recognition.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRemoveGrammarL(TMMFMessage &)

voidDoRemoveGrammarL(TMMFMessage &aMessage)[private]

Removes the specified grammar from the permanent storage.

Removing a grammar will remove all rules within the grammar.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRemoveLexiconL(TMMFMessage &)

voidDoRemoveLexiconL(TMMFMessage &aMessage)[private]

Removes the specified lexicon from the permanent storage.

Removing a lexicon will remove all pronunciations within the lexicon.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRemoveModelBankL(TMMFMessage &)

voidDoRemoveModelBankL(TMMFMessage &aMessage)[private]

Removes the specified model bank from the permanent storage.

Removing a model bank will remove all models within the model bank.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRemoveModelL(TMMFMessage &)

voidDoRemoveModelL(TMMFMessage &aMessage)[private]

Removes the specified model from the specified model bank permanently.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRemovePronunciationL(TMMFMessage &)

voidDoRemovePronunciationL(TMMFMessage &aMessage)[private]

Removes the specified pronunciation from the specified lexicon permanently.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoRemoveRuleL(TMMFMessage &)

voidDoRemoveRuleL(TMMFMessage &aMessage)[private]

Removes the specified rule from the specified grammar permanently.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoSetClientUidL(TMMFMessage &)

voidDoSetClientUidL(TMMFMessage &aMessage)[private]

Sets the UID of the client.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoStartRecSessionL(TMMFMessage &)

voidDoStartRecSessionL(TMMFMessage &aMessage)[private]

Starts a new recognition session.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoTrainL(TMMFMessage &)

voidDoTrainL(TMMFMessage &aMessage)[private]

Trains a new model into the specified model bank.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

DoUnloadRuleL(TMMFMessage &)

voidDoUnloadRuleL(TMMFMessage &aMessage)[private]

Unloads the specified rule from the specified grammar in temporary memory, previously loaded with LoadGrammarL().

The rule in the permanent storage remains intact.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

HandleRequest(TMMFMessage &)

voidHandleRequest(TMMFMessage &aMessage)[virtual]

Handles the request from the client.

8.0

Parameters

TMMFMessage & aMessageThe message containing the information of the request.

NewL(MSpeechRecognitionCustomCommandImplementor &)

IMPORT_C CSpeechRecognitionCustomCommandParser *NewL(MSpeechRecognitionCustomCommandImplementor &aImplementor)[static]

Factory function for creating this class.

A pointer to a CSpeechRecognitionCustomCommandParser object.

8.0

Parameters

MSpeechRecognitionCustomCommandImplementor & aImplementorA reference to a custom commands implementor.

Member Data Documentation

RArray< TGrammarID > iGrammarIDs

RArray< TGrammarID >iGrammarIDs[private]

MSpeechRecognitionCustomCommandImplementor & iImplementor

MSpeechRecognitionCustomCommandImplementor &iImplementor[private]

RArray< TLexiconID > iLexiconIDs

RArray< TLexiconID >iLexiconIDs[private]

RArray< TModelBankID > iModelBankIDs

RArray< TModelBankID >iModelBankIDs[private]

RArray< TModelID > iModelIDs

RArray< TModelID >iModelIDs[private]

RArray< TPronunciationID > iPronunciationIDs

RArray< TPronunciationID >iPronunciationIDs[private]

CBufFlat * iResultCopyBuffer

CBufFlat *iResultCopyBuffer[private]

CSDClientResultSet * iResultSet

CSDClientResultSet *iResultSet[private]

RArray< TRuleID > iRuleIDs

RArray< TRuleID >iRuleIDs[private]