CSDLexicon Class Reference

#include <mmf/common/speechrecognitiondatadevasr.h>

Link against: speechrecognitiondata.lib

class CSDLexicon : public CBase

Inherits from

CSDLexicon
- CBase

Public Member Functions
	~CSDLexicon()
IMPORT_C TInt	Add(CSDPronunciation &)
IMPORT_C const CSDPronunciation &	At(TInt)
IMPORT_C TInt	Count()
IMPORT_C TInt	FindPronunciation(TPronunciationID)
IMPORT_C TLexiconID	LexiconID()
IMPORT_C CSDLexicon *	NewL(TLexiconID)
IMPORT_C CSDLexicon *	NewLC(TLexiconID)

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()

Detailed Description

Class to encapsulate a Speaker Dependent Lexicon.

Since: 8.0

Constructor & Destructor Documentation

~CSDLexicon ( )

IMPORT_C

~CSDLexicon

(

)

Destructor.

Member Function Documentation

Add ( CSDPronunciation & )

IMPORT_C TInt

Add

(

CSDPronunciation &

aPronunciation

)

Adds a lexicon entry to the lexicon.

Since: 8.0

Parameters
aPronunciation	A reference to a CSDPronunciation object.

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

At ( TInt )

IMPORT_C const CSDPronunciation &

(

TInt

aIndex

)

const

Returns a pronunciation based at an index.

Since: 8.0

Parameters
aIndex	The pronunciation index. This value must not be negative and must not be greater than the number of pronunciations currently in the lexicon, otherwise the function will panic.

Return Value: A reference to a CSDPronunciation object.

Count ( )

IMPORT_C TInt

Count

(

)

const

Returns the number of lexicon entries in the lexicon.

Since: 8.0

Return Value: The number of pronunciations.

FindPronunciation ( TPronunciationID )

IMPORT_C TInt

FindPronunciation

(

TPronunciationID

aPronunciationID

)

const

Finds a pronunciation based on the specified pronunciation ID.

Parameters
aPronunciationID	The pronunciation identifier.

Return Value: The index of the first matching pronunciation within the lexicon. Returns KErrNotFound, if a matching pronunciation can not be found.

LexiconID ( )

IMPORT_C TLexiconID

LexiconID

(

)

const

Returns the ID of the lexicon.

Since: 8.0

Return Value: The lexicon identifier.

NewL ( TLexiconID )

IMPORT_C CSDLexicon *

NewL

(

TLexiconID

aLexiconID

)

[static]

Instantiates an instance of CSDLexicon.

Parameters
aLexiconID	The lexicon identifier.

Return Value: A pointer to a CSDLexicon object.

NewLC ( TLexiconID )

IMPORT_C CSDLexicon *

NewLC

(

TLexiconID

aLexiconID

)

[static]

Instantiates an instance of CSDGrammar and leaves a pointer on the cleanup stack.

Parameters
aLexiconID	The lexicon identifier.

Return Value: A pointer to a CSDLexicon object.