CLbtTriggerConditionArea Class Reference

#include <mw/lbttriggerconditionarea.h>

Link against: lbt.lib

class CLbtTriggerConditionArea : public CLbtTriggerConditionBase

Inherits from

CLbtTriggerConditionArea
- CLbtTriggerConditionBase

Public Member Enumerations
enum	TDirection { EFireOnEnter, EFireOnExit }

Public Member Functions
virtual	~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()
virtual TType	Type()

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

Inherited Enumerations
	CLbtTriggerConditionBase:TType

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

Detailed Description

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.

Since: S60 5.1

Member Enumeration Documentation

Enum TDirection

Specifies in which direction the location trigger is fired.

Enumerator	Value	Description
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.

Constructor & Destructor Documentation

~CLbtTriggerConditionArea ( )

IMPORT_C

~CLbtTriggerConditionArea

(

)

[virtual]

Destructor.

Member Function Documentation

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.

Returns: The direction that specified when a trigger shall be fired.

DoExternalizeL ( RWriteStream & )

void

DoExternalizeL

(

RWriteStream &

aStream

)

const [protected, virtual]

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

Internalize method that subclass must implement.

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

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

Returns: A new instance of trigger condition class.

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.

Returns: A new instance of this class.

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.

Returns: A new instance of this class.

SetDirection ( TDirection )

IMPORT_C void

SetDirection

(

TDirection

aDirection

)

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

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

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

Returns: Pointer to the trigger area. Ownership of returned object is not transfered to the client.

Type ( )

TType

Type

(

)

const [virtual]

Reimplemented from CLbtTriggerConditionBase::Type()const

Returns CLbtTriggerConditionBase::ETriggerConditionArea.

Returns: CLbtTriggerConditionBase::ETriggerConditionArea