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.
CLogViewEvent
CLogViewRecent
CLogViewDuplicate
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() |
Private Member Functions | |
---|---|
CLogFilter() | |
void | ConstructL() |
void | InternalizeBufL(RReadStream &, HBufC *&) |
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.
TLogFlags aFlags | The flags to be cleared |
IMPORT_C void | Copy | ( | const CLogFilter & | aFilter | ) |
const CLogFilter & aFilter |
const TDesC & | Direction | ( | ) | const [inline] |
Gets the direction string used by the filter.
A non-modifiable descriptor containing the direction string.
const TTime & | EndTime | ( | ) | const [inline] |
Gets the UTC end time used by the filter.
The UTC end time.
void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
RWriteStream & aStream |
void | InternalizeBufL | ( | RReadStream & | aStream, |
HBufC *& | aDes | |||
) | [private] |
RReadStream & aStream | |
HBufC *& aDes |
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.
Bit values defining the null fields.
const TDesC & | Number | ( | ) | const [inline] |
Gets the phone number used by the filter.
A non-modifiable descriptor containing the phone number.
const TDesC & | RemoteParty | ( | ) | const [inline] |
Gets the remote party string used by the filter.
A non-modifiable descriptor containing the remote party string.
void | SetContact | ( | TLogContactItemId | aContact | ) | [inline] |
Sets the contact ID to be used by the filter.
TLogContactItemId aContact | The contact ID. |
void | SetDirection | ( | const TDesC & | aDirection | ) | [inline] |
Sets the direction string to be used by the filter.
const TDesC & aDirection | The direction string. |
void | SetDurationType | ( | TLogDurationType | aType | ) | [inline] |
Sets the duration type to be used by the filter.
TLogDurationType aType | The duration type. |
void | SetEndTime | ( | const TTime & | aEndTime | ) | [inline] |
Sets the specified UTC end time to be used by the filter.
const TTime & aEndTime | The UTC end time to be set. |
void | SetEventType | ( | TUid | aType | ) | [inline] |
Sets the event type to be used by the filter.
TUid aType | The event type UID. |
void | SetFlags | ( | TLogFlags | aFlags | ) | [inline] |
Sets the specified flags to be used by the filter.
TLogFlags aFlags | The flags to be set. |
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.
TUint32 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. |
void | SetNumber | ( | const TDesC & | aNumber | ) | [inline] |
Sets the phone number to be used by the filter.
const TDesC & aNumber | The phone number. |
void | SetRemoteParty | ( | const TDesC & | aRemote | ) | [inline] |
Sets the remote party string to be used by the filter.
const TDesC & aRemote | The remote party string. |
void | SetStartTime | ( | const TTime & | aStartTime | ) | [inline] |
Sets the specified UTC start time to be used by the filter.
const TTime & aStartTime | The UTC start time to be set. |
void | SetStatus | ( | const TDesC & | aStatus | ) | [inline] |
Sets the delivery status to be used by the filter.
const TDesC & aStatus | The delivery status. |
const TTime & | StartTime | ( | ) | const [inline] |
Gets the UTC start time used by the filter.
The UTC start time.
const TDesC & | Status | ( | ) | const [inline] |
Gets the delivery status used by the filter.
A non-modifiable descriptor containing the delivery status.