Collapse all Symbian^3 Product Developer Library

CLbtTriggerFilterByArea Class Reference

class CLbtTriggerFilterByArea : public CLbtTriggerFilterBase

Class representing filter based on the geographical area.

This class defines the geographical area filter used in retrieving triggers from Location Triggering Server. When this filter is used, only triggers that are inside the defined area will be retrieved. The area can be a geographical circle or rectangle.

If the area is not set and the filter is used in listing triggers, no trigger will be returned.

If the center of the geographical circular area is not specified(NaN), latest acquired location of the Location Triggering Server is used as the center. If the radius of the geographical circular area is zero, no triggers will be retrieved.

lbt.lib

Since: S60 5.1

Inherits from

CLbtTriggerFilterByArea
- CLbtTriggerFilterBase
  - CBase

Public Member Functions
	~CLbtTriggerFilterByArea()
IMPORT_C CLbtGeoAreaBase *	Area()
IMPORT_C CLbtTriggerFilterByArea *	NewL(CLbtGeoAreaBase *)
IMPORT_C CLbtTriggerFilterByArea *	NewL()
IMPORT_C CLbtTriggerFilterByArea *	NewLC()
IMPORT_C void	SetArea(CLbtGeoAreaBase *)
IMPORT_C TFilterType	Type()

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

Private Member Functions
	CLbtTriggerFilterByArea(const CLbtTriggerFilterByArea &)
	CLbtTriggerFilterByArea()
void	ConstructL(CLbtGeoAreaBase *)
CLbtTriggerFilterByArea &	operator=(const CLbtTriggerFilterByArea &)

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()
	CLbtTriggerFilterBase::CLbtTriggerFilterBase()
	CLbtTriggerFilterBase::ExternalizeL(RWriteStream &)const
	CLbtTriggerFilterBase::InternalizeL(RReadStream &)
	CLbtTriggerFilterBase::~CLbtTriggerFilterBase()

Inherited Enumerations
	CLbtTriggerFilterBase:TFilterType

Private Attributes
CLbtGeoAreaBase *	iGeoArea

Constructor & Destructor Documentation

CLbtTriggerFilterByArea(const CLbtTriggerFilterByArea &)

CLbtTriggerFilterByArea

(

const CLbtTriggerFilterByArea &

)

[private]

By default, prohibit copy constructor

Parameters

const CLbtTriggerFilterByArea &

CLbtTriggerFilterByArea()

CLbtTriggerFilterByArea

(

)

[private]

Constructor.

~CLbtTriggerFilterByArea()

IMPORT_C

~CLbtTriggerFilterByArea

(

)

[virtual]

Destructor.

Member Functions Documentation

Area()

IMPORT_C CLbtGeoAreaBase *

Area

(

)

Gets the geographical area, inside which the triggers are retrieved.

If the area has not been set, this function returns NULL.

ConstructL(CLbtGeoAreaBase *)

void

ConstructL

(

CLbtGeoAreaBase *

aArea

)

[private]

Default constructor.

Parameters

CLbtGeoAreaBase * aArea

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.

NewL(CLbtGeoAreaBase *)

IMPORT_C CLbtTriggerFilterByArea *

NewL

(

CLbtGeoAreaBase *

aArea

)

[static]

Constructs a new instance of CLbtTriggerFilterByArea.

Parameters

CLbtGeoAreaBase * aArea

Pointer to the geographical area object. Ownership of aArea is transferred to this object. If the center of the geographical circular area is omitted, latest acquired location is used when retrieving triggers.

NewL()

IMPORT_C CLbtTriggerFilterByArea *

NewL

(

)

[static]

Constructs a new instance of CLbtTriggerFilterByArea. The returned object has no geographical area set.

NewLC()

IMPORT_C CLbtTriggerFilterByArea *

NewLC

(

)

[static]

Constructs a new instance of CLbtTriggerFilterByArea and pushes it onto cleanup stack. The returned object has no geographical area set.

SetArea(CLbtGeoAreaBase *)

IMPORT_C void

SetArea

(

CLbtGeoAreaBase *

aArea

)

Sets the geographical area in the filter. Only triggers that have triggering area inside the defined area are retrieved.

Parameters

CLbtGeoAreaBase * aArea

The pointer to the geographical area object. Ownership of aArea is transferred to this object. If the area is a geographical circular area and the center of the area is not set, latest acquired location is used by Location Triggering Server when retrieving triggers.