inc/engine/geocoder/MultiReverseReply.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 MULTIREVERSEREPLY_H_
  19 #define MULTIREVERSEREPLY_H_
  20
  21 #include "common/HereMaps_global.h"
  22 #include "common/BaseReply.h"
  23
  24 #include "geocoder/Result.h"
  25 #include "geocoder/MetaInfo.h"
  26
  27 TIZEN_MAPS_BEGIN_NAMESPACE
  28
  29 /**
  30  * This class encapsulates a reply to a geocoding query.
  31  *
  32  * The class receives the response data returned by the server in reply to a
  33  * query asynchronously. Notification that the data is available comes via a
  34  * listener object registered on the class by calling <code>AddListener()</code>.
  35  *
  36  * @ingroup geocoding
  37  */
  38 class EXPORT_API MultiReverseReply : public Here::Maps::BaseReply
  39 {
  40 public:
  41
  42     /**
  43      * This is the default constructor.
  44      */
  45     MultiReverseReply();
  46
  47     /**
  48      * This is a destructor.
  49      */
  50     virtual ~MultiReverseReply();
  51
  52     /**
  53      * This method retrieves a value indicating the number of results in the
  54      * reply to the query.
  55      *
  56      * @return An integer value indicating the number of results.
  57      */
  58     size_t GetNumResults() const;
  59
  60     /**
  61      * This method retrieves a result at the index specified by the caller.
  62      *
  63      * @param A value indicating the index of the result to retrieve.
  64      *
  65      * @return A constant pointer to an instance of <code>Result</code>.
  66      */
  67     const Here::Maps::Result* GetResult(size_t idx) const;
  68
  69     /**
  70      * This method retrieves the reply meta information.
  71      *
  72      * @return A constant pointer to an instance of <code>MetaInfo</code>.
  73      */
  74     const Here::Maps::MetaInfo* GetMetaInfo() const;
  75
  76 private:
  77     HERE_MAPS_NO_COPY_NO_ASSIGN(MultiReverseReply);
  78     friend class TestGeoCoderParser;
  79
  80     virtual bool OnDataReceived(const unsigned char* pBuffer, size_t uSize);
  81
  82     class MultiReverseReplyImpl;
  83     MultiReverseReplyImpl* m_pImpl;
  84 };
  85
  86 TIZEN_MAPS_END_NAMESPACE
  87
  88 #endif /* MULTIREVERSEREPLY_H_ */