CRequestorBase Class Reference

#include <lbsrequestor.h>

Link against: lbs.lib

class CRequestorBase : public CBase

Inherits from

  • CRequestorBase
    Public Member Type Definitions
    typedef TInt TRequestorFormat
    typedef TInt TRequestorType
    Protected Attributes
    TRequestorFormat iFormat
    TRequestorType iRequestorType
    Public Member Enumerations
    enum_TRequestorFormat { EFormatUnknown, EFormatApplication, EFormatTelephone, EFormatUrl, EFormatMail }
    enum_TRequestorType { ERequestorUnknown, ERequestorService, ERequestorContact }
    Public Member Functions
    ~CRequestorBase()
    virtual IMPORT_C voidExternalizeL(RWriteStream &)
    IMPORT_C voidGetRequestor(TRequestorType &, TRequestorFormat &, TPtrC &)
    virtual IMPORT_C voidInternalizeL(RReadStream &)
    IMPORT_C TDesC &RequestorData()
    IMPORT_C TRequestorFormatRequestorFormat()
    IMPORT_C TRequestorTypeRequestorType()
    IMPORT_C voidSetRequestorL(TRequestorType, TRequestorFormat, const TDesC &)
    Protected Member Functions
    CRequestorBase()
    IMPORT_C voidConstructL(TRequestorType, TRequestorFormat, const TDesC &)
    virtual IMPORT_C TAny *ExtendedInterface(TInt, TAny *, TAny *)
    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()

    Detailed Description

    Each instance of a CRequestor class is used to hold the identity of one of the parties involved requesting the location. The class contains three data fields that indicate: (1) If the requesting party is a "service" or an actual person ("contact"). (2) A descriptor that identifiers the requestor and (3) a field that indicates which format the information is in

    • for example, a telephone number, URL or email address.

    Member Type Definition Documentation

    Typedef TRequestorFormat

    typedef TInt TRequestorFormat

    defined type for TRequestorFormat

    Typedef TRequestorType

    typedef TInt TRequestorType

    defined type for TRequestorType

    Member Attribute Documentation

    iFormat

    TRequestorFormat iFormat[protected]

    Requestor format

    iRequestorType

    TRequestorType iRequestorType[protected]

    Requestor type

    Member Enumeration Documentation

    Enum _TRequestorFormat

    TRequestorFormat

    EnumeratorValueDescription
    EFormatUnknown

    Requestor format unknown

    EFormatApplication

    EFormatApplication

    EFormatTelephone

    EFormatTelephone

    EFormatUrl

    EFormatUrl

    EFormatMail

    EFormatMail

    Enum _TRequestorType

    TRequestorType

    EnumeratorValueDescription
    ERequestorUnknown

    Unknown Requestor

    ERequestorService

    Requestor of type Service

    ERequestorContact

    Requestor of type Contact

    Constructor & Destructor Documentation

    CRequestorBase ( )

    IMPORT_CCRequestorBase()[protected]

    Constructor for CRequestorBase.

    ~CRequestorBase ( )

    IMPORT_C~CRequestorBase()

    Destructor for CRequestorBase.

    Member Function Documentation

    ConstructL ( TRequestorType, TRequestorFormat, const TDesC & )

    IMPORT_C voidConstructL(TRequestorTypeaType,
    TRequestorFormataFormat,
    const TDesC &aData
    )[protected]

    Second phase constructor. Must be called by all derived classes to initialise CRequestorBase.

    ParameterDescription
    aTypeidentifies the type of requestor, a service or a contact.
    aFormatdetermines the type of data held in aData
    aDatais requestor data. Can be a telephone number, a URL etc.

    ExtendedInterface ( TInt, TAny *, TAny * )

    IMPORT_C TAny *ExtendedInterface(TIntaFunctionNumber,
    TAny *aPtr1,
    TAny *aPtr2
    )[protected, virtual]

    This method is used to allow polymorphic extensions to the API without breaking BC. See documentation for explanation.

    ParameterDescription
    aFunctionNumbercontains the Id of the function to be invoked.
    aPtr1a pointer to any data
    aPtr2a pointer to any data.

    Returns: TAny* a pointer to any function

    ExternalizeL ( RWriteStream & )

    IMPORT_C voidExternalizeL(RWriteStream &aStream)const [virtual]

    Stores this requestors member data to a stream.

    ParameterDescription
    aStreamthe stream to which the requestors data is written.

    GetRequestor ( TRequestorType &, TRequestorFormat &, TPtrC & )

    IMPORT_C voidGetRequestor(TRequestorType &aType,
    TRequestorFormat &aFormat,
    TPtrC &aData
    )const

    Simple accessor for this requestors member data.

    ParameterDescription
    aTypewill be set to the type of requestor.
    aFormatwill be set to the type of data held in aData.
    aDatawill be set to point to this requestors data.

    InternalizeL ( RReadStream & )

    IMPORT_C voidInternalizeL(RReadStream &aStream)[virtual]

    Restores this requestors member data from a stream.

    ParameterDescription
    aStreamthe stream from which the requestors data is read.

    RequestorData ( )

    IMPORT_C TDesC &RequestorData()const

    Simple accessor for this requestors member data.

    Returns: the requestor data.

    RequestorFormat ( )

    IMPORT_C TRequestorFormatRequestorFormat()const

    Simple accessor for this requestors member data.

    Returns: the type of data held in this requestor.

    RequestorType ( )

    IMPORT_C TRequestorTypeRequestorType()const

    Simple accessor for this requestors member data.

    Returns: the type of requestor, a service or a contact.

    SetRequestorL ( TRequestorType, TRequestorFormat, const TDesC & )

    IMPORT_C voidSetRequestorL(TRequestorTypeaType,
    TRequestorFormataFormat,
    const TDesC &aData
    )

    Replaces the requestor data for this object with the specified data.

    ParameterDescription
    aTypeidentifies the type of requestor, a service or a contact.
    aFormatdetermines the type of data held in aData
    aDatais requestor data. Can be a telephone number, a URL etc.
    © Nokia 2011.