CLogFilter Class Reference

#include <logcli.h>

Link against: logcli.lib

class CLogFilter : public CBase

Inherits from

CLogFilter
- CBase

Public Member Functions
	~CLogFilter()
void	ClearFlags(TLogFlags)
TLogContactItemId	Contact()
IMPORT_C void	Copy(const CLogFilter &)
const TDesC &	Direction()
TLogDurationType	DurationType()
const TTime &	EndTime()
TUid	EventType()
void	ExternalizeL(RWriteStream &)
TLogFlags	Flags()
void	InternalizeL(RReadStream &)
IMPORT_C CLogFilter *	NewL()
TUint32	NullFields()
const TDesC &	Number()
const TDesC &	RemoteParty()
void	SetContact(TLogContactItemId)
void	SetDirection(const TDesC &)
void	SetDurationType(TLogDurationType)
void	SetEndTime(const TTime &)
void	SetEventType(TUid)
void	SetFlags(TLogFlags)
void	SetNullFields(TUint32)
void	SetNumber(const TDesC &)
void	SetRemoteParty(const TDesC &)
IMPORT_C void	SetSimId(TSimId)
void	SetStartTime(const TTime &)
void	SetStatus(const TDesC &)
IMPORT_C TSimId	SimId()
const TTime &	StartTime()
const TDesC &	Status()

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

Detailed 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.

Constructor & Destructor Documentation

~CLogFilter ( )

IMPORT_C

~CLogFilter

(

)

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

Member Function Documentation

ClearFlags ( TLogFlags )

void

ClearFlags

(

TLogFlags

aFlags

)

[inline]

Clears the specified flags to be used by the filter.

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

Parameters
aFlags	The flags to be cleared

Contact ( )

TLogContactItemId

Contact

(

)

const [inline]

Gets the contact ID used by the filter.

Copy ( const CLogFilter & )

IMPORT_C void

Copy

(

const CLogFilter &

aFilter

)

Makes a copy of a filter.

Parameters
aFilter	The filter object to be copied.

Direction ( )

const TDesC &

Direction

(

)

const [inline]

Gets the direction string used by the filter.

DurationType ( )

TLogDurationType

DurationType

(

)

const [inline]

Gets the duration type used by the filter.

EndTime ( )

const TTime &

EndTime

(

)

const [inline]

Gets the UTC end time used by the filter.

Return Value: The UTC end time.

EventType ( )

TUid

EventType

(

)

const [inline]

Gets the event type used by the filter.

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Flags ( )

TLogFlags

Flags

(

)

const [inline]

Gets the flags used by the filter.

Return Value: The flags.

InternalizeL ( RReadStream & )

void

InternalizeL

(

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.

Return Value: A pointer to the new event object.

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.

Number ( )

const TDesC &

Number

(

)

const [inline]

Gets the phone number used by the filter.

RemoteParty ( )

const TDesC &

RemoteParty

(

)

const [inline]

Gets the remote party string used by the filter.

SetContact ( TLogContactItemId )

void

SetContact

(

TLogContactItemId

aContact

)

[inline]

Sets the contact ID to be used by the filter.

Parameters
aContact	The contact ID.

SetDirection ( const TDesC & )

void

SetDirection

(

const TDesC &

aDirection

)

[inline]

Sets the direction string to be used by the filter.

Parameters
aDirection	The direction string.

SetDurationType ( TLogDurationType )

void

SetDurationType

(

TLogDurationType

aType

)

[inline]

Sets the duration type to be used by the filter.

Parameters
aType	The duration type.

SetEndTime ( const TTime & )

void

SetEndTime

(

const TTime &

aEndTime

)

[inline]

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

Parameters
aEndTime	The UTC end time to be set.

SetEventType ( TUid )

void

SetEventType

(

TUid

aType

)

[inline]

Sets the event type to be used by the filter.

Parameters
aType	The event type UID.

SetFlags ( TLogFlags )

void

SetFlags

(

TLogFlags

aFlags

)

[inline]

Sets the specified flags to be used by the filter.

Parameters
aFlags	The flags to be set.

SetNullFields ( TUint32 )

void

SetNullFields

(

TUint32

aFields

)

[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
aFields	Bit 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 & )

void

SetNumber

(

const TDesC &

aNumber

)

[inline]

Sets the phone number to be used by the filter.

Parameters
aNumber	The phone number.

SetRemoteParty ( const TDesC & )

void

SetRemoteParty

(

const TDesC &

aRemote

)

[inline]

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

Parameters
aRemote	The remote party string.

SetSimId ( TSimId )

IMPORT_C void

SetSimId

(

TSimId

aSimId

)

Not supported.

SetStartTime ( const TTime & )

void

SetStartTime

(

const TTime &

aStartTime

)

[inline]

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

Parameters
aStartTime	The UTC start time to be set.

SetStatus ( const TDesC & )

void

SetStatus

(

const TDesC &

aStatus

)

[inline]

Sets the delivery status to be used by the filter.

Parameters
aStatus	The delivery status.

SimId ( )

IMPORT_C TSimId

SimId

(

)

const

Not supported.

StartTime ( )

const TTime &

StartTime

(

)

const [inline]

Gets the UTC start time used by the filter.

Return Value: The UTC start time.

Status ( )

const TDesC &

Status

(

)

const [inline]

Gets the delivery status used by the filter.