Class CSDClientResultSet

class CSDClientResultSet : public CBase;

Description

Class to encapsulate a client recogntion result set This is a lightweight result set formulated for client consumption

Derivation

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

• CSDClientResultSet - Class to encapsulate a client recogntion result set This is a lightweight result set formulated for client consumption

Members

Defined in CSDClientResultSet:
At(), Diagnostic(), ExternalizeL(), InternalizeL(), MaxResults(), NewL(), NewLC(), ResultCount(), SetDiagnostic(), SetMaxResultsL(), SetResultCount(), ~CSDClientResultSet()

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

IMPORT_C ~CSDClientResultSet();

Description

Destructor.

static IMPORT_C CSDClientResultSet *NewL();

Description

Two-phased constructor.

Return value

CSDClientResultSet * CSDClientResultSet object.

static IMPORT_C CSDClientResultSet *NewLC();

Description

Two-phased constructor. Pushes the newly created object onto the cleanup stack

Return value

CSDClientResultSet * CSDClientResultSet object.

IMPORT_C void SetMaxResultsL(TInt aMaxResults);

Description

Sets the maximum number of best matches (N-best) expected in the recognition result after recognition.

Parameters

TInt aMaxResults The maximum number of matches expected in the recognition result.

IMPORT_C TInt MaxResults() const;

Description

Returns the current value of the max number of expected after recognition.

Return value

TInt The maximum number of best matches (N-best) expected in the recognition result.

IMPORT_C const CSDClientResult &At(TInt aIndex) const;

Description

Returns a result at a given index within the result set.

Parameters

TInt aIndex The index of result to return.

Return value

const CSDClientResult & A pointer to CSDClientResult object.

IMPORT_C void SetResultCount(TInt aResultCount);

Description

Sets the number of results actually returned after recogntion.

Parameters

TInt aResultCount The number of results returned by the recognizer.

IMPORT_C TInt ResultCount() const;

Description

Returns the number of results actually returned after recogntion.

Return value

TInt The number of results actually returned after recogntion.

IMPORT_C void SetDiagnostic(TDiagnostic &aDiagnostic);

Description

Sets the diagnostic of this result set.

Parameters

TDiagnostic &aDiagnostic The reference to the diagostic object.

IMPORT_C const TDiagnostic &Diagnostic() const;

Description

Gets the diagnostic of this result set.

Return value

const TDiagnostic & A reference to TDiagnostic object.

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Writes the state of the class to a stream.

Parameters

RWriteStream &aStream The stream to write to.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Restores the state of the object from a stream.

Parameters

RReadStream &aStream The stream to read from.