Collapse all Symbian^3 Product Developer Library

CLbtTriggerConditionArea Class Reference

class CLbtTriggerConditionArea : public CLbtTriggerConditionBase

Data class for the trigger condition based on the geographical area and movement of the terminal.

The trigger condition specifies where and when a location trigger shall be fired.

Trigger area defines where the trigger shall be fired. It is a geographical area. Currently, only geographical circular area is supported by the system.

Direction of movement defines when the trigger shall be fired. It specifies if the trigger shall be fired wether the terminal enters or exits the trigger area.

When a trigger has been fired, it will not be ready to be fired again until the terminal has moved a certain distance ( "hysteresis distance" ) outside of the trigger area.

Hysteresis distance is defined by system and can't be accessed by client applications.

lbt.lib

Since: S60 5.1

Inherits from

CLbtTriggerConditionArea
- CLbtTriggerConditionBase
  - CBase

Public Member Functions
	~CLbtTriggerConditionArea()
IMPORT_C TDirection	Direction()
IMPORT_C CLbtTriggerConditionArea *	NewL(CLbtGeoAreaBase *, TDirection)
IMPORT_C CLbtTriggerConditionArea *	NewL()
IMPORT_C CLbtTriggerConditionArea *	NewLC()
IMPORT_C void	SetDirection(TDirection)
IMPORT_C void	SetTriggerArea(CLbtGeoAreaBase *)
IMPORT_C CLbtGeoAreaBase *	TriggerArea()
TType	Type()

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

Private Member Functions
	CLbtTriggerConditionArea()
	CLbtTriggerConditionArea(const CLbtTriggerConditionArea &)
void	ConstructL()
void	ConstructL(CLbtGeoAreaBase *, TDirection)
CLbtTriggerConditionArea &	operator=(const CLbtTriggerConditionArea &)

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

Public Member Enumerations
enum	TDirection { EFireOnEnter = 1, EFireOnExit = 2 }

Inherited Enumerations
	CLbtTriggerConditionBase:TType

Private Attributes
CLbtGeoAreaBase *	iArea
TDirection	iDirection
TAny *	iReserved

Constructor & Destructor Documentation

CLbtTriggerConditionArea()

CLbtTriggerConditionArea

(

)

[private]

Default constructor.

Trigger area is set as NULL and default direction is EFireOnEnter.

CLbtTriggerConditionArea(const CLbtTriggerConditionArea &)

CLbtTriggerConditionArea

(

const CLbtTriggerConditionArea &

)

[private]

By default, prohibit copy constructor

Parameters

const CLbtTriggerConditionArea &

~CLbtTriggerConditionArea()

IMPORT_C

~CLbtTriggerConditionArea

(

)

[virtual]

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

Symbian 2nd phase constructor.

ConstructL(CLbtGeoAreaBase *, TDirection)

void	ConstructL	(	CLbtGeoAreaBase *	aArea,
			TDirection	aDirection
		)	[private]

Symbian 2nd phase constructor.

Parameters

CLbtGeoAreaBase * aArea
TDirection aDirection

Direction()

IMPORT_C TDirection

Direction

(

)

const

Gets the direction that defines when a trigger shall be fired.

If no direction has been set for the trigger, it will return EFireOnEnter.

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 *, TDirection)

IMPORT_C CLbtTriggerConditionArea *	NewL	(	CLbtGeoAreaBase *	aArea,
			TDirection	aDirection
		)	[static]

Constructs a new instance of trigger condition class based on the geographical area and movement of the terminal.

panic: ELbtErrArgument If the input trigger area is a class of CLbtGeoRect.

Parameters

CLbtGeoAreaBase * aArea	The trigger area. Only pointer to CLbtGeoCircle object is supported. Ownership is transferred to the returned CLbtTriggerConditionArea object.
TDirection aDirection	The direction( enter/exit ) of when a trigger shall be fired.

NewL()

IMPORT_C CLbtTriggerConditionArea *

NewL

(

)

[static]

Constructs a new instance of trigger condition class.

If construction is successful, it returns s a pointer to the trigger condition object. The returned object has no trigger area set, and the direction is EFireOnEnter.

NewLC()

IMPORT_C CLbtTriggerConditionArea *

NewLC

(

)

[static]

Constructs a new instance of trigger condition class and pushes it onto cleanup stack.

If construction is successful, it returns s a pointer to the trigger condition object. The returned object has no trigger area set, and the direction is EFireOnEnter.

SetDirection(TDirection)

IMPORT_C void

SetDirection

(

TDirection

aDirection

)

Sets the direction that defines when a trigger shall be fired.

Parameters

TDirection aDirection

The trigger direction. It defines when a trigger shall be fired.

SetTriggerArea(CLbtGeoAreaBase *)

IMPORT_C void

SetTriggerArea

(

CLbtGeoAreaBase *

aArea

)

Sets trigger area.

panic: ELbtErrArgument If the input trigger area is a class of CLbtGeoRect.

Parameters

CLbtGeoAreaBase * aArea

The trigger area. Only pointer to CLbtGeoCircle class is supported by current system. Ownership is transferred to this object.

TriggerArea()

IMPORT_C CLbtGeoAreaBase *

TriggerArea

(

)

const

Gets trigger area.

If the trigger area is not set before, NULL is returned. Ownership of the returned trigger area is not transferred to the client.

Type()

TType

Type

(

)

const [virtual]

Returns CLbtTriggerConditionBase::ETriggerConditionArea.

operator=(const CLbtTriggerConditionArea &)

CLbtTriggerConditionArea &

operator=

(

const CLbtTriggerConditionArea &

)

[private]

Prohibit assigment operator

Parameters

const CLbtTriggerConditionArea &

Member Enumerations Documentation

Enum TDirection

Specifies in which direction the location trigger is fired.

Enumerators

EFireOnEnter = 1	The trigger is fired when the terminal is entering the trigger area.
EFireOnExit = 2	The trigger is fired when the terminal is exiting the trigger area.

Member Data Documentation

CLbtGeoAreaBase * iArea

CLbtGeoAreaBase *

iArea

[private]

Area

TDirection iDirection

TDirection

iDirection

[private]

Direction

TAny * iReserved

TAny *

iReserved

[private]

Reserved pointer for future extension