inc/engine/finder/PlaceDetailsReply.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 PLACE_DETAILS_REPLY_H_
  19 #define PLACE_DETAILS_REPLY_H_
  20
  21 #include "common/HereMaps_global.h"
  22 #include "finder/BaseFinderReply.h"
  23
  24 HERE_MAPS_BEGIN_NAMESPACE
  25
  26 class PlaceDetails;
  27
  28 /**
  29  * This class encapsulates a response to a request for place details
  30  * (<code>PlaceDetailsQuery</code>).
  31  *
  32  * \ingroup finder
  33  */
  34 class EXPORT_API PlaceDetailsReply : public BaseFinderReply
  35 {
  36 public:
  37
  38     /**
  39      * This is the default constructor.
  40      */
  41     PlaceDetailsReply();
  42
  43     /**
  44      * This is the destructor.
  45      */
  46     ~PlaceDetailsReply();
  47
  48     /**
  49      * This method retrieves the details of the place that have been returned by
  50      * the server.
  51      *
  52      * @return An object containing the place details.
  53      */
  54     PlaceDetails GetPlaceDetails() const;
  55
  56 private:
  57     void SetPlaceDetails(const PlaceDetails& rPlace);
  58     bool OnDataReceived(const unsigned char* pBuffer, size_t uSize);
  59
  60 private:
  61     HERE_MAPS_NO_COPY_NO_ASSIGN(PlaceDetailsReply);
  62     friend class TestPlaceDetailsReply;
  63
  64     class PlaceDetailsReplyImpl;
  65     PlaceDetailsReplyImpl* m_pImpl;
  66 };
  67
  68 HERE_MAPS_END_NAMESPACE
  69
  70 #endif // PLACE_DETAILS_REPLY_H_