CLbtTriggerFilterByArea Class Reference

#include <mw/lbttriggerfilterbyarea.h>

Link against: lbt.lib

class CLbtTriggerFilterByArea : public CLbtTriggerFilterBase

Inherits from

CLbtTriggerFilterByArea
- CLbtTriggerFilterBase

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

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

Inherited Enumerations
	CLbtTriggerFilterBase:TFilterType

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

Detailed Description

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.

Since: S60 5.1

Constructor & Destructor Documentation

~CLbtTriggerFilterByArea ( )

IMPORT_C

~CLbtTriggerFilterByArea

(

)

[virtual]

Destructor.

Member Function 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.

Returns: The pointer to the geographical area object. Ownership is not transferred to the client.

DoExternalizeL ( RWriteStream & )

void

DoExternalizeL

(

RWriteStream &

aStream

)

const [protected, virtual]

Reimplemented from CLbtTriggerFilterBase::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 CLbtTriggerFilterBase::DoInternalizeL(RReadStream &)

Internalize method that subclass must implement.

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

NewL ( CLbtGeoAreaBase * )

IMPORT_C CLbtTriggerFilterByArea *

NewL

(

CLbtGeoAreaBase *

aArea

)

[static]

Constructs a new instance of CLbtTriggerFilterByArea.

Parameter	Description
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.

Returns: New instance of CLbtTriggerFilterByArea.

NewL ( )

IMPORT_C CLbtTriggerFilterByArea *

NewL

(

)

[static]

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

Returns: New instance of CLbtTriggerFilterByArea.

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.

Returns: New instance of CLbtTriggerFilterByArea.

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.

Parameter	Description
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.

Type ( )

IMPORT_C TFilterType

Type

(

)

const [virtual]

Reimplemented from CLbtTriggerFilterBase::Type()const

Returns CLbtTriggerFilterBase::EFilterByArea.

Returns: CLbtTriggerFilterBase::EFilterByArea.