Symbian^3 Application Developer Library >

CLbsLogEvent Class Reference

class CLbsLogEvent : public CBase

Base class for the classes representing LBS events to be logged. It provides the common functionality (internalising, externalising, updating this class from another one and creating a copy of this class).

Inherits from

Public Member Functions
~CLbsLogEvent ()
CLbsLogEvent * CopyL ()
IMPORT_C TUint CostInformation ()
IMPORT_C TBool Direction ()
IMPORT_C TUid EventType ()
IMPORT_C CLogEvent * ExternalizeL ()
IMPORT_C TBool IsCostInformationAvailable ()
IMPORT_C CLbsLogEvent * NewL (const CLogEvent &)
IMPORT_C TPositionInfoBase * PositionInfo ()
IMPORT_C TLbsRequestOutcome RequestOutcome ()
IMPORT_C void SetCostInformation ( TUint )
IMPORT_C void SetDirection ( TBool )
IMPORT_C void SetEventType ( TUid )
IMPORT_C void SetPositionInfo ( TPositionInfoBase *)
IMPORT_C void SetRequestOutcome ( TLbsRequestOutcome )
void UpdateL (const CLbsLogEvent &)
void UpdateRootEvent ( CLogEvent *)
Protected Member Functions
CLbsLogEvent ()
void BaseConstructL ()
TPositionInfo * CopyPosInfoToEvent (const TPositionInfoBase *)
TInt DataSize ()
void DoCopyL ( CLbsLogEvent *&)
void DoExternalizeL ( RWriteStream &)
void DoInternalizeL ( RReadStream &)
void DoUpdateL (const CLbsLogEvent &)
void InternalizeL (const CLogEvent &)
void ReadPosInfo ( RReadStream &, TPositionInfo *&)
void WritePosInfo ( RWriteStream &, const TPositionInfo *)
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()
Protected Attributes
TUid iEventType
TPositionInfo * iPosInfo
const TInt iPosInfoWriteSize
TAny * iReservedData
Private Attributes
TUint iCostInformation
TBool iCostInformationAvailable
TBool iDirection
TLbsRequestOutcome iRequestOutcome

Constructor & Destructor Documentation

CLbsLogEvent()

CLbsLogEvent ( ) [protected]

C++ constructor

~CLbsLogEvent()

~CLbsLogEvent ( ) [virtual]

C++ destructor

Member Functions Documentation

BaseConstructL()

void BaseConstructL ( ) [protected]

The 2nd phase constructor for the base class, gets called from derived classes This function will produce an unique queue ID within the queue for each event, it will be reset once the log engine is reset.

CopyL()

CLbsLogEvent * CopyL ( ) const

Creates a new instance of CLbsLogEvent which will the a copy of the current one

CopyPosInfoToEvent(const TPositionInfoBase *)

TPositionInfo * CopyPosInfoToEvent ( const TPositionInfoBase * aSrcosInfo ) [protected]

Copy PositionInfo class for different supported types

Parameters

const TPositionInfoBase * aSrcosInfo provided source TPositionInfoBase* pointer

CostInformation()

IMPORT_C TUint CostInformation ( ) const

get the lbs service cost info

DataSize()

TInt DataSize ( ) const [protected, pure virtual]

Direction()

IMPORT_C TBool Direction ( ) const

get the direction for logging event (incoming or outgoing calls)

DoCopyL(CLbsLogEvent *&)

void DoCopyL ( CLbsLogEvent *& aTargetLogEvent ) const [protected, pure virtual]

Parameters

CLbsLogEvent *& aTargetLogEvent

DoExternalizeL(RWriteStream &)

void DoExternalizeL ( RWriteStream & aReadStream ) const [protected, pure virtual]

Parameters

RWriteStream & aReadStream

DoInternalizeL(RReadStream &)

void DoInternalizeL ( RReadStream & aReadStream ) [protected, pure virtual]

Parameters

RReadStream & aReadStream

DoUpdateL(const CLbsLogEvent &)

void DoUpdateL ( const CLbsLogEvent & aSourceLogEvent ) [protected, pure virtual]

Parameters

const CLbsLogEvent & aSourceLogEvent

EventType()

IMPORT_C TUid EventType ( ) const

get the logging event type

ExternalizeL()

IMPORT_C CLogEvent * ExternalizeL ( ) const

Externalises this object into a CLogEvent object so it can be passed on to the LogEng.

InternalizeL(const CLogEvent &)

void InternalizeL ( const CLogEvent & aLogEvent ) [protected]

Internalises into this class from CLogEvent

Parameters

const CLogEvent & aLogEvent The class to internalise from

IsCostInformationAvailable()

IMPORT_C TBool IsCostInformationAvailable ( ) const

set the lbs service cost flag

NewL(const CLogEvent &)

IMPORT_C CLbsLogEvent * NewL ( const CLogEvent & aLogEvent ) [static]

This method should be used to retrieve an existing logged event from Log Engine, CLogEvent parameter should be a valid logging event object. This function will internalise this logged event into the approprite LBS Location Requestion Logging class.

This method should NOT be used within LBS Sub-system, if otherwise, it should be trapped.

Parameters

const CLogEvent & aLogEvent The event that was logged

PositionInfo()

IMPORT_C TPositionInfoBase * PositionInfo ( ) const

get the TPositonInfo data

ReadPosInfo(RReadStream &, TPositionInfo *&)

void ReadPosInfo ( RReadStream & aReadStream,
TPositionInfo *& aPosInfo
) [protected]

Parameters

RReadStream & aReadStream
TPositionInfo *& aPosInfo

RequestOutcome()

IMPORT_C TLbsRequestOutcome RequestOutcome ( ) const

get the lbs service request outcome

SetCostInformation(TUint)

IMPORT_C void SetCostInformation ( TUint aCostInformation )

set the lbs service cost info

Parameters

TUint aCostInformation

SetDirection(TBool)

IMPORT_C void SetDirection ( TBool aDirection )

set the direction for logging event (incoming or outgoing calls)

Parameters

TBool aDirection

SetEventType(TUid)

IMPORT_C void SetEventType ( TUid aId )

set the logging event type

Parameters

TUid aId

SetPositionInfo(TPositionInfoBase *)

IMPORT_C void SetPositionInfo ( TPositionInfoBase * aPosInfo )

Copy PositionInfo class for different supported types

Parameters

TPositionInfoBase * aPosInfo provided source TPositionInfoBase* pointer

SetRequestOutcome(TLbsRequestOutcome)

IMPORT_C void SetRequestOutcome ( TLbsRequestOutcome aRequestOutcome )

set the lbs service request outcome

Parameters

TLbsRequestOutcome aRequestOutcome

UpdateL(const CLbsLogEvent &)

void UpdateL ( const CLbsLogEvent & aLogEvent )

Updates this class with information provided

leave
KErrArgument If what is passed in has a different type than type of this instance

Parameters

const CLbsLogEvent & aLogEvent The information that was provided

UpdateRootEvent(CLogEvent *)

void UpdateRootEvent ( CLogEvent * aTargetEvent )

Update the CLogEvent object by the property within this CLbsLogEvent

Parameters

CLogEvent * aTargetEvent The class to be updated

WritePosInfo(RWriteStream &, const TPositionInfo *)

void WritePosInfo ( RWriteStream & aWriteStream,
const TPositionInfo * aPosInfo
) const [protected]

Parameters

RWriteStream & aWriteStream
const TPositionInfo * aPosInfo

Member Data Documentation

TUint iCostInformation

TUint iCostInformation [private]

The cost information

TBool iCostInformationAvailable

TBool iCostInformationAvailable [private]

Flag which specifies if the cost information is available or not

TBool iDirection

TBool iDirection [private]

MO-LR (True) to R_LOG_DIR_OUT and MT-LR to R_LOG_DIR_IN

TUid iEventType

TUid iEventType [protected]

The Location Request Event Type

TPositionInfo * iPosInfo

TPositionInfo * iPosInfo [protected]

The returned location information if the request is completed successfully

const TInt iPosInfoWriteSize

const TInt iPosInfoWriteSize [protected]

The size of the data from a TPositionInfo that is written to disk

TLbsRequestOutcome iRequestOutcome

TLbsRequestOutcome iRequestOutcome [private]

The outcome of the request

TAny * iReservedData

TAny * iReservedData [protected]

Data for BC consideration, and inherited by derived CLbsLog classes

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.