KItinerary::LocationUtil Namespace Reference

Enumerations
enum	Accuracy { Exact, CityLevel }

Functions
PostalAddress	address (const QVariant &location)
QVariant	arrivalLocation (const QVariant &res)
QVariant	departureLocation (const QVariant &res)
int	distance (const GeoCoordinates &coord1, const GeoCoordinates &coord2)
GeoCoordinates	geo (const QVariant &location)
bool	isLocationChange (const QVariant &res)
bool	isSameLocation (const QVariant &lhs, const QVariant &rhs, Accuracy accuracy=Exact)
QVariant	location (const QVariant &res)
QString	name (const QVariant &location)

Detailed Description

Utility functions related to location information.

Enumeration Type Documentation

enum KItinerary::LocationUtil::Accuracy

Location comparison accuracy.

Enumerator
Exact	Locations match exactly.
CityLevel	Locations are in the same city.

Definition at line 69 of file locationutil.h.

Function Documentation

PostalAddress KItinerary::LocationUtil::address

(

const QVariant &

location

)

Returns the address of the given location.

Definition at line 107 of file locationutil.cpp.

QVariant KItinerary::LocationUtil::arrivalLocation

(

const QVariant &

res

)

Returns the arrival location of the given reservation.

This assumes isLocationChange(res) == true.

Definition at line 40 of file locationutil.cpp.

QVariant KItinerary::LocationUtil::departureLocation

(

const QVariant &

res

)

Returns the departure location of the given reservation.

This assumes isLocationChange(res) == true.

Definition at line 57 of file locationutil.cpp.

int KItinerary::LocationUtil::distance	(	const GeoCoordinates &	coord1,
		const GeoCoordinates &	coord2
	)

Computes the distance between to geo coordinates in meters.

Definition at line 136 of file locationutil.cpp.

GeoCoordinates KItinerary::LocationUtil::geo

(

const QVariant &

location

)

Returns the geo coordinates of a given location.

Definition at line 95 of file locationutil.cpp.

bool KItinerary::LocationUtil::isLocationChange

(

const QVariant &

res

)

Returns true if the given reservation is a location change.

That is, some form of transport reservation with different departure and arrival locations.

Definition at line 34 of file locationutil.cpp.

bool KItinerary::LocationUtil::isSameLocation	(	const QVariant &	lhs,
		const QVariant &	rhs,
		LocationUtil::Accuracy	accuracy = Exact
	)

Returns true if the given locations are the same.

Parameters

lhs	The left hand side in the location condition.
rhs	The right hand side in the location condition.
accuracy	Defines how closely the locations have to match.

Definition at line 148 of file locationutil.cpp.

QVariant KItinerary::LocationUtil::location

(

const QVariant &

res

)

Returns the location of a non-transport reservation.

This assumes isLocationChange(res) == false.

Definition at line 74 of file locationutil.cpp.

QString KItinerary::LocationUtil::name

(

const QVariant &

location

)

Returns a description of the location.

Definition at line 119 of file locationutil.cpp.