Collapse all Symbian^3 Application Developer Library

CPsData Class Reference

class CPsData : public CBase

Utility class to store data for predictive search. This is the basic data class that is used to marshal data between the client, server and data plugins.

pcsutils.lib

Since: S60 v3.2

Inherits from

CPsData
- CBase

Public Member Functions
	~CPsData ()
IMPORT_C void	AddIntDataExtL ( TInt )
IMPORT_C void	ClearDataMatches ()
IMPORT_C TInt	CompareByData (const CPsData &, const CPsData &)
IMPORT_C TBool	CompareById (const CPsData &, const CPsData &)
IMPORT_C HBufC *	Data ( TInt )
IMPORT_C TInt	DataElementCount ()
IMPORT_C TAny *	DataExtension ()
IMPORT_C TUint8	DataMatch ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C TInt	Id ()
IMPORT_C void	IntDataExt ( RArray < TInt > &)
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TBool	IsDataMatch ( TInt )
IMPORT_C CPsData *	NewL ()
IMPORT_C void	RemoveIntDataExt ( TInt )
IMPORT_C void	SetDataExtension ( TAny *)
IMPORT_C void	SetDataL (const TInt , const TDesC &)
IMPORT_C void	SetDataMatch ( TInt )
IMPORT_C void	SetId (const TInt )
IMPORT_C void	SetUriId (const TUint8 )
IMPORT_C TUint8	UriId ()

Private Member Functions
	CPsData ()
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
RPointerArray < HBufC > *	iData
TAny *	iDataExtension
TUint8	iDataMatches
RPointerArray < HBufC > *	iGc
TInt	iId
RArray < TInt > *	iIntDataExt
TUint8	iUriId

Constructor & Destructor Documentation

CPsData()

CPsData

(

)

[private]

Default Constructor

~CPsData()

IMPORT_C

~CPsData

(

)

Destructor

Member Functions Documentation

AddIntDataExtL(TInt)

IMPORT_C void

AddIntDataExtL

(

TInt

aDataExt

)

Add element to the Integer Data Extention

Parameters

TInt aDataExt

- Integer Data Extension to be added

ClearDataMatches()

IMPORT_C void

ClearDataMatches

(

)

Clear all the bits set in data matches

CompareByData(const CPsData &, const CPsData &)

IMPORT_C TInt	CompareByData	(	const CPsData &	aObject1,
			const CPsData &	aObject2
		)	[static]

Method to compare two CPsData objects

Parameters

const CPsData & aObject1	Instance 1 to be compared
const CPsData & aObject2	Instance 2 to be compared

CompareById(const CPsData &, const CPsData &)

IMPORT_C TBool	CompareById	(	const CPsData &	aObject1,
			const CPsData &	aObject2
		)	[static]

Method to compare two CPsData objects based on unique Id

Parameters

const CPsData & aObject1	Instance 1 to be compared
const CPsData & aObject2	Instance 2 to be compared

ConstructL()

void

ConstructL

(

)

[private]

Second phase constructor

Data(TInt)

IMPORT_C HBufC *

Data

(

TInt

aIndex

)

const

Pointer to the data element at the specified location

Parameters

TInt aIndex

Index of data element

DataElementCount()

IMPORT_C TInt

DataElementCount

(

)

const

Returns the number of data elements

DataExtension()

IMPORT_C TAny *

DataExtension

(

)

const

Returns the data extension

DataMatch()

IMPORT_C TUint8

DataMatch

(

)

Returns the data match attribute

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Writes 'this' to the stream

Parameters

RWriteStream & aStream

WriteStream with externalized contents

Id()

IMPORT_C TInt

(

)

const

Provides the unique identifier of this object

IntDataExt(RArray< TInt > &)

IMPORT_C void

IntDataExt

(

RArray < TInt > &

aDataExtArray

)

Retrieve Integer Data Extention Array

Parameters

RArray < TInt > & aDataExtArray

- Integer Data Extension array

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Initializes 'this' from stream

Parameters

RReadStream & aStream

ReadStream with data contents to be internalized

IsDataMatch(TInt)

IMPORT_C TBool

IsDataMatch

(

TInt

aIndex

)

Checks if data at array index is matched for predictive search

Parameters

TInt aIndex

Index of data element

NewL()

IMPORT_C CPsData *

NewL

(

)

[static]

Two phase construction

RemoveIntDataExt(TInt)

IMPORT_C void

RemoveIntDataExt

(

TInt

aIndex

)

Remove element from the Integer Data Extention

Parameters

TInt aIndex

- Integer Data Extension array index

SetDataExtension(TAny *)

IMPORT_C void

SetDataExtension

(

TAny *

aDataExt

)

Set the data extension

Parameters

TAny * aDataExt

Data Extension for this object

SetDataL(const TInt, const TDesC &)

IMPORT_C void	SetDataL	(	const TInt	aIndex,
			const TDesC &	aData
		)

Sets the data at the specified location

Parameters

const TInt aIndex	Index of data element
const TDesC & aData	Data descriptor to be searched

SetDataMatch(TInt)

IMPORT_C void

SetDataMatch

(

TInt

aIndex

)

Sets data at array index has matched for predictive search

Parameters

TInt aIndex

Index of data element

SetId(const TInt)

IMPORT_C void

SetId

(

const TInt

aId

)

Sets the unique identifier of this object

Parameters

const TInt aId

The unique identifier

SetUriId(const TUint8)

IMPORT_C void

SetUriId

(

const TUint8

aUriId

)

Sets the unique URI identifier of this object

Parameters

const TUint8 aUriId

The unique URI identifier

UriId()

IMPORT_C TUint8

UriId

(

)

const

Provides the unique URI identifier of this object

Member Data Documentation

RPointerArray< HBufC > * iData

RPointerArray < HBufC > *

iData

[private]

Data fields

TAny * iDataExtension

TAny *

iDataExtension

[private]

Extended Data field

TUint8 iDataMatches

TUint8

iDataMatches

[private]

Indicates in bit positions, what data fields are matched for predictive search

RPointerArray< HBufC > * iGc

RPointerArray < HBufC > *

iGc

[private]

Garbage collector to fix performance issue

TInt iId

TInt

iId

[private]

Unique id

RArray< TInt > * iIntDataExt

RArray < TInt > *

iIntDataExt

[private]

Extended Data field of Integers

TUint8 iUriId

TUint8

iUriId

[private]

URI ID. Indicates the data source.