williamr@2: /*
williamr@2: * Copyright (c) 2005-2006 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  CPosLmPartialReadParameters class
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef CPOSLMPARTIALREADPARAMETERS_H
williamr@2: #define CPOSLMPARTIALREADPARAMETERS_H
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <LbsFields.h>
williamr@2: #include "EPos_CPosLandmark.h"
williamr@2: 
williamr@2: /**
williamr@2: *  Container class for partial landmark settings.
williamr@2: *  Partial settings are used to define which landmark data should be returned
williamr@2: *  when @ref CPosLandmarkDatabase::ReadPartialLandmarkLC is called.
williamr@2: *
williamr@2: *  @lib eposlandmarks.lib
williamr@2: *  @since S60 3.0
williamr@2: */
williamr@2: class CPosLmPartialReadParameters : public CBase
williamr@2:     {
williamr@2:     public:
williamr@2: 
williamr@2:         /**
williamr@2:         * Two-phased constructor.
williamr@2:         * @returns A new instance of this class.
williamr@2:         */
williamr@2:         IMPORT_C static CPosLmPartialReadParameters* NewLC();
williamr@2: 
williamr@2:         /**
williamr@2:         * Destructor.
williamr@2:         */
williamr@2:         virtual ~CPosLmPartialReadParameters();
williamr@2: 
williamr@2:     public:
williamr@2: 
williamr@2:         /**
williamr@2:         * Returns a bitmap of the landmark attributes which should be included
williamr@2:         * in a partial landmark.
williamr@2:         *
williamr@2:         * The bitmap is a combination of the values in
williamr@2:         * CPosLandmark::TAttribute.
williamr@2:         *
williamr@2:         * @return The partial landmark attributes bitmap.
williamr@2:         */
williamr@2:         IMPORT_C CPosLandmark::TAttributes RequestedAttributes() const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Sets a bitmap of the landmark attributes which should be included in
williamr@2:         * a partial landmark.
williamr@2:         *
williamr@2:         * The bitmap is constructed from the values in
williamr@2:         * CPosLandmark::TAttribute.
williamr@2:         *
williamr@2:         * @param[in] aAttributes A partial landmark attributes bitmap.
williamr@2:         */
williamr@2:         IMPORT_C void SetRequestedAttributes(
williamr@2:             CPosLandmark::TAttributes aAttributes
williamr@2:         );
williamr@2: 
williamr@2:         /**
williamr@2:         * Returns the position fields which should be included in a partial
williamr@2:         * landmark.
williamr@2:         *
williamr@2:         * @param[out] aRequestedFields Will contain the requested position fields,
williamr@2:         *   i.e. @p TPositionFieldId.
williamr@2:         * @returns @p KErrNone if successful, otherwise one of the system wide
williamr@2:         *   error codes.
williamr@2:         */
williamr@2:         IMPORT_C TInt GetRequestedPositionFields(
williamr@2:             RArray<TUint>& aRequestedFields
williamr@2:         ) const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Sets the position fields which should be included in a partial
williamr@2:         * landmark.
williamr@2:         *
williamr@2:         * @param[in] aRequestedFields The requested position fields, i.e.
williamr@2:         *   @p TPositionFieldId.
williamr@2:         * @returns @p KErrNone if successful, otherwise one of the system wide
williamr@2:         *   error codes.
williamr@2:         */
williamr@2:         IMPORT_C TInt SetRequestedPositionFields(
williamr@2:             const RArray<TUint>& aRequestedFields
williamr@2:         );
williamr@2: 
williamr@2:     private:
williamr@2: 
williamr@2:         // C++ constructor.
williamr@2:         CPosLmPartialReadParameters();
williamr@2: 
williamr@2:         // Symbian constructor
williamr@2:         void ConstructL();
williamr@2: 
williamr@2:         // Prohibit copy constructor
williamr@2:         CPosLmPartialReadParameters(
williamr@2:             const CPosLmPartialReadParameters& );
williamr@2:         // Prohibit assigment operator
williamr@2:         CPosLmPartialReadParameters& operator= (
williamr@2:             const CPosLmPartialReadParameters& );
williamr@2: 
williamr@2:     private:
williamr@2: 
williamr@2:         // Requested position fields
williamr@2:         RArray<TUint> iRequestedFields;
williamr@2: 
williamr@2:         // Requested attributes
williamr@2:         TUint32 iAttributes;
williamr@2:     };
williamr@2: 
williamr@2: #endif      // CPOSLMPARTIALREADPARAMETERS_H
williamr@2: 
williamr@2: