CLogFilter Class Reference

class CLogFilter : public CBase

Specifies the conditions that events must satisfy to appear in a view.

In general, a filter is used to construct the WHERE clause of an SQL statement based on the content of the filter's fields. The filter's fields correspond to the event properties in a log event detail object, i.e. an instance of the CLogEvent class.

Where a filter uses time to extract one or more events from the log, this must be specified as UTC rather than local time.

CLogEvent CLogViewEvent CLogViewRecent CLogViewDuplicate

Inherits from

Constructor & Destructor Documentation

CLogFilter()

CLogFilter()[private]

~CLogFilter()

IMPORT_C~CLogFilter()

Frees all resource owned by the object prior to its destruction.

Member Functions Documentation

ClearFlags(TLogFlags)

voidClearFlags(TLogFlagsaFlags)[inline]

Clears the specified flags to be used by the filter.

The constant KLogFlagsMask can be used to clear all the flags.

Parameters

TLogFlags aFlagsThe flags to be cleared

ConstructL()

voidConstructL()[private]

Contact()

TLogContactItemId Contact()const [inline]

Gets the contact ID used by the filter.

CLogEvent::Contact()

Copy(const CLogFilter &)

IMPORT_C voidCopy(const CLogFilter &aFilter)

Makes a copy of a filter.

Parameters

const CLogFilter & aFilterThe filter object to be copied.

Direction()

const TDesC &Direction()const [inline]

Gets the direction string used by the filter.

CLogEvent::Direction()

DurationType()

TLogDurationType DurationType()const [inline]

Gets the duration type used by the filter.

CLogEvent::DurationType()

EndTime()

const TTime &EndTime()const [inline]

Gets the UTC end time used by the filter.

EventType()

TUid EventType()const [inline]

Gets the event type used by the filter.

CLogEvent::EventType()

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const

Parameters

RWriteStream & aStream

Flags()

TLogFlags Flags()const [inline]

Gets the flags used by the filter.

InternalizeBufL(RReadStream &, HBufC *&)

voidInternalizeBufL(RReadStream &aStream,
HBufC *&aDes
)[private]

Parameters

RReadStream & aStream
HBufC *& aDes

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)

Parameters

RReadStream & aStream

NewL()

IMPORT_C CLogFilter *NewL()[static]

Creates a new filter object.

All fields in the new instance are initialised to default values, so that if none of the fields are changed, the filter has no effect on the selection of events in view.

NullFields()

TUint32 NullFields()const [inline]

Identifies the fields defined as NULL in the filter. These are the fields that the filter expects to be NULL in the database. A NULL field is one that has no value.

SetNullFields()

Number()

const TDesC &Number()const [inline]

Gets the phone number used by the filter.

CLogEvent::Number()

RemoteParty()

const TDesC &RemoteParty()const [inline]

Gets the remote party string used by the filter.

CLogEvent::RemoteParty()

SetContact(TLogContactItemId)

voidSetContact(TLogContactItemIdaContact)[inline]

Sets the contact ID to be used by the filter.

CLogEvent::SetContact()

Parameters

TLogContactItemId aContactThe contact ID.

SetDirection(const TDesC &)

voidSetDirection(const TDesC &aDirection)[inline]

Sets the direction string to be used by the filter.

CLogEvent::SetDirection()

Parameters

const TDesC & aDirectionThe direction string.

SetDurationType(TLogDurationType)

voidSetDurationType(TLogDurationTypeaType)[inline]

Sets the duration type to be used by the filter.

CLogEvent::SetDurationType()

Parameters

TLogDurationType aTypeThe duration type.

SetEndTime(const TTime &)

voidSetEndTime(const TTime &aEndTime)[inline]

Sets the specified UTC end time to be used by the filter.

Parameters

const TTime & aEndTimeThe UTC end time to be set.

SetEventType(TUid)

voidSetEventType(TUidaType)[inline]

Sets the event type to be used by the filter.

CLogEvent::SetEventType()

Parameters

TUid aTypeThe event type UID.

SetFlags(TLogFlags)

voidSetFlags(TLogFlagsaFlags)[inline]

Sets the specified flags to be used by the filter.

Parameters

TLogFlags aFlagsThe flags to be set.

SetNullFields(TUint32)

voidSetNullFields(TUint32aFields)[inline]

Defines NULL fields to the filter. These are the fields that the filter expects to be NULL in the database. A NULL field is one that has no value.

Each field is identified by a bit value. The bit values may be ORd together in any combination.

Note that setting a flag and explicitly setting a value for the corresponding field generates an OR condition in the SQL WHERE clause.

Parameters

TUint32 aFieldsBit values defining the null fields. These are one or more of the following values defined in logwrap.hrh: ELogContactField, ELogDirectionField, ELogDurationTypeField, ELogEventTypeField, ELogNumberField, ELogRemotePartyField, ELogStatusField, ELogFlagsField, ELogSubjectField, ELogLinkField, ELogDataField, ELogSimIdField.

SetNumber(const TDesC &)

voidSetNumber(const TDesC &aNumber)[inline]

Sets the phone number to be used by the filter.

CLogEvent::SetNumber()

Parameters

const TDesC & aNumberThe phone number.

SetRemoteParty(const TDesC &)

voidSetRemoteParty(const TDesC &aRemote)[inline]

Sets the remote party string to be used by the filter.

CLogEvent::SetRemoteParty()

Parameters

const TDesC & aRemoteThe remote party string.

SetSimId(TSimId)

IMPORT_C voidSetSimId(TSimIdaSimId)

Not supported.

Parameters

TSimId aSimId

SetStartTime(const TTime &)

voidSetStartTime(const TTime &aStartTime)[inline]

Sets the specified UTC start time to be used by the filter.

Parameters

const TTime & aStartTimeThe UTC start time to be set.

SetStatus(const TDesC &)

voidSetStatus(const TDesC &aStatus)[inline]

Sets the delivery status to be used by the filter.

CLogEvent::SetStatus()

Parameters

const TDesC & aStatusThe delivery status.

SimId()

IMPORT_C TSimIdSimId()const

Not supported.

StartTime()

const TTime &StartTime()const [inline]

Gets the UTC start time used by the filter.

Status()

const TDesC &Status()const [inline]

Gets the delivery status used by the filter.

CLogEvent::Status()

Member Data Documentation

TLogContactItemId iContact

TLogContactItemId iContact[private]

HBufC * iDirection

HBufC *iDirection[private]

TLogDurationType iDurationType

TLogDurationType iDurationType[private]

TTime iEndTime

TTime iEndTime[private]

TUid iEventType

TUid iEventType[private]

TLogFlags iFlags

TLogFlags iFlags[private]

TUint32 iNullFields

TUint32 iNullFields[private]

HBufC * iNumber

HBufC *iNumber[private]

HBufC * iRemoteParty

HBufC *iRemoteParty[private]

TTime iStartTime

TTime iStartTime[private]

HBufC * iStatus

HBufC *iStatus[private]