landmarks/locationlandmarks/converter/inc/EPos_CPosLmXmlEncoderOperation.h
changeset 0 667063e416a2
equal deleted inserted replaced
-1:000000000000 0:667063e416a2
       
     1 /*
       
     2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: Operation for finalizing an encoder.
       
    15 *
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef CPOSLMXMLENCODEROPERATION_H
       
    21 #define CPOSLMXMLENCODEROPERATION_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include "EPos_CPosLmConverterOperation.h"
       
    25 
       
    26 // CONSTANTS
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 class CPosLmOutput;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34 * Operation for finalizing an encoder. This operation can be either synchronous
       
    35 * or asynchronous.
       
    36 *
       
    37 *  @lib eposconverter.lib
       
    38 */
       
    39 class CPosLmXmlEncoderOperation : public CPosLmConverterOperation
       
    40     {
       
    41 
       
    42     public:  // Constructors and destructor
       
    43 
       
    44         /**
       
    45         * Two-phased constructor.
       
    46         * @param aEncoderOutput The output for the encoder. This class takes
       
    47         *   ownership of the output.
       
    48         * @returns A new instance of this class.
       
    49         */
       
    50         static CPosLmXmlEncoderOperation* NewL(
       
    51         /* IN */        CPosLmOutput* aEncoderOutput
       
    52         );
       
    53 
       
    54         /**
       
    55         * Destructor.
       
    56         */
       
    57         virtual ~CPosLmXmlEncoderOperation();
       
    58 
       
    59     public: // Functions from base classes
       
    60 
       
    61         /**
       
    62         * From CPosLmConverterOperation;
       
    63         *
       
    64         * @param aProgress Will be set to the progress of the operation when
       
    65         * the step has finished.
       
    66         * @return @p KPosLmOperationNotComplete if the step has completed but
       
    67         *   more steps are needed before the operation has finished,
       
    68         *   @p KErrNone if the operation has finished successfully.
       
    69         */
       
    70         TInt NextStepL(
       
    71         /* OUT */   TReal32& aProgress
       
    72         );
       
    73 
       
    74         /**
       
    75         * From CPosLmConverterOperation;
       
    76         *
       
    77         * @param aError An error code generated by NextStepL.
       
    78         */
       
    79         void HandleError(
       
    80         /* IN/OUT */    TInt& aError
       
    81         );
       
    82 
       
    83         /**
       
    84         * From CPosLmConverterOperation;
       
    85         *
       
    86         */
       
    87         void HandleOperationCompleted();
       
    88 
       
    89     private:
       
    90 
       
    91         /**
       
    92         * C++ default constructor.
       
    93         * @param aEncoderOutput The output for the encoder. This class takes
       
    94         *   ownership of the output.
       
    95         */
       
    96         CPosLmXmlEncoderOperation(
       
    97         /* IN */        CPosLmOutput* aEncoderOutput
       
    98         );
       
    99 
       
   100         /**
       
   101         * By default Symbian 2nd phase constructor is private.
       
   102         */
       
   103         void ConstructL();
       
   104 
       
   105         // Prohibit copy constructor if not deriving from CBase.
       
   106         CPosLmXmlEncoderOperation(const CPosLmXmlEncoderOperation&);
       
   107         // Prohibit assigment operator if not deriving from CBase.
       
   108         CPosLmXmlEncoderOperation& operator=(const CPosLmXmlEncoderOperation&);
       
   109 
       
   110     private:    // Data
       
   111 
       
   112         CPosLmOutput*       iEncoderOutput;
       
   113 
       
   114     };
       
   115 
       
   116 #endif      // CPOSLMXMLENCODEROPERATION_H
       
   117 
       
   118 // End of File