CLogFilter Class Reference

#include <logcli.h>

Link against: logcli.lib

class CLogFilter : public CBase

Inherits from

  • CLogFilter
    Public Member Functions
    ~CLogFilter()
    voidClearFlags(TLogFlags)
    TLogContactItemId Contact()
    IMPORT_C voidCopy(const CLogFilter &)
    const TDesC &Direction()
    TLogDurationType DurationType()
    const TTime &EndTime()
    TUid EventType()
    voidExternalizeL(RWriteStream &)
    TLogFlags Flags()
    voidInternalizeL(RReadStream &)
    IMPORT_C CLogFilter *NewL()
    TUint32 NullFields()
    const TDesC &Number()
    const TDesC &RemoteParty()
    voidSetContact(TLogContactItemId)
    voidSetDirection(const TDesC &)
    voidSetDurationType(TLogDurationType)
    voidSetEndTime(const TTime &)
    voidSetEventType(TUid)
    voidSetFlags(TLogFlags)
    voidSetNullFields(TUint32)
    voidSetNumber(const TDesC &)
    voidSetRemoteParty(const TDesC &)
    IMPORT_C voidSetSimId(TSimId)
    voidSetStartTime(const TTime &)
    voidSetStatus(const TDesC &)
    IMPORT_C TSimIdSimId()
    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.

    See also: CLogEvent CLogViewEvent CLogViewRecent CLogViewDuplicate

    Constructor & Destructor Documentation

    ~CLogFilter ( )

    IMPORT_C~CLogFilter()

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

    Member Function 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.

    ParameterDescription
    aFlagsThe flags to be cleared

    Contact ( )

    TLogContactItemId Contact()const [inline]

    Gets the contact ID used by the filter.

    See also: CLogEvent::Contact()

    Returns: The contact ID.

    Copy ( const CLogFilter & )

    IMPORT_C voidCopy(const CLogFilter &aFilter)

    Makes a copy of a filter.

    ParameterDescription
    aFilterThe filter object to be copied.

    Direction ( )

    const TDesC &Direction()const [inline]

    Gets the direction string used by the filter.

    See also: CLogEvent::Direction()

    Returns: A non-modifiable descriptor containing the direction string.

    DurationType ( )

    TLogDurationType DurationType()const [inline]

    Gets the duration type used by the filter.

    See also: CLogEvent::DurationType()

    Returns: The duration type.

    EndTime ( )

    const TTime &EndTime()const [inline]

    Gets the UTC end time used by the filter.

    Returns: The UTC end time.

    EventType ( )

    TUid EventType()const [inline]

    Gets the event type used by the filter.

    See also: CLogEvent::EventType()

    Returns: The event type UID.

    ExternalizeL ( RWriteStream & )

    voidExternalizeL(RWriteStream &aStream)const

    Flags ( )

    TLogFlags Flags()const [inline]

    Gets the flags used by the filter.

    Returns: The flags.

    InternalizeL ( RReadStream & )

    voidInternalizeL(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.

    Returns: 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.

    See also: SetNullFields()

    Returns: Bit values defining the null fields.

    Number ( )

    const TDesC &Number()const [inline]

    Gets the phone number used by the filter.

    See also: CLogEvent::Number()

    Returns: A non-modifiable descriptor containing the phone number.

    RemoteParty ( )

    const TDesC &RemoteParty()const [inline]

    Gets the remote party string used by the filter.

    See also: CLogEvent::RemoteParty()

    Returns: A non-modifiable descriptor containing the remote party string.

    SetContact ( TLogContactItemId )

    voidSetContact(TLogContactItemIdaContact)[inline]

    Sets the contact ID to be used by the filter.

    See also: CLogEvent::SetContact()

    ParameterDescription
    aContactThe contact ID.

    SetDirection ( const TDesC & )

    voidSetDirection(const TDesC &aDirection)[inline]

    Sets the direction string to be used by the filter.

    See also: CLogEvent::SetDirection()

    ParameterDescription
    aDirectionThe direction string.

    SetDurationType ( TLogDurationType )

    voidSetDurationType(TLogDurationTypeaType)[inline]

    Sets the duration type to be used by the filter.

    See also: CLogEvent::SetDurationType()

    ParameterDescription
    aTypeThe duration type.

    SetEndTime ( const TTime & )

    voidSetEndTime(const TTime &aEndTime)[inline]

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

    ParameterDescription
    aEndTimeThe UTC end time to be set.

    SetEventType ( TUid )

    voidSetEventType(TUidaType)[inline]

    Sets the event type to be used by the filter.

    See also: CLogEvent::SetEventType()

    ParameterDescription
    aTypeThe event type UID.

    SetFlags ( TLogFlags )

    voidSetFlags(TLogFlagsaFlags)[inline]

    Sets the specified flags to be used by the filter.

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

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

    See also: CLogEvent::SetNumber()

    ParameterDescription
    aNumberThe phone number.

    SetRemoteParty ( const TDesC & )

    voidSetRemoteParty(const TDesC &aRemote)[inline]

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

    See also: CLogEvent::SetRemoteParty()

    ParameterDescription
    aRemoteThe remote party string.

    SetSimId ( TSimId )

    IMPORT_C voidSetSimId(TSimIdaSimId)

    Not supported.

    SetStartTime ( const TTime & )

    voidSetStartTime(const TTime &aStartTime)[inline]

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

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

    See also: CLogEvent::SetStatus()

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

    Returns: The UTC start time.

    Status ( )

    const TDesC &Status()const [inline]

    Gets the delivery status used by the filter.

    See also: CLogEvent::Status()

    Returns: A non-modifiable descriptor containing the delivery status.

    © Nokia 2011.