CSDGrammar Class Reference

#include <mmf/common/speechrecognitiondatadevasr.h>

Link against: speechrecognitiondata.lib

class CSDGrammar : public CBase

Inherits from

CSDGrammar
- CBase

Public Member Functions
	~CSDGrammar()
IMPORT_C TInt	Add(CSDRule &)
IMPORT_C const CSDRule &	At(TInt)
IMPORT_C TInt	Count()
IMPORT_C void	Delete(TRuleID)
IMPORT_C TInt	FindRule(TRuleID)
IMPORT_C TGrammarID	GrammarID()
IMPORT_C CSDGrammar *	NewL(TGrammarID)
IMPORT_C CSDGrammar *	NewLC(TGrammarID)

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 Grammar.

A grammar consists of a list of rules.

Since: 8.0

Constructor & Destructor Documentation

~CSDGrammar ( )

IMPORT_C

~CSDGrammar

(

)

Destructor.

Member Function Documentation

Add ( CSDRule & )

IMPORT_C TInt

Add

(

CSDRule &

aRule

)

Adds a rule to the grammar.

Since: 8.0

Parameters
aRule	A reference to a CSDRule 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 CSDRule &

(

TInt

aIndex

)

const

Returns a rule based at an index.

Since: 8.0

Parameters
aIndex	An index value. The value must not be negative and must not be greater than the number of rules currently in the grammar, otherwise the function will panic.

Return Value: A reference to a CSDRule object.

Count ( )

IMPORT_C TInt

Count

(

)

const

Returns the number of rules in the grammar

Since: 8.0

Return Value: The number of rules.

Delete ( TRuleID )

IMPORT_C void

Delete

(

TRuleID

aRuleID

)

Deletes a rule from the grammar.

Since: 8.0

Parameters
aRuleID	The rule identifier to delete.

FindRule ( TRuleID )

IMPORT_C TInt

FindRule

(

TRuleID

aRuleID

)

const

Finds a rule in the grammar based on the rule ID.

Since: 8.0

Parameters
aRuleID	The rule identifier.

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

GrammarID ( )

IMPORT_C TGrammarID

GrammarID

(

)

const

Returns the grammar ID of the result.

Since: 8.0

Return Value: The grammar identifier.

NewL ( TGrammarID )

IMPORT_C CSDGrammar *

NewL

(

TGrammarID

aGrammarID

)

[static]

Instantiates an instance of CSDGrammar.

Parameters
aGrammarID	The grammar identifier.

Return Value: A pointer to a CSDGrammar object.

NewLC ( TGrammarID )

IMPORT_C CSDGrammar *

NewLC

(

TGrammarID

aGrammarID

)

[static]

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

Parameters
aGrammarID	The grammar identifier.

Return Value: A pointer to CSDGrammar object.