TAiwGenericParam Class Reference

Link against: servicehandler.lib

Capability Information

Required Capabilities

None

#include <AiwGenericParam.h>

Detailed Description

Generic parameter class for passing data between applications.

A generic parameter is a pair of semantic ID and variant value. The semantic ID tells the purpose of the parameter, for example a file name, URL or phone number. The variant value contains the data format and actual value. This class does not implement any consistency checks between the semantic ID and value's data format. So one semantic ID can be expressed as alternative data formats.

Dll ServiceHandler.lib
Since:
Series 60 2.6
See also:
TAiwVariant

CAiwGenericParamList


Public Member Functions

 TAiwGenericParam ()
 Constructs a generic parameter.
 TAiwGenericParam (TGenericParamId aSemanticId)
 Constructs a generic parameter.
 TAiwGenericParam (TGenericParamId aSemanticId, const TAiwVariant &aValue)
 Constructs a generic parameter.
void SetSemanticId (TGenericParamId aSemanticId)
 Sets the semantic ID.
TGenericParamId SemanticId () const
 Returns the semantic ID of this parameter.
TAiwVariant & Value ()
 Returns the value of this parameter.
const TAiwVariant & Value () const
 Returns the const value of this parameter.
void Reset ()
 Resets the semantic ID and the value of this parameter.

Friends

class CAiwGenericParamList

Constructor & Destructor Documentation

TAiwGenericParam::TAiwGenericParam (   )  [inline]
 

Constructs a generic parameter.

TAiwGenericParam::TAiwGenericParam ( TGenericParamId  aSemanticId  )  [inline]
 

Constructs a generic parameter.

Parameters:
aSemanticId The semantic ID of the parameter, one of TGenericParamId values.
TAiwGenericParam::TAiwGenericParam ( TGenericParamId  aSemanticId,
const TAiwVariant &  aValue
)  [inline]
 

Constructs a generic parameter.

Parameters:
aSemanticId The semantic ID of the parameter, one of TGenericParamId values.
aValue The parameter value.

Member Function Documentation

void TAiwGenericParam::Reset (   )  [inline]
 

Resets the semantic ID and the value of this parameter.

TGenericParamId TAiwGenericParam::SemanticId (   )  const [inline]
 

Returns the semantic ID of this parameter.

Returns:
The semantic ID.
void TAiwGenericParam::SetSemanticId ( TGenericParamId  aSemanticId  )  [inline]
 

Sets the semantic ID.

Possibly set previous ID is overwritten.

Parameters:
aSemanticId The semantic ID of the parameter.
const TAiwVariant & TAiwGenericParam::Value (   )  const [inline]
 

Returns the const value of this parameter.

Returns:
The const value of the parameter.
TAiwVariant & TAiwGenericParam::Value (   )  [inline]
 

Returns the value of this parameter.

Returns:
The value of the parameter.

Friends And Related Function Documentation

friend class CAiwGenericParamList [friend]
 
The documentation for this class was generated from the following files:
Copyright © Nokia Corporation 2001-2007
Back to top