Collapse all Symbian^3 Product Developer Library

CLbtGeoRect Class Reference

class CLbtGeoRect : public CLbtGeoAreaBase

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.

Inherits from

CLbtGeoRect
- CLbtGeoAreaBase
  - CBase

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)
TGeoAreaType	Type()

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

Private Member Functions
	CLbtGeoRect()
	CLbtGeoRect(const CLbtGeoRect &)
void	ConstructL()
void	ConstructL(TReal, TReal, TReal, TReal)
CLbtGeoRect &	operator=(const CLbtGeoRect &)

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()

Inherited Enumerations
	CLbtGeoAreaBase:TGeoAreaType

Private Attributes
TReal	iEastLongitude
TReal	iNorthLatitude
TReal	iSouthLatitude
TReal	iWestLongitude

Constructor & Destructor Documentation

CLbtGeoRect()

CLbtGeoRect

(

)

[private]

Constructor.

CLbtGeoRect(const CLbtGeoRect &)

CLbtGeoRect

(

const CLbtGeoRect &

)

[private]

By default, prohibit copy constructor

Parameters

const CLbtGeoRect &

~CLbtGeoRect()

IMPORT_C

~CLbtGeoRect

(

)

Destructor

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

Symbian 2nd phase constructor

ConstructL(TReal, TReal, TReal, TReal)

void	ConstructL	(	TReal	aSouthLatitude,
			TReal	aNorthLatitude,
			TReal	aWestLongitude,
			TReal	aEastLongitude
		)	[private]

Symbian 2nd phase constructor

Parameters

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

DoExternalizeL(RWriteStream &)

void

DoExternalizeL

(

RWriteStream &

aStream

)

const [protected, virtual]

Externalize method that subclass must implement.

Parameters

RWriteStream & aStream

Stream to which the object should be externalized.

DoInternalizeL(RReadStream &)

void

DoInternalizeL

(

RReadStream &

aStream

)

[protected, virtual]

Internalize method that subclass must implement.

Parameters

RReadStream & 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.

Parameters

TReal & aSouthLatitude	The southern latitude border of the area.
TReal & aNorthLatitude	The northern latitude border of the area.
TReal & aWestLongitude	The western longitude border of the area.
TReal & 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.

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.

Parameters

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

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.

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.

Parameters

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

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.

Parameters

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

Type()

TGeoAreaType

Type

(

)

const [virtual]

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

operator=(const CLbtGeoRect &)

CLbtGeoRect &

operator=

(

const CLbtGeoRect &

)

[private]

Prohibit assigment operator

Parameters

const CLbtGeoRect &

Member Data Documentation

TReal iEastLongitude

TReal

iEastLongitude

[private]

The eastern longitude border of the area.

TReal iNorthLatitude

TReal

iNorthLatitude

[private]

The northern latitude border of the area.

TReal iSouthLatitude

TReal

iSouthLatitude

[private]

The southern latitude border of the area.

TReal iWestLongitude

TReal

iWestLongitude

[private]

The western longitude border of the area.