Modify documentation of APIs
[platform/core/csapi/tizenfx.git] / 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     public class PlaceRating
25     {
26         private int _count;
27         private double _average;
28
29         internal PlaceRating(Interop.PlaceRatingHandle handle)
30         {
31             _count = handle.Count;
32             _average = handle.Average;
33         }
34
35         /// <summary>
36         /// Gets the number of users rated for this place rating.
37         /// </summary>
38         public int UserCount { get { return _count; } }
39
40         /// <summary>
41         /// Gets average value of this place rating.
42         /// </summary>
43         public double Average { get { return _average; } }
44
45         /// <summary>
46         /// Returns a string that represents this object.
47         /// </summary>
48         public override string ToString()
49         {
50             return $"{Average}({UserCount} reviews)";
51         }
52     }
53 }