src/Tizen.Maps/Tizen.Maps/PlaceRating.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18
  19 namespace Tizen.Maps
  20 {
  21     /// <summary>
  22     /// Place Rating information, used in Place Discovery and Search requests
  23     /// </summary>
  24     /// <since_tizen>3</since_tizen>
  25     public class PlaceRating
  26     {
  27         private int _count;
  28         private double _average;
  29
  30         internal PlaceRating(Interop.PlaceRatingHandle handle)
  31         {
  32             _count = handle.Count;
  33             _average = handle.Average;
  34         }
  35
  36         /// <summary>
  37         /// Gets the number of users rated for this place rating.
  38         /// </summary>
  39         /// <since_tizen>3</since_tizen>
  40         public int UserCount { get { return _count; } }
  41
  42         /// <summary>
  43         /// Gets average value of this place rating.
  44         /// </summary>
  45         /// <since_tizen>3</since_tizen>
  46         public double Average { get { return _average; } }
  47
  48         /// <summary>
  49         /// Returns a string that represents this object.
  50         /// </summary>
  51         /// <since_tizen>3</since_tizen>
  52         /// <returns>Returns a string which presents this object.</returns>
  53         public override string ToString()
  54         {
  55             return $"{Average}({UserCount} reviews)";
  56         }
  57     }
  58 }