Symbian^3 Application Developer Library >

CLbtGeoCircle Class Reference

class CLbtGeoCircle : public CLbtGeoAreaBase

Geographical circular area.

A geographical circular area is defined by the center of the circle and the radius. The radius is in meters. The altitude in the center's coordinate is always ignored. It is optionally also possible to provide additional geographical area information of CLbtGeoCell type. Providing additional cell information would enable further optimization by reducing the number of GPS fixes required to supervise the trigger, there by, reducing the impact on battery consumption. Triggers would, initially, be monitored using the cell information provided. GPS would be used to check the coordinates only when the mobile terminal reaches the cell / cells specified. If a particular location is served by multiple cells, then it is important to mention all available cell information. If not, there is a possibility of missing triggers even when the mobile terminal reaches the location specified by the coordinates.

lbt.lib

Since
S60 5.1

Inherits from

Public Member Functions
~CLbtGeoCircle ()
TCoordinate Center ()
IMPORT_C RPointerArray < CLbtGeoAreaBase > & GetAdditionalGeoAreaInfo ()
IMPORT_C CLbtGeoCircle * NewL ()
IMPORT_C CLbtGeoCircle * NewL (const TCoordinate &, TReal )
IMPORT_C CLbtGeoCircle * NewLC ()
IMPORT_C CLbtGeoCircle * NewLC (const TCoordinate &, TReal )
IMPORT_C TReal Radius ()
IMPORT_C void SetAdditionalGeoAreaInfo ( CLbtGeoAreaBase *)
IMPORT_C void SetCenter (const TCoordinate &)
IMPORT_C void SetRadius ( TReal )
TGeoAreaType Type ()
void ValidateCircleInformationL ()
Protected Member Functions
void DoExternalizeL ( RWriteStream &)
void DoInternalizeL ( RReadStream &)
Private Member Functions
CLbtGeoCircle ()
CLbtGeoCircle (const CLbtGeoCircle &)
void ConstructL ()
void ConstructL ( TCoordinate , TReal )
CLbtGeoCircle & operator= (const CLbtGeoCircle &)
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
RPointerArray < CLbtGeoAreaBase > iAdditionalGeoAreaInfo
TCoordinate iCenter
TReal iRadius

Constructor & Destructor Documentation

CLbtGeoCircle()

CLbtGeoCircle ( ) [private]

Default constructor

CLbtGeoCircle(const CLbtGeoCircle &)

CLbtGeoCircle ( const CLbtGeoCircle & ) [private]

By default, prohibit copy constructor

Parameters

const CLbtGeoCircle &

~CLbtGeoCircle()

IMPORT_C ~CLbtGeoCircle ( )

Destructor.

Member Functions Documentation

Center()

TCoordinate Center ( ) const [virtual]

Gets the center of the area. If the center has not been set before, the returned coordinate has latitude, longitude and altitude set to NaN,

ConstructL()

void ConstructL ( ) [private]

Symbian 2nd phase constructor

ConstructL(TCoordinate, TReal)

void ConstructL ( TCoordinate aCenter,
TReal aRadius
) [private]

Symbian 2nd phase constructor

Parameters

TCoordinate aCenter
TReal aRadius

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.

GetAdditionalGeoAreaInfo()

IMPORT_C RPointerArray < CLbtGeoAreaBase > & GetAdditionalGeoAreaInfo ( )

Gets geographical area information. The following method is currently not supported. This method will only return empty array when invoked.

NewL()

IMPORT_C CLbtGeoCircle * NewL ( ) [static]

Allocates and constructs a new geographical circular area object. In the returned object, the latitude, longitude and altitude are set to NaN, and the radius is set to NaN.

NewL(const TCoordinate &, TReal)

IMPORT_C CLbtGeoCircle * NewL ( const TCoordinate & aCenter,
TReal aRadiusInMeters
) [static]

Allocates and constructs a new geographical circular area object with specified center coordinate and radius.

panic
ELbtErrArgument If the input radius is negative.

Parameters

const TCoordinate & aCenter The coordinate of the center.
TReal aRadiusInMeters The radius of the circle in meters.

NewLC()

IMPORT_C CLbtGeoCircle * NewLC ( ) [static]

Constructs a new geographical circular area object and pushes it onto cleanup stack. In the returned object, the latitude, longitude and altitude are set to NaN, and the radius is set to NaN.

NewLC(const TCoordinate &, TReal)

IMPORT_C CLbtGeoCircle * NewLC ( const TCoordinate & aCenter,
TReal aRadiusInMeters
) [static]

Allocates and constructs a new geographical circular area object with specified center coordinate and radius. The constructed object is pushed onto cleanup stack.

panic
ELbtErrArgument If the input radius is negative.

Parameters

const TCoordinate & aCenter The coordinate of the center.
TReal aRadiusInMeters The radius of the circle in meters.

Radius()

IMPORT_C TReal Radius ( ) const

Gets the radius of the circle. If the radius has not been set before, the returned value is NaN.

SetAdditionalGeoAreaInfo(CLbtGeoAreaBase *)

IMPORT_C void SetAdditionalGeoAreaInfo ( CLbtGeoAreaBase * aGeoArea )

Sets additional geographical area information. The geographical information provided can only be of CLbtGeoCell type. This is optional and clients may specify this information when available.The following method is currently not supported.

panic
ELbtErrArgument if argument passed is NULL or if the argument passed is of any other type other than CLbtGeoCell .

Parameters

CLbtGeoAreaBase * aGeoArea A pointer representing a geographical area.

SetCenter(const TCoordinate &)

IMPORT_C void SetCenter ( const TCoordinate & aCenter )

Sets the center of the circle.

Parameters

const TCoordinate & aCenter The coordinate of the center.

SetRadius(TReal)

IMPORT_C void SetRadius ( TReal aRadiusInMeters )

Sets the radius of the circle.

panic
ELbtErrArgument If the input radius is negative.

Parameters

TReal aRadiusInMeters The radius of the circle in meters.

Type()

TGeoAreaType Type ( ) const [virtual]

Returns the type of geographical area, CLbtGeoAreaBase::ECircle

ValidateCircleInformationL()

void ValidateCircleInformationL ( )

Validates cell information.

leave
KErrArgument if any of the mandatory parameters have not been specified.

operator=(const CLbtGeoCircle &)

CLbtGeoCircle & operator= ( const CLbtGeoCircle & ) [private]

Prohibit assigment operator

Parameters

const CLbtGeoCircle &

Member Data Documentation

RPointerArray< CLbtGeoAreaBase > iAdditionalGeoAreaInfo

RPointerArray < CLbtGeoAreaBase > iAdditionalGeoAreaInfo [private]

An array of instances representing additional geographical area information

TCoordinate iCenter

TCoordinate iCenter [private]

The center of the circle.

TReal iRadius

TReal iRadius [private]

Radius of the circle in meters.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.