Collapse all Symbian^3 Product Developer Library

CSDGrammar Class Reference

class CSDGrammar : public CBase

Class to encapsulate a Speaker Dependent Grammar.

A grammar consists of a list of rules.

Since: 8.0

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)

Private Member Functions
	CSDGrammar(TGrammarID)
void	ConstructL()

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

Private Attributes
TGrammarID	iGrammarID
RPointerArray< CSDRule >	iRuleArray

Constructor & Destructor Documentation

CSDGrammar(TGrammarID)

CSDGrammar

(

TGrammarID

aGrammarID

)

[private]

Parameters

TGrammarID aGrammarID

~CSDGrammar()

IMPORT_C

~CSDGrammar

(

)

Destructor.

Member Functions Documentation

Add(CSDRule &)

IMPORT_C TInt

Add

(

CSDRule &

aRule

)

Adds a rule to the grammar.

Since: 8.0

Parameters

CSDRule & aRule

A reference to a CSDRule object.

At(TInt)

IMPORT_C const CSDRule &

(

TInt

aIndex

)

const

Returns a rule based at an index.

Since: 8.0

Parameters

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

ConstructL()

void

ConstructL

(

)

[private]

Count()

IMPORT_C TInt

Count

(

)

const

Returns the number of rules in the grammar

Since: 8.0

Delete(TRuleID)

IMPORT_C void

Delete

(

TRuleID

aRuleID

)

Deletes a rule from the grammar.

Since: 8.0

Parameters

TRuleID 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

TRuleID aRuleID

The rule identifier.

GrammarID()

IMPORT_C TGrammarID

GrammarID

(

)

const

Returns the grammar ID of the result.

Since: 8.0

NewL(TGrammarID)

IMPORT_C CSDGrammar *

NewL

(

TGrammarID

aGrammarID

)

[static]

Instantiates an instance of CSDGrammar.

Parameters

TGrammarID aGrammarID

The grammar identifier.

NewLC(TGrammarID)

IMPORT_C CSDGrammar *

NewLC

(

TGrammarID

aGrammarID

)

[static]

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

Parameters

TGrammarID aGrammarID

The grammar identifier.

Member Data Documentation

TGrammarID iGrammarID

TGrammarID

iGrammarID

[private]

RPointerArray< CSDRule > iRuleArray

RPointerArray< CSDRule >

iRuleArray

[private]