namespace Tizen.Location
{
/// <summary>
- /// A class which contains the functionality for obtaining information about Gps satellites in range and in use.
+ /// This class contains the functionality for obtaining information about GPS satellites in the range and in use.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class GpsSatellite
{
private int _interval = 1;
/// <summary>
/// The time interval between callback updates.
- /// Should be in the range [1~120] seconds.
+ /// Should be in the range of 1~120 seconds.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="ArgumentException">Thrown when an an invalid argument is used.</exception>
public int Interval
{
get
}
/// <summary>
- /// The NMEAData from the Satellite.
+ /// The NMEA data from the satellite.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public string Nmea
{
/// <summary>
- /// The Count of Active satellites.
+ /// The count of active satellites.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int ActiveCount
{
}
/// <summary>
- /// The Count of satellites in view.
+ /// The count of satellites in view.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int InViewCount
{
}
/// <summary>
- /// The list of satellites/last recorded satellites in view.
+ /// The list of satellites or last recorded satellites in view.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public IList<SatelliteInformation> Satellites
{
}
/// <summary>
- /// The constructor of GpsSatellite class.
+ /// The constructor of the GpsSatellite class.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="locator"> Locator object initilized using Gps.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="locator">The locator object initilized using GPS.</param>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public GpsSatellite(Locator locator)
{
}
/// <summary>
- /// (event) SatelliteStatusUpdated is raised whenever satellite information is updated.
+ /// The SatelliteStatusUpdated event is raised whenever the satellite information is updated.
/// The callback will be invoked periodically (every Interval seconds).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<SatelliteStatusChangedEventArgs> SatelliteStatusUpdated
{
}
/// <summary>
- /// A class which contains the information of the Satellite under consideration.
+ /// This class contains the information of the satellite under consideration.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class SatelliteInformation
{
/// <summary>
- /// Class Constructor for SatelliteInformation class.
+ /// The Class constructor for the SatelliteInformation class.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
- /// <param name="elevation"> The elevation of the satellite in meters.</param>
- /// <param name="prn"> The Prn value of the satellite.</param>
- /// <param name="snr"> The SNR value of the satellite in dB.</param>
- /// <param name="active"> The flag signaling if satellite is in use.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="azimuth">The azimuth value of the satellite in degrees.</param>
+ /// <param name="elevation">The elevation of the satellite in meters.</param>
+ /// <param name="prn">The PRN value of the satellite.</param>
+ /// <param name="snr">The SNR value of the satellite in dB.</param>
+ /// <param name="active">The flag signaling if the satellite is in use.</param>
public SatelliteInformation(uint azimuth, uint elevation, uint prn, uint snr, bool active)
{
Azimuth = azimuth;
}
/// <summary>
- /// The Azimuth information of the Satellite.
+ /// The azimuth information of the satellite.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
public uint Azimuth { get; private set; }
/// <summary>
- /// The Elevation information of the Satellite.
+ /// The elevation information of the satellite.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
public uint Elevation { get; private set; }
/// <summary>
- /// The PRN of the Satellite.
+ /// The PRN of the satellite.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
public uint Prn { get; private set; }
/// <summary>
- /// The SNR of the Satellite.
+ /// The SNR of the satellite.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public uint Snr { get; private set; }
/// <summary>
- /// The operational status of the Satellite.
+ /// The operational status of the satellite.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public bool Active { get; private set; }
}
}
namespace Tizen.Location
{
/// <summary>
- /// A class which contains the details of the location rrequested.
+ /// This class contains details of the location requested.
/// Includes the functionality to get the distance between locations.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Location
{
private double _latitude;
internal int _timestamp;
/// <summary>
- /// The default constructor of Location Class.
+ /// The default constructor of the Location class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Location()
{
}
/// <summary>
- /// The parameterized constructor of Location Class.
+ /// The parameterized constructor of the Location class.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="latitude"> Latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees).</param>
- /// <param name="longitude"> Longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees).</param>
- /// <param name="altitude"> Altitude value.</param>
- /// <param name="accuracy"> Accuracy in meters.</param>
- /// <param name="speed"> Devie Speed.</param>
- /// <param name="direction"> Device direction with respect to north.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="latitude">The latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees).</param>
+ /// <param name="longitude">The longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees).</param>
+ /// <param name="altitude">The altitude value.</param>
+ /// <param name="accuracy">The accuracy in meters.</param>
+ /// <param name="speed">The device speed.</param>
+ /// <param name="direction">The device direction with respect to the north.</param>
/// <param name="timestamp"> Time when the measurement took place.</param>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public Location(double latitude, double longitude, double altitude, double speed, double direction, double accuracy, int timestamp)
/// <summary>
/// The current latitude [-90.0 ~ 90.0] (degrees).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Latitude
{
get
/// <summary>
/// The current longitude [-180.0 ~ 180.0] (degrees).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Longitude
{
get
/// <summary>
/// The current altitude (meters).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Altitude
{
get
}
/// <summary>
- /// The Device Speed (km/h).
+ /// The device speed (km/h).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Speed
{
get
}
/// <summary>
- /// The direction, degrees from the north.
+ /// The direction and degrees from the north.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Direction
{
get
/// <summary>
/// The accuracy.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Accuracy
{
get
/// <summary>
/// The time value when the measurement was done.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public DateTime Timestamp
{
get
/// <summary>
/// Gets the distance between the two given coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="startLatitude"> The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
- /// <param name="startLongitude"> The Longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
- /// <param name="endLatitude"> The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
- /// <param name="endLongitude"> The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
- /// <returns>Returns the distance between source and destination.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="startLatitude">The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
+ /// <param name="startLongitude">The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
+ /// <param name="endLatitude">The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
+ /// <param name="endLongitude">The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
+ /// <returns>Returns the distance between the source and the destination.</returns>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public static double GetDistanceBetween(double startLatitude, double startLongitude, double endLatitude, double endLongitude)
}
/// <summary>
- /// Gets the distance between the current and specified location.
+ /// Gets the distance between the current and the specified location.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="location"> The location object to which distance is to be calculated.</param>
/// <returns>Returns the distance to the specified location.</returns>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
namespace Tizen.Location
{
/// <summary>
- /// Abstract class which provides functions related to geographic bounds information.
+ /// The LocationBoundary class is an abstract class that provides functions related to the geographic bounds information.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public abstract class LocationBoundary : IDisposable
{
internal IntPtr handle;
/// <summary>
/// Gets the location boundary type.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public BoundaryType BoundaryType{ get; internal set; }
internal LocationBoundary() { }
/// <summary>
- /// The destructor of LocationBoundary class.
+ /// The destructor of the LocationBoundary class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
~LocationBoundary()
{
Log.Info(Globals.LogTag, "The destructor of LocationBoundary class");
/// <summary>
/// Checks if the boundary contains the specified geographical coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="coordinate"> The coordinate which needs to be checked.</param>
/// <returns>Returns a boolean value indicating whether or not the specified coordinate lies in the geographical area.</returns>
public bool BoundaryContainsCoordinates(Coordinate coordinate)
/// <summary>
/// The overidden Dispose method of the IDisposable class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void Dispose()
}
/// <summary>
- /// Class representing a rectangular location boundary.
+ /// This class represents a rectangular location boundary.
/// Inherits the Abstract LocationBoundary class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class RectangleBoundary : LocationBoundary
{
/// <summary>
- /// Constructor of the Rectangle boundary class.
+ /// The constructor of the Rectangle boundary class.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="topLeft"> The coordinate which constitute the top left handside of the rectangular boundary.</param>
- /// <param name="bottomRight"> The coordinate which constitute the bottom right handside of the rectangular boundary.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="topLeft"> The coordinate which constitutes the top-left handside of the rectangular boundary.</param>
+ /// <param name="bottomRight"> The coordinate which constitutes the bottom-right handside of the rectangular boundary.</param>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
}
/// <summary>
- /// Gets the Top Left handside coordinate of a rectangular boundary.
+ /// Gets the top-left handside coordinate of a rectangular boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Coordinate TopLeft
{
get
}
/// <summary>
- /// Gets the Bottom Right handside coordinate of a rectangular boundary.
+ /// Gets the bottom-right handside coordinate of a rectangular boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Coordinate BottomRight
{
get
}
/// <summary>
- /// Class representing a circular location boundary.
+ /// This class represents a circular location boundary.
/// Inherits the Abstract LocationBoundary class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class CircleBoundary : LocationBoundary
{
/// <summary>
- /// Constructor of the Circular boundary class.
+ /// The constructor of the Circular boundary class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="coordinate"> The coordinates which constitute the center of the circular boundary.</param>
/// <param name="radius"> The radius value of the circular boundary.</param>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <summary>
/// Gets the coordinate of the center of a circular boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
/// <summary>
/// Gets the radius of a circular boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
}
/// <summary>
- /// Class representing a polygonal location boundary.
+ /// This class represents a polygonal location boundary.
/// Inherits the Abstract LocationBoundary class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PolygonBoundary : LocationBoundary
{
/// <summary>
- /// Constructor of the polygon boundary class.
+ /// The constructor of the Polygon Boundary class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="coordinates"> The coordinates which constitute the polgonal boundary.</param>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
}
/// <summary>
- /// Gets the list of coordinates which constitute a polygonal boundary
+ /// Gets the list of coordinates which constitute a polygonal boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
}
/// <summary>
- /// The structure which represents the co-ordinates of a geographical location.
+ /// This structure represents the coordinates of a geographical location.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public struct Coordinate
{
/// <summary>
- /// Latitude component of the co-ordinate.
+ /// Latitude component of the coordinate.
/// Should have a value between [-90.0 ~ 90.0] (degrees).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Latitude;
/// <summary>
- /// Longitude component of the co-ordinate.
+ /// Longitude component of the coordinate.
/// Should have a value between [-180.0 ~ 180.0] (degrees).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Longitude;
}
}
/// <summary>
/// An extended EventArgs class which contains the changed location information.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class LocationChangedEventArgs : EventArgs
{
/// <summary>
- /// Class Constructor for LocationUpdatedEventArgs class.
+ /// The class constructor for the LocationUpdatedEventArgs class.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="location"> Object of Location class.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="location"> Object of the Location class.</param>
public LocationChangedEventArgs(Location location)
{
Location = location;
}
/// <summary>
- /// Get the Location Update information.
+ /// Gets the location update information.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Location Location { get; private set; }
}
}
/// <summary>
/// Location Manager error codes.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum LocationError
{
None = ErrorCode.None,/**< Successful */
/// <summary>
/// Location Boundary error codes.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum LocationBoundError
{
None = ErrorCode.None,/**< Successful */
}
/// <summary>
- /// A class which contains the functionality for obtaining geographical infomation and setting boundary condition.
- /// Notifications on events like service becoming enabled or disabled, new position data being available
+ /// This class contains the functionality for obtaining the geographical infomation and setting the boundary condition.
+ /// Notifications on events like service becoming enabled or disabled, new position data being available,
/// and others can also be acquired.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Locator : IDisposable
{
private int _interval = 1;
private EventHandler<LocationChangedEventArgs> _locationChanged;
/// <summary>
- /// The constructor of Locator class.
+ /// The constructor of the Locator class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
/// <feature>http://tizen.org/feature/location</feature>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
}
/// <summary>
- /// The destructor of Locator class.
+ /// The destructor of the Locator class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
~Locator()
{
Dispose(false);
/// <summary>
/// The time interval between callback updates.
- /// Should be in the range [1~120] seconds.
+ /// Should be in the range of 1~120 seconds.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public int Interval
{
}
/// <summary>
- /// The time interval between Distance based location callback updates.
- /// Should be in the range [1~120] seconds.
+ /// The time interval between the distance-based location callback updates.
+ /// Should be in the range of 1~120 seconds.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public int StayInterval
{
}
/// <summary>
- /// The time interval between position collection in batch mode.
- /// Should be in the range [1~255] seconds.
+ /// The time interval between the position collection in batch mode.
+ /// Should be in the range of 1~255 seconds.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public int BatchInterval
{
}
/// <summary>
- /// The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If BatchPeriod is zero or smaller than BatchInterval, then batch mode will not working. In addition, sometimes the period may not work as you intended, the maximum permissible value for batch_period is device specific.
- /// Should be in the range [0~60000] seconds.
+ /// The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If the BatchPeriod is zero or smaller than the BatchInterval, then the batch mode will not work. In addition, sometimes the period may not work as you intended, the maximum permissible value for the batch period is device specific.
+ /// Should be in the range of 0~60000 seconds.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public int BatchPeriod
{
/// <summary>
/// The distance between callback updates.
- /// Should be in the range [1-120] meters.
+ /// Should be in the range of 1-120 meters.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public double Distance
{
}
/// <summary>
- /// Gets the Location object.
+ /// Gets the location object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Location Location
{
get
}
/// <summary>
- /// Gets the type used to obtain Location data.
+ /// Gets the type used to obtain the location data.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public LocationType LocationType
{
get
}
/// <summary>
- /// Gets the status whether mock location is enabled or not.
+ /// Gets the status whether the mock location is enabled or not.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public bool EnableMock
{
/// <summary>
/// Starts the Location Manager which has been created using the specified method.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void Start()
{
/// Stops the Location Manager which has been activated using the specified method.
/// Does not destroy the manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
/// <summary>
/// Sets a mock location for the given location method.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="location"> The location object containing the mock location details.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void SetMockLocation(Location location)
{
/// <summary>
/// Clears a mock location for the given location method.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void ClearMock()
{
/// <summary>
/// Gets the details of the location asynchronously.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="timeout"> Timeout to stop requesting single location after(seconds).</param>
- /// <returns> A task which contains the current location details</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="timeout"> Timeout to stop requesting a single location after (seconds).</param>
+ /// <returns> A task which contains the current location details.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Task<Location> GetLocationAsync(int timeout)
{
/// <summary>
/// Gets the details of the location.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <returns> which contains the current location details.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <returns> Which contains the current location details.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Location GetLocation()
{
/// <summary>
- /// Adds a bounds for a given locator.
+ /// Adds a bound for a given locator.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="locationBoundary"> The boundary object to be added to the locator.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="locationBoundary">The boundary object to be added to the locator.</param>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
}
/// <summary>
- /// Deletes a bounds for a given locator.
+ /// Deletes a bound for a given locator.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="locationBoundary"> The boundary object to be removed from the locator.</param>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <summary>
/// The overidden Dispose method of the IDisposable class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public void Dispose()
{
}
/// <summary>
- /// (event) ServiceStateChanged Event is invoked when the location service state is changed.
+ /// The ServiceStateChanged event is invoked when the location service state is changed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<ServiceStateChangedEventArgs> ServiceStateChanged
}
/// <summary>
- /// (event) ZoneChanged is invoked when the previously set boundary area is entered or left.
+ /// The ZoneChanged event is invoked when the previously set boundary area is entered or left.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<ZoneChangedEventArgs> ZoneChanged
}
/// <summary>
- /// (event) SetttingChanged is raised when the location setting is changed.
+ /// The SetttingChanged event is raised when the location setting is changed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
}
/// <summary>
- /// (event) DistanceBasedLocationChanged is raised with updated location information.
- /// The callback will be invoked at minimum interval or minimum distance with updated position information.
+ /// The DistanceBasedLocationChanged event is raised with the updated location information.
+ /// The callback will be invoked at a minimum interval or minimum distance with the updated position information.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<LocationChangedEventArgs> DistanceBasedLocationChanged
}
/// <summary>
- /// (event)LocationUpdated is raised at defined intervals of time with updated location information.
+ /// The LocationUpdated event is raised at defined intervals of time with the updated location information.
/// The callback will be invoked periodically.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<LocationChangedEventArgs> LocationChanged
/// <summary>
/// Enumeration for the state of the location service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ServiceState
{
Disabled = 0, /**<Service is disabled.*/
}
/// <summary>
- /// Enumeration for the type of connection used in acquiring Location data.
+ /// Enumeration for the type of connection used in acquiring the location data.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum LocationType
{
Hybrid = 0, /**<This method selects the best method available at the moment.*/
/// <summary>
/// Enumeration for the created boundary type.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum BoundaryType
{
Rectangle = 0, /**<Rectangular geographical area type. */
}
/// <summary>
- /// Enumeration for error code for Location manager.
+ /// Enumeration for the error code for location manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum BoundaryState
{
In = 0, /**< Boundary In (Zone In) */
/// <summary>
/// Checks if the specified geographical positioning type is supported or not.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="locationType">The back-end positioning method to be used for LBS.</param>
/// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
public static bool IsSupportedType(LocationType locationType)
{
/// <summary>
/// Checks if the specified geographical positioning type is enabled or not.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="locationType">The back-end positioning method to be used for LBS.</param>
/// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
/**
<summary>
-The Tizen.Location namespace provides classes for obtaining information related to geographical location.
+The Tizen.Location namespace provides classes for obtaining information related to the geographical location.
Notifications on events like service becoming enabled or disabled,
-new position data being available and others can also be acquired.
+new position data being available, and others can also be acquired.
</summary>
<remarks>
<h2>Overview</h2>
-<para>The Tizen.Location namespace provides classes for obtaining information related to geographical location.
+<para>The Tizen.Location namespace provides classes for obtaining information related to the geographical location.
Notifications on events like service becoming enabled or disabled,
-new position data being available and others can also be acquired.</para>
+new position data being available, and others can also be acquired.</para>
<h2>Related Features</h2>
-<para>To guarantee that the Location application runs on a device with location profile feature,
+<para>To guarantee that the location application runs on a device with the location profile feature,
declare the following feature requirements in the config file:<br/>
http://tizen.org/feature/location<br/>
http://tizen.org/feature/location.gps<br/>
public class SatelliteStatusChangedEventArgs : EventArgs
{
/// <summary>
- /// Class Constructor for SatelliteStatusChangedEventArgs class.
+ /// The class constructor for the SatelliteStatusChangedEventArgs class.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="activeCount"> The number of active satellites.</param>
- /// <param name="inviewCount"> The number of satellites in view.</param>
- /// <param name="timestamp"> The time at which the data has been extracted.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="activeCount">The number of active satellites.</param>
+ /// <param name="inviewCount">The number of satellites in view.</param>
+ /// <param name="timestamp">The time at which the data has been extracted.</param>
public SatelliteStatusChangedEventArgs(uint activeCount, uint inviewCount, DateTime timestamp)
{
ActiveCount = activeCount;
/// <summary>
/// Gets the number of active satellites.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public uint ActiveCount { get; private set; }
/// <summary>
/// Gets the number of satellites in view.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public uint InViewCount { get; private set; }
/// <summary>
/// Get the timestamp.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public DateTime Timestamp { get; private set; }
}
}
namespace Tizen.Location
{
/// <summary>
- /// An extended EventArgs class which contains the changed location service state.
+ /// An extended EventArgs class contains the changed location service state.
/// </summary>
public class ServiceStateChangedEventArgs : EventArgs
{
/// <summary>
- /// Class Constructor for ServiceStateChangedEventArgs class.
+ /// The class constructor for the ServiceStateChangedEventArgs class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="state"> An enumeration of type LocationServiceState.</param>
public ServiceStateChangedEventArgs(ServiceState state)
{
}
/// <summary>
- /// Get the Service state.
+ /// Get the service state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ServiceState ServiceState { get; private set; }
}
}
public class SettingChangedEventArgs : EventArgs
{
/// <summary>
- /// Class Constructor for SettingChangedEventArgs class.
+ /// The class constructor for the SettingChangedEventArgs class.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="method"> The positioing method used for Location information.</param>
- /// <param name="enable"> Status of the method.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="method">The positioing method used for the location information.</param>
+ /// <param name="enable">The status of the method.</param>
public SettingChangedEventArgs(LocationType type, bool enable)
{
LocationType = type;
/// <summary>
/// Gets the currently used location method.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public LocationType LocationType { get; private set; }
/// <summary>
/// Method to get the setting value changed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public bool IsEnabled { get; private set; }
}
}
public class ZoneChangedEventArgs : EventArgs
{
/// <summary>
- /// Class Constructor for ZoneChangedEventArgs class.
+ /// The class constructor for the ZoneChangedEventArgs class.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="state"> An enumeration of type BoundaryState.</param>
- /// <param name="latitude"> The latitude value[-90.0 ~ 90.0] (degrees).</param>
- /// <param name="longitude"> The longitude value[-180.0 ~ 180.0] (degrees).</param>
+ /// <param name="latitude">The latitude value [-90.0 ~ 90.0] (degrees).</param>
+ /// <param name="longitude">The longitude value [-180.0 ~ 180.0] (degrees).</param>
/// <param name="altitude"> The altitude value.</param>
/// <param name="timestamp"> The timestamp value.</param>
public ZoneChangedEventArgs(BoundaryState state, double latitude, double longitude, double altitude, DateTime timestamp)
}
/// <summary>
- /// Get the Boundary State.
+ /// Gets the boundary state.
/// </summary>
/// <since_tizen>3</since_tizen>
public BoundaryState BoundState { get; private set; }
/// <summary>
- /// Get the latitude.
+ /// Gets the latitude.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Latitude { get; private set; }
/// <summary>
- /// Get the longitude.
+ /// Gets the longitude.
/// </summary>
/// <since_tizen>3</since_tizen>
public double Longitude { get; private set; }
/// <summary>
- /// Get the altitude.
+ /// Gets the altitude.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Altitude { get; private set; }
/// <summary>
/// Method to get the timestamp.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public DateTime Timestamp { get; private set; }
}
}
projects / platform / core / csapi / tizenfx.git / commitdiff