Functions
int	maps_coordinates_create (const double latitude, const double longitude, maps_coordinates_h *coordinates)
	Creates a new instance of Geographical Coordinates and initiates a handle with it.
int	maps_coordinates_destroy (maps_coordinates_h coordinates)
	Destroys the Geographical Coordinates and releases all its resources.
int	maps_coordinates_clone (const maps_coordinates_h origin, maps_coordinates_h *cloned)
	Clones the Geographical Coordinates.
int	maps_coordinates_get_latitude (const maps_coordinates_h coordinates, double *latitude)
	Gets the latitude of the coordinates.
int	maps_coordinates_get_longitude (const maps_coordinates_h coordinates, double *longitude)
	Gets the longitude of the coordinates.
int	maps_coordinates_set_latitude (maps_coordinates_h coordinates, const double latitude)
	Sets the latitude of the coordinates.
int	maps_coordinates_set_longitude (maps_coordinates_h coordinates, const double longitude)
	Sets the longitude of the coordinates.
Typedefs
typedef void *	maps_coordinates_h
	Handle of the Geographical Coordinates.
typedef struct _maps_coordinates_s	maps_coordinates_s
	Structure of the Geographical Coordinates.

This provides APIs related to Geographical Coordinates.

Typedef Documentation

typedef void* maps_coordinates_h

Handle of the Geographical Coordinates.

The Geographical Coordinates handle can be obtained via call of maps_coordinates_create().

Since :: 2.4

Remarks:: To release the handle use maps_coordinates_destroy().
To clone the handle use maps_coordinates_clone().

See also:: maps_coordinates_create(); maps_coordinates_destroy(); maps_coordinates_clone()

typedef struct _maps_coordinates_s maps_coordinates_s

Structure of the Geographical Coordinates.

This structure represents a Geographical Coordinates, specified with a latitude and longitude values.
The latitude must be in range of [-90.0, 90.0].
The longitude must be in range of [-180.0, 180.0].

Since :: 2.4

Remarks:: maps_coordinates_h is a void pointer to the maps_coordinates_s.

See also:: maps_coordinates_h; maps_coordinates_create; maps_coordinates_clone; maps_coordinates_destroy

Function Documentation

int maps_coordinates_clone	(	const maps_coordinates_h	origin,
		maps_coordinates_h *	cloned
	)

Clones the Geographical Coordinates.

This function makes a clone of the origin Geographical Coordinates of type maps_coordinates_s.

Since :: 2.4

Remarks:: cloned must be released using maps_coordinates_destroy().

Parameters:

[in]	origin	The original coordinate handle
[out]	cloned	A cloned coordinate handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:: origin is created using maps_coordinates_create().

See also:: maps_coordinates_create(); maps_coordinates_destroy(); maps_coordinates_s

int maps_coordinates_create	(	const double	latitude,
		const double	longitude,
		maps_coordinates_h *	coordinates
	)

Creates a new instance of Geographical Coordinates and initiates a handle with it.

This function creates coordinates, a new instance of Geographical Coordinates of type maps_coordinates_s with a specified latitude and longitude.
New handle is assigned with this instance.

Since :: 2.4

Remarks:: coordinates must be released using maps_coordinates_destroy().
coordinates may be cloned using maps_coordinates_clone().

Parameters:

[in]	latitude	Latitude
[in]	longitude	Longitude
[out]	coordinates	The coordinate handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter

See also:: maps_coordinates_clone(); maps_coordinates_destroy(); maps_coordinates_s

int maps_coordinates_destroy ( maps_coordinates_h coordinates )

Destroys the Geographical Coordinates and releases all its resources.

This function destroys the Geographical Coordinates maps_coordinates_s and releases all its resources.

Since :: 2.4

Parameters:

[in] coordinates The coordinate handle to destroy

Returns:: 0 on coordinates, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:: coordinates are created using maps_coordinates_create_rectangle().

See also:: maps_coordinates_create(); maps_coordinates_clone()

int maps_coordinates_get_latitude	(	const maps_coordinates_h	coordinates,
		double *	latitude
	)

Gets the latitude of the coordinates.

This function gets the latitude value of the coordinates handle.

Since :: 2.4

Parameters:

[in]	coordinates	The coordinate handle
[out]	latitude	The latitude of the coordinate handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:: coordinates are created using maps_coordinates_create().

See also:: maps_coordinates_create(); maps_coordinates_set_latitude()

int maps_coordinates_get_longitude	(	const maps_coordinates_h	coordinates,
		double *	longitude
	)

Gets the longitude of the coordinates.

This function gets the longitude value of the coordinates handle.

Since :: 2.4

Parameters:

[in]	coordinates	The coordinate handle
[out]	longitude	The longitude of the coordinate handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:: coordinates are created using maps_coordinates_create().

See also:: maps_coordinates_create(); maps_coordinates_set_longitude()

int maps_coordinates_set_latitude	(	maps_coordinates_h	coordinates,
		const double	latitude
	)

Sets the latitude of the coordinates.

This function sets the latitude value of the coordinates handle.

Since :: 2.4

Parameters:

[in]	coordinates	The coordinate handle
[in]	latitude	The latitude of the coordinate handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:: coordinates are created using maps_coordinates_create().

See also:: maps_coordinates_create(); maps_coordinates_get_latitude()

int maps_coordinates_set_longitude	(	maps_coordinates_h	coordinates,
		const double	longitude
	)

Sets the longitude of the coordinates.

This function sets the longitude value of the coordinates handle.

Since :: 2.4

Parameters:

[in]	coordinates	The coordinate handle
[out]	longitude	The longitude of the coordinate handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:: coordinates are created using maps_coordinates_create().

See also:: maps_coordinates_create(); maps_coordinates_get_longitude()

Functions

Typedefs

Typedef Documentation

Function Documentation