TLocality Class Reference

#include <lbsposition.h>

Link against: lbs.lib

class TLocality : public TCoordinate

Inherits from

TLocality
- TCoordinate

Protected Attributes
TReal32	iHorizontalAccuracy
TReal32	iVerticalAccuracy

Public Member Functions
	TLocality()
	TLocality(const TCoordinate &, TReal32)
	TLocality(const TCoordinate &, TReal32, TReal32)
IMPORT_C TInt	BearingTo(const TCoordinate &, TReal32 &)
IMPORT_C TInt	BearingTo(const TLocality &, TReal32 &, TReal32 &)
IMPORT_C TInt	Distance(const TCoordinate &, TReal32 &)
IMPORT_C TInt	Distance(const TLocality &, TReal32 &, TReal32 &)
IMPORT_C TReal32	HorizontalAccuracy()
IMPORT_C void	SetAccuracy(TReal32, TReal32)
IMPORT_C void	SetHorizontalAccuracy(TReal32)
IMPORT_C void	SetVerticalAccuracy(TReal32)
IMPORT_C TReal32	VerticalAccuracy()

Inherited Attributes
	TCoordinate::iAltitude
	TCoordinate::iDatum
	TCoordinate::iLatitude
	TCoordinate::iLongitude

Inherited Functions
	TCoordinate::Altitude()const
	TCoordinate::Datum()const
	TCoordinate::Latitude()const
	TCoordinate::Longitude()const
	TCoordinate::Move(TReal32,TReal32)
	TCoordinate::SetCoordinate(const TReal64 &,const TReal64 &)
	TCoordinate::SetCoordinate(const TReal64 &,const TReal64 &,TReal32)
	TCoordinate::SetDatum(TPositionDatumId)
	TCoordinate::TCoordinate()
	TCoordinate::TCoordinate(const TReal64 &,const TReal64 &)
	TCoordinate::TCoordinate(const TReal64 &,const TReal64 &,TReal32)

Detailed Description

Adds an error estimate for the horizontal and vertical accuracy of the point to TCoordinate. Accuracy information is held in a TReal32 and is measure in metres. The class also provides its own methods for determining the distance and bearing to a target point. These methods also provide an error estimate.

Member Attribute Documentation

iHorizontalAccuracy

TReal32

iHorizontalAccuracy

[protected]

Horizontal (earths-surface) accuracy, in metres.

iVerticalAccuracy

TReal32

iVerticalAccuracy

[protected]

Altitudinal accuracy, in metres.

Constructor & Destructor Documentation

TLocality ( )

IMPORT_C

TLocality

(

)

Default constructor for TLocality. Sets the member data to default values (NaN).

TLocality ( const TCoordinate &, TReal32 )

IMPORT_C	TLocality	(	const TCoordinate &	aCoordinate,
			TReal32	aHorizontalAccuracy
		)

Constructor for TLocality. Allows the client to set a coordinate and a 'surface' accuracy.

Parameters
aCoordinate	specifies an initial value for the coordinate.
aHorizontalAccuracy	specifies an initial value for the horizontal accuracy.

Panic Codes
aHorizontalAccuracy	is negative and not set to NaN.

TLocality ( const TCoordinate &, TReal32, TReal32 )

IMPORT_C	TLocality	(	const TCoordinate &	aCoordinate,
			TReal32	aHorizontalAccuracy,
			TReal32	aVerticalAccuracy
		)

Constructor for TLocality. Allows the client to set a coordinate and both a horizontal and vertical accuracy.

Parameters
aCoordinate	specifies an initial value for the coordinate.
aHorizontalAccuracy	specifies an initial value for the horizontal (earth-surface) accuracy.
aVerticalAccuracy	specifies an initial value for the vertical (altitudinal) accuracy.

Panic Codes
aHorizontalAccuracy	or aVerticalAccuracy are negative and not set to NaN.

Member Function Documentation

BearingTo ( const TCoordinate &, TReal32 & )

IMPORT_C TInt	BearingTo	(	const TCoordinate &	aTargetCoordinate,
			TReal32 &	aBearing
		)	const

Reimplemented from TCoordinate::BearingTo(const TCoordinate &,TReal32 &)const

This method calculates the bearing from this coordinate to the supplied coordinate.

Parameters
aTargetCoordinate	is the supplied target coordinate.
aBearing	upon successful completion, this is set to the bearing from this coordinate to aTargetCoordinate, in degrees counting clockwise relative to true north.

Return Value: a Symbian OS error code. KErrArgument if any of iLatitude, iLongitude, aTargetCoordinate.iLatitude or aTargetCoordinate.iLongitude are set to NaN. KErrPositionIncalculable if this coordinate is at a pole or if the two coordinates are the same or antipodal.

BearingTo ( const TLocality &, TReal32 &, TReal32 & )

IMPORT_C TInt	BearingTo	(	const TLocality &	aTargetLocality,
			TReal32 &	aBearing,
			TReal32 &	aDelta
		)	const

This method calculates the bearing from this locality to the supplied locality.

Parameters
aTargetLocality	is the supplied target locality.
aBearing	upon successful completion, this is set to the bearing from this locality to aTargetLocality, in degrees counting clockwise relative to true north.
aDelta	upon successful completion, this is set to an estimate of the accuracy of the calculation, in degrees relative to aBearing.

Return Value: a Symbian OS error code. KErrArgument if any of iLatitude, iLongitude, aTargetLocality.iLatitude or aTargetLocality.iLongitude are set to NaN. KErrArgument if any of iHorizontalAccuracy or aTargetLocality.iHorizontalAccuracy are set to NaN. KErrPositionIncalculable if the error circle (horizontal accuracy) of this locality includes a pole. KErrPositionIncalculable if the two localities has overlapping error circles. KErrPositionIncalculable if the error circle of this locality overlaps with the error circle of aTargetLocality when projected antipodal.

Distance ( const TCoordinate &, TReal32 & )

IMPORT_C TInt	Distance	(	const TCoordinate &	aCoordinate,
			TReal32 &	aDistance
		)	const

Reimplemented from TCoordinate::Distance(const TCoordinate &,TReal32 &)const

This method calculates the distance between this coordinate and the supplied coordinate.

Parameters
aCoordinate	is another point to use in the calculation.
aDistance	upon successful completion, this is set to the distance between this coordinate and aCoordinate, in metres.

Return Value: a Symbian OS error code. KErrArgument if any of iLatitude, iLongitude, aCoordinate.iLatitude or aCoordinate.iLongitude are set to NaN.

Distance ( const TLocality &, TReal32 &, TReal32 & )

IMPORT_C TInt	Distance	(	const TLocality &	aLocality,
			TReal32 &	aDistance,
			TReal32 &	aDelta
		)	const

This method calculates the distance between this locality and the supplied locality. An estimate of the accuracy of the result is also provided.

Parameters
aLocality	is another point to use in the calculation.
aDistance	upon successful completion, this is set to the distance between this locality and aLocality, in metres.
aDelta	upon successful completion, this is set to the estimated accuracy of the distance calculation, in metres.

Return Value: a Symbian OS error code. KErrArgument if any of iLatitude, iLongitude, aLocality.iLatitude or aLocality.iLongitude are set to NaN. KErrArgument if any of iHorizontalAccuracy or aLocality.iHorizontalAccuracy are set to NaN.

HorizontalAccuracy ( )

IMPORT_C TReal32

HorizontalAccuracy

(

)

const

Retrieves the horizontal accuracy of this coordinate.

Return Value: the horizontal accuracy, in metres.

SetAccuracy ( TReal32, TReal32 )

IMPORT_C void	SetAccuracy	(	TReal32	aHorizontalAccuracy,
			TReal32	aVerticalAccuracy
		)

Sets both the horizontal and vertical accuracy of this coordinate.

Parameters
aHorizontalAccuracy	is the new horizontal accuracy, in metres.
aVerticalAccuracy	is the new vertical accuracy, in metres.

Panic Codes
aHorizontalAccuracy	or aVerticalAccuracy are negative and not set to NaN.

SetHorizontalAccuracy ( TReal32 )

IMPORT_C void

SetHorizontalAccuracy

(

TReal32

aHorizontalAccuracy

)

Sets the horizontal accuracy of this coordinate.

Parameters
aHorizontalAccuracy	is the new horizontal accuracy, in metres.

Panic Codes
aHorizontalAccuracy	is negative and not set to NaN.

SetVerticalAccuracy ( TReal32 )

IMPORT_C void

SetVerticalAccuracy

(

TReal32

aVerticalAccuracy

)

Sets the vertical accuracy of this coordinate.

Parameters
aVerticalAccuracy	is the new vertical accuracy, in metres.

Panic Codes
aVerticalAccuracy	is negative and not set to NaN.

VerticalAccuracy ( )

IMPORT_C TReal32

VerticalAccuracy

(

)

const

Retrieves the vertical accuracy of this coordinate.

Return Value: the vertical accuracy, in metres.