CCFContextObject Class Reference

class CCFContextObject : public CBase

Context object is used to deliver context information. A single context object consists of source, type, value timestamp and confidence.

Source: Source defines the origin of the context which can contain several different types.

Type: Type describes a specific context from a certain source. Type can have also sub types. Example: [TypeA] [TypeA.SubType]

Value: Value defines the current value of the context. Value is always represneted as a descriuptor but it can be treated inside rules as in the form of string, int, float or boolean.

Timestamp: Timestamp defines when the context value has been updated.

CFServices.lib
Since
S60 5.0

Inherits from

Member Functions Documentation

Confidence()

TUint8 Confidence ( ) const [pure virtual]

Returns the confidence value of the context in percentages which should normally range between 0 and 100%.

Since
S60 5.0

CopyL(const CCFContextObject &)

void CopyL ( const CCFContextObject & aContext ) [pure virtual]

Copies data from existing context object to this one.

Since
S60 5.0

Parameters

const CCFContextObject & aContext Context object to copy.

NewL()

IMPORT_C CCFContextObject * NewL ( ) [static]

Two phased constructors.

Since
S60 5.0

NewL(const TDesC &, const TDesC &, const TDesC &)

IMPORT_C CCFContextObject * NewL ( const TDesC & aSource,
const TDesC & aType,
const TDesC & aValue
) [static]

Two phased constructors.

Since
S60 5.0

Parameters

const TDesC & aSource Initial source of the context.
const TDesC & aType Initial type of the context.
const TDesC & aValue Initial value of the context.

NewLC()

IMPORT_C CCFContextObject * NewLC ( ) [static]

NewLC(const TDesC &, const TDesC &, const TDesC &)

IMPORT_C CCFContextObject * NewLC ( const TDesC & aSource,
const TDesC & aType,
const TDesC & aValue
) [static]

Parameters

const TDesC & aSource
const TDesC & aType
const TDesC & aValue

SetConfidence(const TUint8 &)

void SetConfidence ( const TUint8 & aConfidence ) [pure virtual]

Sets the context confidence. Sets the confidence for this context as a percentage number which should normally be between zero and one hundred (0 - 100%). The actual value is not checked.

Since
S60 5.0

Parameters

const TUint8 & aConfidence The confidence for the context in percentages, from 0 to 100%.

SetSourceL(const TDesC &)

void SetSourceL ( const TDesC & aSource ) [pure virtual]

Sets the context source. Copies the entire argument to the context source member variable.

Since
S60 5.0

Parameters

const TDesC & aSource The source string to be copied.

SetTimestamp(const TTime &)

void SetTimestamp ( const TTime & aTimestamp ) [pure virtual]

Sets the context time stamp. Sets the time stamp for this context.

Since
S60 5.0

Parameters

const TTime & aTimestamp The time stamp for the context.

SetTimestamp(const TInt64 &)

void SetTimestamp ( const TInt64 & aTimestamp ) [pure virtual]

Sets the context time stamp. Sets the time stamp for this context.

Since
S60 5.0

Parameters

const TInt64 & aTimestamp The time stamp for the context.

SetTimestampToHomeTime()

void SetTimestampToHomeTime ( ) [pure virtual]

Sets the context time stamp to the home time. Sets the time stamp of this context to equal the home time at the time of calling this method.

Since
S60 5.0

SetTypeL(const TDesC &)

void SetTypeL ( const TDesC & aType ) [pure virtual]

Sets the context type. Copies the entire argument to the context type member variable.

Since
S60 5.0

Parameters

const TDesC & aType The type string to be copied.

SetValueL(const TDesC &)

void SetValueL ( const TDesC & aValue ) [pure virtual]

Sets the context value. Copies the entire argument to the context value member variable.

Since
S60 5.0

Parameters

const TDesC & aValue The value string to be copied.

Source()

const TDesC & Source ( ) const [pure virtual]

Returns a constant reference to the context source descriptor.

Since
S60 5.0

Timestamp()

const TTime & Timestamp ( ) const [pure virtual]

Returns the time stamp of the context.

Since
S60 5.0

Type()

const TDesC & Type ( ) const [pure virtual]

Returns a constant reference to the context type descriptor.

Since
S60 5.0

Value()

const TDesC & Value ( ) const [pure virtual]

Returns a constant reference to the context value descriptor.

Since
S60 5.0