Class CSDClientResult

class CSDClientResult : public CBase;

Description

Class to encapsulate a client recognition result. The result is formulated for client consumption.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSDClientResult - Class to encapsulate a client recognition result

Members

Defined in CSDClientResult:
GrammarID(), NewL(), NewL(), NewLC(), NewLC(), RuleID(), SetGrammarID(), SetRuleID(), ~CSDClientResult()

Inherited from CBase:
Delete(), Extension_(), operator new()

IMPORT_C ~CSDClientResult();

Description

Destructor.

static IMPORT_C CSDClientResult *NewL();

Description

Two-phased constructor. Creates an uninitialised recognition result.

Can leave with one of the system-wide error codes

Return value

CSDClientResult * CSDClientResult object

static IMPORT_C CSDClientResult *NewLC();

Description

Two-phased constructor. Creates an uninitialised recognition result. A copy of the newly created class is pushed onto the cleanup stack.

Can leave with one of the system-wide error codes.

Return value

CSDClientResult * CSDClientResult object

static IMPORT_C CSDClientResult *NewL(TGrammarID aGrammarID, TRuleID aRuleID);

Description

Two-phased constructor. Creates a result with a grammar and rule ID.

Can leave with one of the system-wide error codes.

Parameters

TGrammarID aGrammarID The grammar ID of the result. TRuleID aRuleID The rule ID of the result.

Return value

CSDClientResult * CSDClientResult object.

static IMPORT_C CSDClientResult *NewLC(TGrammarID aGrammarID, TRuleID aRuleID);

Description

Two-phased constructor. Creates a result with a grammar and rule ID. A copy of the newly created class is pushed onto the cleanup stack.

Can leave with one of the system-wide error codes.

Parameters

TGrammarID aGrammarID The grammar ID of the result TRuleID aRuleID The rule ID of the result

Return value

CSDClientResult * CSDClientResult object.

IMPORT_C void SetGrammarID(TGrammarID aGrammarID);

Description

Sets the grammar ID on the result.

Parameters

TGrammarID aGrammarID The grammar identifier.

IMPORT_C TGrammarID GrammarID() const;

Description

Retrieves the grammar ID of the result.

Return value

TGrammarID Grammar identifier.

IMPORT_C void SetRuleID(TRuleID aRuleID);

Description

Sets the rule ID of the result.

Parameters

TRuleID aRuleID The rule identifier.

IMPORT_C TRuleID RuleID() const;

Description

Returns the rule ID of the result.

Return value

TRuleID The rule identifier.