inc/engine/routes/GeoRouteQueryListener.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 GEOROUTEQUERYLISTENER_H
  19 #define GEOROUTEQUERYLISTENER_H
  20
  21 #include "common/HereMaps_global.h"
  22 #include "common/QueryListener.h"
  23
  24 #include "routes/GeoRouteReply.h"
  25
  26 HERE_MAPS_BEGIN_NAMESPACE
  27
  28 class GeoRouteReply;
  29
  30 /**
  31  * This class encapsulates an object that is notified when a response to a query
  32  * has become available. The derived classes must implement the methods defined
  33  * on this class to provide handling of the replies from the server.
  34  *
  35  * \ingroup routes
  36  */
  37 class EXPORT_API GeoRouteQueryListener : public QueryListener
  38 {
  39 public:
  40
  41     /**
  42      * This is the default constructor.
  43      */
  44     GeoRouteQueryListener();
  45
  46     /**
  47      * This method is the destructor.
  48      */
  49     ~GeoRouteQueryListener();
  50
  51     /**
  52      * This method is a callback invoked when data have arrived in response to a
  53      * route request.
  54      *
  55      * @param rReply A Constant reference to an object containing the response data.
  56      */
  57     virtual void OnRouteReply(const GeoRouteReply& rReply) = 0;
  58
  59     #ifdef TIZEN_MIGRATION
  60     /**
  61      * This method is a callback invoked when geocoding request is failed.
  62      *
  63      * @param rReply A Constant reference to an object containing the response data.
  64      */
  65     virtual void OnRouteFailure(const GeoRouteReply& rReply) = 0;
  66     #endif
  67
  68 private:
  69
  70     void OnReplySuccess(BaseReply& rReply);
  71
  72     #ifdef TIZEN_MIGRATION
  73     void OnFailure(const BaseReply& rReply);
  74     #endif
  75 };
  76
  77 HERE_MAPS_END_NAMESPACE
  78
  79 #endif