Collapse all Symbian^3 Product Developer Library

CSDClientResultSet Class Reference

class CSDClientResultSet : public CBase

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

Since: 8.0

Inherits from

CSDClientResultSet
- CBase

Public Member Functions
	~CSDClientResultSet()
IMPORT_C const CSDClientResult &	At(TInt)
IMPORT_C const TDiagnostic &	Diagnostic()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TInt	MaxResults()
IMPORT_C CSDClientResultSet *	NewL()
IMPORT_C CSDClientResultSet *	NewLC()
IMPORT_C TInt	ResultCount()
IMPORT_C void	SetDiagnostic(TDiagnostic &)
IMPORT_C void	SetMaxResultsL(TInt)
IMPORT_C void	SetResultCount(TInt)

Private Member Functions
	CSDClientResultSet()
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
TDiagnostic *	iDiagnostic
TInt	iMaxResults
RPointerArray< CSDClientResult >	iResultArray
TInt	iResultCount

Constructor & Destructor Documentation

CSDClientResultSet()

CSDClientResultSet

(

)

[private]

~CSDClientResultSet()

IMPORT_C

~CSDClientResultSet

(

)

Destructor.

Member Functions Documentation

At(TInt)

IMPORT_C const CSDClientResult &

(

TInt

aIndex

)

const

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

Since: 8.0

Parameters

TInt aIndex

The index of result to return.

ConstructL()

void

ConstructL

(

)

[private]

Diagnostic()

IMPORT_C const TDiagnostic &

Diagnostic

(

)

const

Gets the diagnostic of this result set.

Since: 8.0

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Writes the state of the class to a stream.

Since: 8.0

Parameters

RWriteStream & aStream

The stream to write to.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Restores the state of the object from a stream.

Since: 8.0

Parameters

RReadStream & aStream

The stream to read from.

MaxResults()

IMPORT_C TInt

MaxResults

(

)

const

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

Since: 8.0

NewL()

IMPORT_C CSDClientResultSet *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CSDClientResultSet *

NewLC

(

)

[static]

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

ResultCount()

IMPORT_C TInt

ResultCount

(

)

const

Returns the number of results actually returned after recogntion.

Since: 8.0

SetDiagnostic(TDiagnostic &)

IMPORT_C void

SetDiagnostic

(

TDiagnostic &

aDiagnostic

)

Sets the diagnostic of this result set.

Since: 8.0

Parameters

TDiagnostic & aDiagnostic

The reference to the diagostic object.

SetMaxResultsL(TInt)

IMPORT_C void

SetMaxResultsL

(

TInt

aMaxResults

)

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

Since: 8.0

Parameters

TInt aMaxResults

The maximum number of matches expected in the recognition result.

SetResultCount(TInt)

IMPORT_C void

SetResultCount

(

TInt

aResultCount

)

Sets the number of results actually returned after recogntion.

Since: 8.0

Parameters

TInt aResultCount

The number of results returned by the recognizer.

Member Data Documentation

TDiagnostic * iDiagnostic

TDiagnostic *

iDiagnostic

[private]

TInt iMaxResults

TInt

iMaxResults

[private]

RPointerArray< CSDClientResult > iResultArray

RPointerArray< CSDClientResult >

iResultArray

[private]

TInt iResultCount

TInt

iResultCount

[private]