CSDClientResult Class Reference

#include <mmf/common/speechrecognitiondataclient.h>

Link against: speechrecognitiondata.lib

class CSDClientResult : public CBase

Inherits from

CSDClientResult
- CBase

Public Member Functions
	~CSDClientResult()
void	ExternalizeL(RWriteStream &)
IMPORT_C TGrammarID	GrammarID()
void	InternalizeL(RReadStream &)
IMPORT_C CSDClientResult *	NewL()
IMPORT_C CSDClientResult *	NewL(TGrammarID, TRuleID)
IMPORT_C CSDClientResult *	NewLC()
IMPORT_C CSDClientResult *	NewLC(TGrammarID, TRuleID)
IMPORT_C TRuleID	RuleID()
IMPORT_C void	SetGrammarID(TGrammarID)
IMPORT_C void	SetRuleID(TRuleID)

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 client recognition result. The result is formulated for client consumption.

Since: 8.0

Constructor & Destructor Documentation

~CSDClientResult ( )

IMPORT_C

~CSDClientResult

(

)

Destructor.

Member Function Documentation

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Writes the class to a stream.

Since: 8.0

Parameters
aStream	A RWriteStream to write the class to.

GrammarID ( )

IMPORT_C TGrammarID

GrammarID

(

)

const

Retrieves the grammar ID of the result.

Since: 8.0

Return Value: Grammar identifier.

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

Reads the class from a stream.

Since: 8.0

Parameters
aStream	A RReadStream to read from.

NewL ( )

IMPORT_C CSDClientResult *

NewL

(

)

[static]

Two-phased constructor. Creates an uninitialised recognition result.

Can leave with one of the system-wide error codes

Return Value: CSDClientResult object

NewL ( TGrammarID, TRuleID )

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

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

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

Parameters
aGrammarID	The grammar ID of the result.
aRuleID	The rule ID of the result.

Return Value: CSDClientResult object.

NewLC ( )

IMPORT_C CSDClientResult *

NewLC

(

)

[static]

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 object

NewLC ( TGrammarID, TRuleID )

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

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
aGrammarID	The grammar ID of the result
aRuleID	The rule ID of the result

Return Value: CSDClientResult object.

RuleID ( )

IMPORT_C TRuleID

RuleID

(

)

const

Returns the rule ID of the result.

Since: 8.0

Return Value: The rule identifier.

SetGrammarID ( TGrammarID )

IMPORT_C void

SetGrammarID

(

TGrammarID

aGrammarID

)

Sets the grammar ID on the result.

Since: 8.0

Parameters
aGrammarID	The grammar identifier.

SetRuleID ( TRuleID )

IMPORT_C void

SetRuleID

(

TRuleID

aRuleID

)

Sets the rule ID of the result.

Since: 8.0

Parameters
aRuleID	The rule identifier.