CLbtTriggerFilterByAttribute Class Reference

#include <mw/lbttriggerfilterbyattribute.h>

Link against: lbt.lib

class CLbtTriggerFilterByAttribute : public CLbtTriggerFilterBase

Inherits from

CLbtTriggerFilterByAttribute
- CLbtTriggerFilterBase

Public Member Functions
virtual	~CLbtTriggerFilterByAttribute()
IMPORT_C void	AddTriggerIdL(TLbtTriggerId)
IMPORT_C void	AddTriggerManagerUiL(TUid)
IMPORT_C void	AddTriggerStateL(CLbtTriggerEntry::TLbtTriggerState)
IMPORT_C void	AddTriggerTypeL(CLbtTriggerEntry::TType)
IMPORT_C void	AddTriggerValidityL(TLbtTriggerDynamicInfo::TLbtTriggerValidity)
IMPORT_C void	GetManagerUiArrayL(RArray< TUid > &)
IMPORT_C void	GetStateArrayL(RArray< CLbtTriggerEntry::TLbtTriggerState > &)
IMPORT_C void	GetTriggerIdArrayL(RArray< TLbtTriggerId > &)
IMPORT_C void	GetTypeArrayL(RArray< CLbtTriggerEntry::TType > &)
IMPORT_C void	GetValidityArrayL(RArray< TLbtTriggerDynamicInfo::TLbtTriggerValidity > &)
IMPORT_C TBool	IsTriggerIdInFilter(TLbtTriggerId)
IMPORT_C TBool	IsTriggerManagerUiInFilter(TUid)
IMPORT_C TBool	IsTriggerStateInFilter(CLbtTriggerEntry::TLbtTriggerState)
IMPORT_C TBool	IsTriggerTypeInFilter(CLbtTriggerEntry::TType)
IMPORT_C TBool	IsTriggerValidityStatusInFilter(TLbtTriggerDynamicInfo::TLbtTriggerValidity)
IMPORT_C CLbtTriggerFilterByAttribute *	NewL()
IMPORT_C CLbtTriggerFilterByAttribute *	NewLC()
IMPORT_C void	ResetFilter()
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 attribute values of a trigger.

Following attributes of triggers can be used in the filter when listing triggers from Location Triggering Server.

Trigger Type. It specifies what type of triggers shall be retrieved. By default, the trigger type is not used in filtering. If one or more trigger types are added to the filter, only triggers matching the specified type will be retrieved.

Trigger State. It specifies the state of the interested trigger entries. By default, trigger state is not used in filtering. If one or more states are added in the filter, only trigger entries with the specified states will be retrieved.

Trigger Validity. It specifies the validity status that the retrieved triggers must have. By default, trigger validity status is not used in filtering. If one or more trigger validity status is added to the filter, only trigger entries with the specified validity status will be retrieved.

Manager UI. It specifies the manager UI of the interested trigger entries. But default, manager UI attribute is not used in filtering. If one or more manager UI UIDs are added in the filter, only trigger entries that their manager UI UIDs are defined in the filter will be retrieved. KNullUid can also be used to fetch those triggers that have no manager UI set.

Id. It specified the Id of the interested trigger entries. By default, trigger ID attribute is not used in filtering. If one or more Ids are added in the filter, only trigger entries that their IDs are defined in the filter will be retrieved.

Since: S60 5.1

Constructor & Destructor Documentation

~CLbtTriggerFilterByAttribute ( )

IMPORT_C

~CLbtTriggerFilterByAttribute

(

)

[virtual]

Destructor.

Member Function Documentation

AddTriggerIdL ( TLbtTriggerId )

IMPORT_C void

AddTriggerIdL

(

TLbtTriggerId

aId

)

Adds a trigger Id to the filter.

Parameter	Description
aId	The trigger Id to be used in the filter.

AddTriggerManagerUiL ( TUid )

IMPORT_C void

AddTriggerManagerUiL

(

TUid

aUid

)

Adds a manager UI UID to the filter.

Parameter	Description
aUid	The UID of the manager UI to be used in the filter.

AddTriggerStateL ( CLbtTriggerEntry::TLbtTriggerState )

IMPORT_C void

AddTriggerStateL

(

CLbtTriggerEntry::TLbtTriggerState

aState

)

Adds a trigger state to the filter.

Parameter	Description
aState	The trigger state used in the filter.

AddTriggerTypeL ( CLbtTriggerEntry::TType )

IMPORT_C void

AddTriggerTypeL

(

CLbtTriggerEntry::TType

aType

)

Adds a trigger type to the filter.

Parameter	Description
aType	The type of the trigger to be retrieved.

AddTriggerValidityL ( TLbtTriggerDynamicInfo::TLbtTriggerValidity )

IMPORT_C void

AddTriggerValidityL

(

TLbtTriggerDynamicInfo::TLbtTriggerValidity

aValidity

)

Adds a trigger validity status to the filter.

Parameter	Description
aValidity	The validity status value used in the filter.

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.

GetManagerUiArrayL ( RArray< TUid > & )

IMPORT_C void

GetManagerUiArrayL

(

RArray< TUid > &

aManagerUiArray

)

const

Gets manager UI UIDs that have been used in this filter.

Parameter	Description
aManagerUiArray	On return, contains manager UI UIDs that have been used in this filter.

GetStateArrayL ( RArray< CLbtTriggerEntry::TLbtTriggerState > & )

IMPORT_C void

GetStateArrayL

(

RArray< CLbtTriggerEntry::TLbtTriggerState > &

aTriggerStateArray

)

const

Gets trigger states that have been used in this filter

Parameter	Description
aTriggerStateArray	On return contains trigger states that have been used in this filter.

GetTriggerIdArrayL ( RArray< TLbtTriggerId > & )

IMPORT_C void

GetTriggerIdArrayL

(

RArray< TLbtTriggerId > &

aIdArray

)

const

Gets trigger IDs that have been used in this filter.

Parameter	Description
aIdArray	On return contains trigger IDs that have been used in this filter.

GetTypeArrayL ( RArray< CLbtTriggerEntry::TType > & )

IMPORT_C void

GetTypeArrayL

(

RArray< CLbtTriggerEntry::TType > &

aTriggerTypeArray

)

const

Gets trigger entry types that have been used in this filter.

Parameter	Description
aTriggerTypeArray	On return contains trigger types that have been used in this filter.

GetValidityArrayL ( RArray< TLbtTriggerDynamicInfo::TLbtTriggerValidity > & )

IMPORT_C void

GetValidityArrayL

(

RArray< TLbtTriggerDynamicInfo::TLbtTriggerValidity > &

aTriggerValidityArray

)

const

Gets trigger validity status that has been used in this filter.

Parameter	Description
aTriggerValidityArray	On return, contains trigger validity status that have been used in this filter.

IsTriggerIdInFilter ( TLbtTriggerId )

IMPORT_C TBool

IsTriggerIdInFilter

(

TLbtTriggerId

aId

)

const

Tests if the specified trigger Id is used in the filter.

Parameter	Description
aId	the trigger Id to be tested.

Returns: ETrue if the specified trigger Id is used in the filter. Otherwise, EFalse is returned.

IsTriggerManagerUiInFilter ( TUid )

IMPORT_C TBool

IsTriggerManagerUiInFilter

(

TUid

aUid

)

const

Tests if the specified UID of a manager UI is used in the filter.

Parameter	Description
aUid	The UID of a manager UI to be tested.

Returns: ETrue if the specified UID is used in the filter. Otherwise, EFalse is returned.

IsTriggerStateInFilter ( CLbtTriggerEntry::TLbtTriggerState )

IMPORT_C TBool

IsTriggerStateInFilter

(

CLbtTriggerEntry::TLbtTriggerState

aState

)

const

Tests if the specified trigger state is in the filter.

Parameter	Description
aState	The trigger state to be tested.

Returns: ETrue if the the trigger state is used in filter. Otherwise, EFalse is returned.

IsTriggerTypeInFilter ( CLbtTriggerEntry::TType )

IMPORT_C TBool

IsTriggerTypeInFilter

(

CLbtTriggerEntry::TType

aType

)

const

Tests if the specified trigger type is used in the filter.

Parameter	Description
aType	The trigger type used in the filter.

Returns: ETrue if the the trigger type is used in filter. Otherwise, EFalse is returned.

IsTriggerValidityStatusInFilter ( TLbtTriggerDynamicInfo::TLbtTriggerValidity )

IMPORT_C TBool

IsTriggerValidityStatusInFilter

(

TLbtTriggerDynamicInfo::TLbtTriggerValidity

aValidity

)

const

Tests if the trigger validity status value is in the filter.

Parameter	Description
aValidity	The validity status value to be tested.

Returns: ETrue if the the trigger validity status is used in filter. Otherwise, EFalse is returned.

NewL ( )

IMPORT_C CLbtTriggerFilterByAttribute *

NewL

(

)

[static]

Constructs a new instance of CLbtTriggerFilterByAttribute. In the returned object, trigger type, trigger state trigger validity status, manager UI and trigger Id are not used in filtering.

Returns: New instance of CLbtTriggerFilterByAttribute.

NewLC ( )

IMPORT_C CLbtTriggerFilterByAttribute *

NewLC

(

)

[static]

Constructs a new instance of CLbtTriggerFilterByAttribute and pushes it onto cleanup stack. In the returned object, trigger type, trigger state trigger validity status, manager UI and trigger Id are not used in filtering.

Returns: New instance of CLbtTriggerFilterByAttribute.

ResetFilter ( )

IMPORT_C void

ResetFilter

(

)

Resets the filter. The trigger type, trigger state, trigger validity, manager UI and trigger Id are not used in filtering.

Type ( )

IMPORT_C TFilterType

Type

(

)

const [virtual]

Reimplemented from CLbtTriggerFilterBase::Type()const

Returns CLbtTriggerFilterBase::EFilterByAttribute.

Returns: CLbtTriggerFilterBase::EFilterByAttribute