CLbtGeoRect Class Reference

#include <mw/lbtgeorect.h>

Link against: lbt.lib

class CLbtGeoRect : public CLbtGeoAreaBase

Inherits from

CLbtGeoRect
- CLbtGeoAreaBase

Public Member Functions
	~CLbtGeoRect()
IMPORT_C void	GetBorder(TReal &, TReal &, TReal &, TReal &)
IMPORT_C CLbtGeoRect *	NewL()
IMPORT_C CLbtGeoRect *	NewL(TReal, TReal, TReal, TReal)
IMPORT_C CLbtGeoRect *	NewLC()
IMPORT_C CLbtGeoRect *	NewLC(TReal, TReal, TReal, TReal)
IMPORT_C void	SetBorder(TReal, TReal, TReal, TReal)
virtual TGeoAreaType	Type()

Protected Member Functions
virtual void	DoExternalizeL(RWriteStream &)
virtual void	DoInternalizeL(RReadStream &)

Inherited Enumerations
	CLbtGeoAreaBase:TGeoAreaType

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CLbtGeoAreaBase::CLbtGeoAreaBase()
	CLbtGeoAreaBase::ExternalizeL(RWriteStream &)const
	CLbtGeoAreaBase::InternalizeL(RReadStream &)
	CLbtGeoAreaBase::~CLbtGeoAreaBase()

Detailed Description

Geographical rectangular area.

A geographical rectangular area is defined as a spherical rectangle, limited by two longitude borders ( WestLongitude and EastLongitude ) and two latitude borders ( SouthLatitude and NorthLatitude ).

It is required that - 90 =< SouthLatitude =< NorthLatitude =< 90. WestLongitude must be in the interval [- 180, 180 ), i.e. not including + 180. EastLongitude must be in the interval [- 180, 180], i.e. including + 180. It is allowed that EastLongitude < WestLongitude. This defines an area which crosses the 180 meridian.

Constructor & Destructor Documentation

~CLbtGeoRect ( )

IMPORT_C

~CLbtGeoRect

(

)

Destructor

Member Function Documentation

DoExternalizeL ( RWriteStream & )

void

DoExternalizeL

(

RWriteStream &

aStream

)

const [protected, virtual]

Reimplemented from CLbtGeoAreaBase::DoExternalizeL(RWriteStream &)const

Externalize method that subclass must implement.

Parameter	Description
aStream	Stream to which the object should be externalized.

DoInternalizeL ( RReadStream & )

void

DoInternalizeL

(

RReadStream &

aStream

)

[protected, virtual]

Reimplemented from CLbtGeoAreaBase::DoInternalizeL(RReadStream &)

Internalize method that subclass must implement.

Parameter	Description
aStream	Stream from which the object should be internalized.

GetBorder ( TReal &, TReal &, TReal &, TReal & )

IMPORT_C void	GetBorder	(	TReal &	aSouthLatitude,
			TReal &	aNorthLatitude,
			TReal &	aWestLongitude,
			TReal &	aEastLongitude
		)	const

Gets border values. If the border value has not been set before, the returned border values are NaN.

Parameter	Description
aSouthLatitude	The southern latitude border of the area.
aNorthLatitude	The northern latitude border of the area.
aWestLongitude	The western longitude border of the area.
aEastLongitude	The eastern longitude border of the area.

NewL ( )

IMPORT_C CLbtGeoRect *

NewL

(

)

[static]

Allocates and constructs a new geographical rectangular area object. In returned object, the border values are set to NaN.

Returns: Pointer to the new constructed geographical rectangular area object.

NewL ( TReal, TReal, TReal, TReal )

IMPORT_C CLbtGeoRect *	NewL	(	TReal	aSouthLatitude,
			TReal	aNorthLatitude,
			TReal	aWestLongitude,
			TReal	aEastLongitude
		)	[static]

Allocates and constructs a new geographical rectangular area object.

Parameter	Description
aSouthLatitude	The southern latitude border of the area.
aNorthLatitude	The northern latitude border of the area.
aWestLongitude	The western longitude border of the area.
aEastLongitude	The eastern longitude border of the area.

Returns: Pointer to the new constructed geographical rectangular area object.

NewLC ( )

IMPORT_C CLbtGeoRect *

NewLC

(

)

[static]

Allocates and constructs a new geographical rectangular area object and pushes it onto cleanup stack. In returned object, the border values are set to NaN.

Returns: Pointer to the new constructed geographical rectangular area object.

NewLC ( TReal, TReal, TReal, TReal )

IMPORT_C CLbtGeoRect *	NewLC	(	TReal	aSouthLatitude,
			TReal	aNorthLatitude,
			TReal	aWestLongitude,
			TReal	aEastLongitude
		)	[static]

Allocates and constructs a new geographical rectangular area object and pushes it onto cleanup stack.

Parameter	Description
aSouthLatitude	The southern latitude border of the area.
aNorthLatitude	The northern latitude border of the area.
aWestLongitude	The western longitude border of the area.
aEastLongitude	The eastern longitude border of the area.

Returns: Pointer to the new constructed geographical rectangular area object.

SetBorder ( TReal, TReal, TReal, TReal )

IMPORT_C void	SetBorder	(	TReal	aSouthLatitude,
			TReal	aNorthLatitude,
			TReal	aWestLongitude,
			TReal	aEastLongitude
		)

Sets the border values.

The input parameters specify the area as described in the class description.

If one of the parameters is out of range, this function fails with panic with KLbtErrArgument. The correct ranges are:

- 90 =< aSouthLatitude =< aNorthLatitude =< 90
- 180 <= aWestLongitude <= 180
- 180 <= aEastLongitude <= 180

panic: LocTriggering ELbtErrArgument if the input parameters are invalid.

Parameter	Description
aSouthLatitude	The southern latitude border of the area.
aNorthLatitude	The northern latitude border of the area.
aWestLongitude	The western longitude border of the area.
aEastLongitude	The eastern longitude border of the area.

Type ( )

TGeoAreaType

Type

(

)

const [virtual]

Reimplemented from CLbtGeoAreaBase::Type()const

Returns the type of geographical area, CLbtGeoAreaBase::ERectangular.

Returns: CLbtGeoAreaBase::ERectangular.