Collapse all Symbian^3 Application Developer Library

CLbtStrategyBase Class Reference

class CLbtStrategyBase : public CBase

Abstract base class for location acquisition strategy plug-ins implementation.

A strategy plug-in is responsible for the trigger supervision process, i.e. acquiring locations with suitable intervals and providing notifications when triggers are fired.

A location acquisition strategy plug-in must implement a subclass of this base class. This base class defines interface between Location Triggering Server and the strategy plug-in.

ltstrategypluginapi.lib

Since: S60 4.0

Inherits from

CLbtStrategyBase
- CBase

Public Member Functions
	~CLbtStrategyBase ()
IMPORT_C void	GetTriggeringSupervisionSettings ( TLbtStrategyTriggeringSupervisionSettings &)
IMPORT_C CLbtStrategyBase *	NewL ( TAny *)
IMPORT_C void	SetTriggeringSupervisionDynamicInfo (const TLbtStrategySupervisionDynamicInfo &)
IMPORT_C void	StartSupervision ()
IMPORT_C void	StopSupervision ()
IMPORT_C void	TriggerFiredL ( CLbtGeoAreaBase::TGeoAreaType , TLbtTriggerId , const TPositionInfo &)
void	TriggeringSupervisionSettingsChanged ()

Protected Member Functions
	CLbtStrategyBase ()
IMPORT_C void	BaseConstructL ( TAny *)

Private Member Functions
IMPORT_C void	CLbtStrategy_Reserved1 ()
IMPORT_C void	CLbtStrategy_Reserved2 ()

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

Private Attributes
TUid	iDtorIdKey
CLbtBaseStrategyExtension *	iExtension
MLbtTriggeringSupervisionObserver *	iStrategyObserver

Constructor & Destructor Documentation

CLbtStrategyBase()

IMPORT_C

CLbtStrategyBase

(

)

[protected]

C++ default constructor.

~CLbtStrategyBase()

IMPORT_C

~CLbtStrategyBase

(

)

Destructor.

Member Functions Documentation

BaseConstructL(TAny *)

IMPORT_C void

BaseConstructL

(

TAny *

aConstructionParameters

)

[protected]

Creates the internals of the strategy.

This function must be called first in the strategy's ConstructL() method.

Parameters

TAny * aConstructionParameters

The construction parameters supplied in the factory call.

CLbtStrategy_Reserved1()

IMPORT_C void

CLbtStrategy_Reserved1

(

)

[private, virtual]

CLbtStrategy_Reserved2()

IMPORT_C void

CLbtStrategy_Reserved2

(

)

[private, virtual]

GetTriggeringSupervisionSettings(TLbtStrategyTriggeringSupervisionSettings &)

IMPORT_C void

GetTriggeringSupervisionSettings

(

TLbtStrategyTriggeringSupervisionSettings &

aSettings

)

Get system settings related to triggering supervision from Location Triggering Server.

Parameters

TLbtStrategyTriggeringSupervisionSettings & aSettings

In return, contains system settings related to triggering supervision.

NewL(TAny *)

IMPORT_C CLbtStrategyBase *

NewL

(

TAny *

aConstructionParameters

)

[static]

Creates a new instance of a strategy implementation.

Parameters

TAny * aConstructionParameters

Construction parameters for CLbtBaseStrategy. Must by passed to BaseConstructL() by the strategy implementation.

SetTriggeringSupervisionDynamicInfo(const TLbtStrategySupervisionDynamicInfo &)

IMPORT_C void

SetTriggeringSupervisionDynamicInfo

(

const TLbtStrategySupervisionDynamicInfo &

aDynInfo

)

Inform Location Triggering Server about the location triggering supervision dynamic information.

Location acquisition strategy plug-in shall use this method to update the supervision dynamic information to Location Triggering Server every time a location request is completed.

Parameters

const TLbtStrategySupervisionDynamicInfo & aDynInfo

Contains the new triggering supervision dynamic information.

StartSupervision()

IMPORT_C void

StartSupervision

(

)

[pure virtual]

Start supervision process.

This function must be implemented by the strategy plug-in. Location Triggering Server calls this function to start supervision process. If the supervision process is already started when this method is called, location acquisition strategy plug-in shall do nothing.

StopSupervision()

IMPORT_C void

StopSupervision

(

)

[pure virtual]

Stop supervision process.

This function must be implemented by the strategy plug-in. Location Triggering Server calls this function to stop supervision process. The strategy plug-in shall release all resources used for supervision process when this function is called.

If the supervision process is not started when this method is called, location acquisition strategy plug-in shall do nothing.

TriggerFiredL(CLbtGeoAreaBase::TGeoAreaType, TLbtTriggerId, const TPositionInfo &)

IMPORT_C void	TriggerFiredL	(	CLbtGeoAreaBase::TGeoAreaType	aAreaType,
			TLbtTriggerId	aId,
			const TPositionInfo &	aPosInfo
		)

Inform Location Triggering Server that a trigger shall be fired.

When a trigger is fired, the strategy plug-in calls this function to inform Location Triggering Server.

When more than one trigger is fired simultaneously, strategy plug-in shall call this function separately for each the fired trigger.

Parameters

CLbtGeoAreaBase::TGeoAreaType aAreaType
TLbtTriggerId aId	The ID of the firing trigger.
const TPositionInfo & aPosInfo	The position information associated with the firing event. Only basic position information is returned in this parameter.

TriggeringSupervisionSettingsChanged()

void

TriggeringSupervisionSettingsChanged

(

)

[pure virtual]

Inform location acquisition strategy plug-in that system settings related to trigger supervision are changed.

This function must be implemented by the strategy plug-in. Location Triggering Server calls this function every time when triggering supervision settings is change.

Member Data Documentation

TUid iDtorIdKey

TUid

iDtorIdKey

[private]

CLbtBaseStrategyExtension * iExtension

CLbtBaseStrategyExtension *

iExtension

[private]

MLbtTriggeringSupervisionObserver * iStrategyObserver

MLbtTriggeringSupervisionObserver *

iStrategyObserver

[private]