Class CLogFilter

class CLogFilter : public CBase;

Description

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

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

Members

Defined in CLogFilter:

• ClearFlags(TLogFlags)Clears the specified flags to be used by the filter.
• Contact()constGets the contact ID used by the filter.
• Copy(const CLogFilter &)Makes a copy of a filter.
• Direction()constGets the direction string used by the filter.
• DurationType()constGets the duration type used by the filter.
• EndTime()constGets the UTC end time used by the filter.
• EventType()constGets the event type used by the filter.
• Flags()constGets the flags used by the filter.
• NewL()Creates a new filter object.
• NullFields()constIdentifies the fields defined as NULL in the filter. These are the fields that t...
• Number()constGets the phone number used by the filter.
• RemoteParty()constGets the remote party string used by the filter.
• SetContact(TLogContactItemId)Sets the contact ID to be used by the filter.
• SetDirection(const TDesC &)Sets the direction string to be used by the filter.
• SetDurationType(TLogDurationType)Sets the duration type to be used by the filter.
• SetEndTime(const TTime &)Sets the specified UTC end time to be used by the filter.
• SetEventType(TUid)Sets the event type to be used by the filter.
• SetFlags(TLogFlags)Sets the specified flags to be used by the filter.
• SetNullFields(TUint32)Defines NULL fields to the filter. These are the fields that the filter expects ...
• SetNumber(const TDesC &)Sets the phone number to be used by the filter.
• SetRemoteParty(const TDesC &)Sets the remote party string to be used by the filter.
• SetStartTime(const TTime &)Sets the specified UTC start time to be used by the filter.
• SetStatus(const TDesC &)Sets the delivery status to be used by the filter.
• StartTime()constGets the UTC start time used by the filter.
• Status()constGets the delivery status used by the filter.
• ~CLogFilter()Frees all resource owned by the object prior to its destruction.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CLogEventEncapsulates the details of an event.
• CLogViewEventA view on the event log.
• CLogViewRecentA view on a recent event list.
• CLogViewDuplicateA view of events that are duplicates of an event in a view of recent events.

IMPORT_C static CLogFilter* NewL();

Description

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.

Return value

IMPORT_C ~CLogFilter();

Description

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

inline TUid EventType() const;

Description

Gets the event type used by the filter.

Return value

See also:

• CLogEvent::EventType()constGets the type of this log event. Event types are identified by a UID.

inline void SetEventType(TUid aType);

Description

Sets the event type to be used by the filter.

Parameters

See also:

• CLogEvent::SetEventType(TUid)Sets the type of this log event. Event types are identified by a UID.

inline const TDesC& RemoteParty() const;

Description

Gets the remote party string used by the filter.

Return value

See also:

• CLogEvent::RemoteParty()constGets the remote party associated with this event.

inline void SetRemoteParty(const TDesC &aRemote);

Description

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

Parameters

See also:

• CLogEvent::SetRemoteParty(const TDesC &)Sets the remote party associated with this event. This describes the destination...

inline const TDesC& Direction() const;

Description

Gets the direction string used by the filter.

Return value

See also:

• CLogEvent::Direction()constGets the direction of the call represented by this event. The direction of a cal...

inline void SetDirection(const TDesC &aDirection);

Description

Sets the direction string to be used by the filter.

Parameters

See also:

• CLogEvent::SetDirection(const TDesC &)Sets the direction of the call represented by this event. The direction of a cal...

inline TLogDurationType DurationType() const;

Description

Gets the duration type used by the filter.

Return value

See also:

• CLogEvent::DurationType()constGets the duration type.

inline void SetDurationType(TLogDurationType aType);

Description

Sets the duration type to be used by the filter.

Parameters

See also:

• CLogEvent::SetDurationType(TLogDurationType)Sets the duration type. This applies meaning to the idea of a duration.

inline const TDesC& Status() const;

Description

Gets the delivery status used by the filter.

Return value

See also:

• CLogEvent::Status()constGets the delivery status of this event.

inline void SetStatus(const TDesC &aStatus);

Description

Sets the delivery status to be used by the filter.

Parameters

See also:

• CLogEvent::SetStatus(const TDesC &)Sets the delivery status of this event.

inline TLogContactItemId Contact() const;

Description

Gets the contact ID used by the filter.

Return value

See also:

• CLogEvent::Contact()constGets the contact ID associated with the event.

inline void SetContact(TLogContactItemId aContact);

Description

Sets the contact ID to be used by the filter.

Parameters

See also:

• CLogEvent::SetContact(TLogContactItemId)Sets the contact ID associated with the event.

inline const TDesC& Number() const;

Description

Gets the phone number used by the filter.

Return value

See also:

• CLogEvent::Number()constGets the phone number associated with the event.

inline void SetNumber(const TDesC &aNumber);

Description

Sets the phone number to be used by the filter.

Parameters

See also:

• CLogEvent::SetNumber(const TDesC &)Sets the phone number associated with this event. This is used when the number c...

inline TLogFlags Flags() const;

Description

Gets the flags used by the filter.

Return value

inline void SetFlags(TLogFlags aFlags);

Description

Sets the specified flags to be used by the filter.

Parameters

inline void ClearFlags(TLogFlags aFlags);

Description

Clears the specified flags to be used by the filter.

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

Parameters

inline TUint32 NullFields() const;

Description

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.

Return value

See also:

• CLogFilter::SetNullFields(TUint32)Defines NULL fields to the filter. These are the fields that the filter expects ...

inline void SetNullFields(TUint32 aFields);

Description

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

inline const TTime& StartTime() const;

Description

Gets the UTC start time used by the filter.

Return value

inline void SetStartTime(const TTime &aStartTime);

Description

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

Parameters

inline const TTime& EndTime() const;

Description

Gets the UTC end time used by the filter.

Return value

inline void SetEndTime(const TTime &aEndTime);

Description

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

Parameters

IMPORT_C void Copy(const CLogFilter &aFilter);

Description

Makes a copy of a filter.

Parameters