Collapse all Symbian^3 Application Developer Library

CSIClientResultSet Class Reference

class CSIClientResultSet : public CBase

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

nsssispeechrecognitiondata.lib

Since: 2.5

Inherits from

CSIClientResultSet
- CBase

Public Member Functions
	~CSIClientResultSet ()
IMPORT_C void	AddL (const CSIClientResult *)
IMPORT_C const CSIClientResult &	AtL ( TInt )
IMPORT_C void	DeleteL ( TInt )
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TInt	MaxResults ()
IMPORT_C CSIClientResultSet *	NewL ()
IMPORT_C CSIClientResultSet *	NewLC ()
IMPORT_C TInt	ResultCount ()
IMPORT_C CSIResultSet &	SIResultSet ()
IMPORT_C void	SetMaxResultsL ( TInt )
IMPORT_C void	SetResultCount ( TInt )
IMPORT_C void	SetSIResultSet ( CSIResultSet *)

Private Member Functions
	CSIClientResultSet ()
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
TInt	iMaxResults
RPointerArray < CSIClientResult >	iResultArray
TInt	iResultCount
CSIResultSet *	iSIResultSet

Constructor & Destructor Documentation

CSIClientResultSet()

CSIClientResultSet

(

)

[private]

~CSIClientResultSet()

IMPORT_C

~CSIClientResultSet

(

)

Destructor.

Member Functions Documentation

AddL(const CSIClientResult *)

IMPORT_C void

AddL

(

const CSIClientResult *

aResult

)

Use to add a result to the result set.

Since: 2.5

Parameters

const CSIClientResult * aResult

- reference to the result object to be added.

AtL(TInt)

IMPORT_C const CSIClientResult &

AtL

(

TInt

anIndex

)

const

Use to retrieve a result at a given index within the result set.

Since: 2.5

Parameters

TInt anIndex

ConstructL()

void

ConstructL

(

)

[private]

DeleteL(TInt)

IMPORT_C void

DeleteL

(

TInt

aIndex

)

Use to delete a result to the result set.

Since: 2.5

Parameters

TInt aIndex

Index of .

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Externalize from a data stream

Since: 2.8

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Internalize to a data stream

Since: 2.8

Parameters

RReadStream & aStream

Data stream

MaxResults()

IMPORT_C TInt

MaxResults

(

)

const

Use to retrieve the current value of the max number of expected after recognition.

Since: 2.5

NewL()

IMPORT_C CSIClientResultSet *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CSIClientResultSet *

NewLC

(

)

[static]

ResultCount()

IMPORT_C TInt

ResultCount

(

)

const

Use to retrieve the number of results actually returned after recogntion.

Since: 2.5

SIResultSet()

IMPORT_C CSIResultSet &

SIResultSet

(

)

const

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: 2.5

Parameters

TInt aMaxResults

- the maximum number of matches expected in the recognition result.

SetResultCount(TInt)

IMPORT_C void

SetResultCount

(

TInt

aResultCount

)

Use to set the number of results actually returned after recogntion.

Since: 2.5

Parameters

TInt aResultCount

- number of results returned by the recognizer.

SetSIResultSet(CSIResultSet *)

IMPORT_C void

SetSIResultSet

(

CSIResultSet *

aSIResultSet

)

Parameters

CSIResultSet * aSIResultSet

Member Data Documentation

TInt iMaxResults

TInt

iMaxResults

[private]

RPointerArray< CSIClientResult > iResultArray

RPointerArray < CSIClientResult >

iResultArray

[private]

TInt iResultCount

TInt

iResultCount

[private]

CSIResultSet * iSIResultSet

CSIResultSet *

iSIResultSet

[private]