inc/engine/geocoder/GeoCoderReplyParserError.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 GEOCODERERROR_H
  19 #define GEOCODERERROR_H
  20
  21 #include "common/HereMaps_global.h"
  22
  23 #include "common/ErrorBase.h"
  24
  25 HERE_MAPS_BEGIN_NAMESPACE
  26
  27 /**
  28  * This class encapsulates information about an error that
  29  * may arise when a parsing a geocoding request.
  30  *
  31  * \ingroup geocoding
  32  */
  33 class GeoCoderReplyParserError : public ErrorBase
  34 {
  35 public:
  36     /**
  37      * This method is a constructor.
  38      *
  39      * @param sStr A constant reference to a string containing an error message.
  40      */
  41     GeoCoderReplyParserError(const std::string& sStr);
  42
  43     /**
  44      * This method is a (virtual) destructor.
  45      */
  46     virtual ~GeoCoderReplyParserError();
  47
  48     /**
  49      * This method retrieves a string representation of the given instance of
  50      * the class.
  51      *
  52      * @return A string containing the error information held in the given
  53      *        instance of the class.
  54      */
  55     virtual String ToString() const;
  56
  57 private:
  58     HERE_MAPS_NO_COPY_NO_ASSIGN(GeoCoderReplyParserError);
  59
  60     class GeoCoderReplyParserErrorImpl;
  61     GeoCoderReplyParserErrorImpl* m_pImpl;
  62 };
  63
  64 HERE_MAPS_END_NAMESPACE
  65
  66 #endif