inc/engine/tilefetcher/TileFetcherError.h

   1 /*
   2  * Copyright (C) 2013 HERE Global B.V. All rights reserved.
   3  * This software, including documentation, is protected by copyright controlled by
   4  * HERE Global B.V. (“Software”). All rights are reserved. Copying, including reproducing,
   5  * storing, adapting or translating, any or all of this material requires the prior
   6  * written consent of HERE Global B.V. You may use this
   7  * Software in accordance with the terms and conditions defined in the
   8  * HERE Location Platform Services Terms and Conditions, available at
   9  * http://developer.here.com/terms-conditions-base
  10  *
  11  * As an additional permission to the above, you may distribute Software,
  12  * in object code format as part of an Application, according to, and subject to, terms and
  13  * conditions defined in the Tizen Software Development kit (“SDK”) License Agreement.
  14  * You may distribute such object code format Application under terms of your choice,
  15  * provided that the header and source files of the Software have not been modified.
  16  */
  17
  18 #ifndef TILEFETCHERERROR_H
  19 #define TILEFETCHERERROR_H
  20
  21 #include "common/HereMaps_global.h"
  22 #include "common/ErrorBase.h"
  23
  24 HERE_MAPS_BEGIN_NAMESPACE
  25
  26 /**
  27  * This class encapsulates information related to an error condition that may
  28  * arise when requesting map tiles from the server.
  29  *
  30  * \ingroup tilefetcher
  31  */
  32 class EXPORT_API TileFetcherError : public ErrorBase
  33 {
  34 public:
  35
  36     /**
  37      * This enumeration defines identifiers for error conditions related to the
  38      * tile fetcher.
  39      */
  40     enum ErrorEntity
  41     {
  42         TFE_COULD_NOT_DECODE_SRC_IMAGE, ///< Indicates that the source image
  43                                         ///  could not be decoded.
  44         TFE_COULD_NOT_RETRIEVE_HASH     ///< Indicates that the hash could not
  45                                         ///  be retrieved.
  46     };
  47
  48     /**
  49      * This method is a constructor.
  50      *
  51      * @param aItem A value rerpresenting an error condition; a value with which
  52      *       to initialize the given instance of the class.
  53      */
  54     TileFetcherError(ErrorEntity aItem);
  55
  56     /**
  57      * This method is the (virtual) destructor.
  58      */
  59     virtual ~TileFetcherError();
  60
  61     /**
  62      * This method produces a string representation of the given instance of
  63      * the class. The method must be implemented by derived classes.
  64      *
  65      * @return A string containing a text representation of the given instance
  66      *        of the class.
  67      */
  68     virtual String ToString() const;
  69
  70 private:
  71     HERE_MAPS_NO_COPY_NO_ASSIGN(TileFetcherError);
  72
  73     class TileFetcherErrorImpl;
  74     TileFetcherErrorImpl* m_pImpl;
  75 };
  76
  77 HERE_MAPS_END_NAMESPACE
  78
  79 #endif