Modify documentation of APIs
[platform/core/csapi/tizenfx.git] / src / Tizen.Maps / Tizen.Maps / RouteManeuver.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     /// Route Maneuver information, used in Route Search requests
23     /// </summary>
24     public class RouteManeuver
25     {
26         private Interop.RouteDirection _direction;
27         private Interop.RouteTurnType _turntype;
28         private Geocoordinates _coordinates;
29         private string _road;
30         private string _instruction;
31         private string _locale;
32         private int _timeToNextInstruction;
33         private double _distanceToNextInstruction;
34
35         internal RouteManeuver(Interop.RouteManeuverHandle handle)
36         {
37             _direction = handle.Direction;
38             _turntype = handle.TurnType;
39             _coordinates = new Geocoordinates(handle.Coordinates);
40             _road = handle.RoadName;
41             _instruction = handle.Instruction;
42             _locale = handle.Locale;
43             _timeToNextInstruction = handle.TimeToNextInstruction;
44             _distanceToNextInstruction = handle.DistanceToNextInstruction;
45         }
46
47         /// <summary>
48         /// Gets direction type for this maneuver.
49         /// </summary>
50         public DirectionType Direction { get { return (DirectionType)_direction; } }
51
52         /// <summary>
53         /// Gets turn type for this maneuver.
54         /// </summary>
55         public TurnInstruction Turn { get { return (TurnInstruction)_turntype; } }
56
57         /// <summary>
58         /// Gets a geographical coordinates position for this maneuver.
59         /// </summary>
60         public Geocoordinates Position { get { return _coordinates; } }
61
62         /// <summary>
63         /// Gets a name of the road for this maneuver.
64         /// </summary>
65         public string Road { get { return _road; } }
66
67         /// <summary>
68         /// Gets an instruction text for this maneuver.
69         /// </summary>
70         public string Instruction { get { return _instruction; } }
71
72         /// <summary>
73         /// Gets a locale for this maneuver.
74         /// </summary>
75         public string Locale { get { return _locale; } }
76
77         /// <summary>
78         /// Gets time to next instruction for this maneuver.
79         /// </summary>
80         public int TimeToNextInstruction { get { return _timeToNextInstruction; } }
81
82         /// <summary>
83         /// Gets distance to next instruction for this maneuver.
84         /// </summary>
85         public double DistanceToNextInstruction { get { return _distanceToNextInstruction; } }
86     }
87 }