inc/engine/finder/Ratings.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 RATINGS_H_
  19 #define RATINGS_H_
  20
  21 #include "common/HereMaps_global.h"
  22
  23 HERE_MAPS_BEGIN_NAMESPACE
  24
  25 /**
  26  * This class encapsulates place ratings contributed by users.
  27  *
  28  * \ingroup finder
  29  */
  30 class EXPORT_API Ratings
  31 {
  32 public:
  33
  34     /**
  35      * This method is the default constructor.
  36      */
  37     Ratings();
  38
  39     /**
  40      * This method is the copy constructor.
  41      *
  42      * @param rRhs An object whose contents are to be copied to the instance
  43      *        being created.
  44      */
  45     Ratings(const Ratings& rRhs);
  46
  47     /**
  48      * This method is the destructor.
  49      */
  50     ~Ratings();
  51
  52     /**
  53      * This is the assignment operator.
  54      *
  55      * @param rRhs An object whose contents are to be copied to the given
  56      *        instance.
  57      *
  58      * @return A reference to the given instance of the class after its contents
  59      *       have been updated.
  60      */
  61     Ratings& operator=(const Ratings& rRhs);
  62
  63     /**
  64      * This method retrieves the average rating for a place.
  65      *
  66      * @return A value reflecting the average user rating for a place.
  67      */
  68     double GetAverage() const;
  69
  70     /**
  71      * This method retrieves a value indicating how many users have rated a place.
  72      *
  73      * @return A value indicating how many users have rated a place.
  74      */
  75     size_t GetCount() const;
  76
  77     /**
  78      * This method sets the average rating for a place.
  79      *
  80      * @param aAverage A value reflecting the average user rating for a place.
  81      */
  82     void SetAverage(double aAverage);
  83
  84     /**
  85      * This method sets a value indicating how many users have rated a place.
  86      *
  87      * @param aCount A value indicating how many users have rated a place.
  88      */
  89     void SetCount(size_t aCount);
  90
  91 private:
  92     class RatingsImpl;
  93     RatingsImpl* m_pImpl;
  94
  95     friend class JsonParser;
  96 };
  97
  98 HERE_MAPS_END_NAMESPACE
  99
 100 #endif // RATINGS_H_