Symbian^3 Application Developer Library >

CStifLogger Class Reference

class CStifLogger : public CBase

Inherits from

Public Member Functions
CStifLogger ()
~CStifLogger ()
IMPORT_C TInt CreationResult ()
IMPORT_C TInt Log (const TDesC &)
IMPORT_C TInt Log (const TDesC8 &)
IMPORT_C TInt Log ( TInt , const TDesC &)
IMPORT_C TInt Log ( TInt , const TDesC8 &)
IMPORT_C TInt Log ( TRefByValue < const TDesC >, ...)
IMPORT_C TInt Log ( TRefByValue < const TDesC8 >, ...)
IMPORT_C TInt Log ( TInt , TRefByValue < const TDesC >, ...)
IMPORT_C TInt Log ( TInt , TRefByValue < const TDesC8 >, ...)
TInt Log (const TLitC < S > &)
TInt Log (const TLitC8 < S > &)
TInt Log ( TInt , const TLitC < S > &)
TInt Log ( TInt , const TLitC8 < S > &)
IMPORT_C CStifLogger * NewL (const TDesC &, const TDesC &, TLoggerType , TOutput , TBool , TBool , TBool , TBool , TBool , TBool , TInt , TBool )
IMPORT_C TOutput OutputType ()
IMPORT_C TInt SaveData ( TDesC &)
IMPORT_C TInt SaveData ( TDesC8 &)
TInt Send ( TInt , const TDesC &)
TInt Send ( TInt , const TDesC8 &)
IMPORT_C TInt WriteDelimiter (const TDesC &, TInt )
IMPORT_C TInt WriteDelimiter (const TDesC8 &, TInt )
Protected Member Functions
IMPORT_C CStifLogger * NewL (const TDesC &, const TDesC &, TLoggerSettings &)
void OverwriteLoggerSettings ( TLoggerSettings &, TName &, TName &, TLoggerType &, TOutput &, TBool &, TBool &, TBool &, TBool &, TBool &, TBool &, TBool &)
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()
Public Member Enumerations
enum TLoggerType { ETxt , EData , EHtml }
enum TOutput { EFile , ERDebug }
enum TStyle {
ENoStyle  = 0x00000, EBold  = 0x00001, ECursive  = 0x00002, EUnderline  = 0x00004, EBlue  = 0x00008, EGreen  = 0x00010, ERed  = 0x00020, EImportant  = 0x00040, EWarning  = 0x00080, EError  = 0x00100
}
Protected Attributes
COutput * iOutput

Constructor & Destructor Documentation

CStifLogger()

CStifLogger ( )

C++ default constructor.

~CStifLogger()

~CStifLogger ( ) [virtual]

Destructor.

Member Functions Documentation

CreationResult()

IMPORT_C TInt CreationResult ( )

Get creation result.

Log(const TDesC &)

IMPORT_C TInt Log ( const TDesC & aLogInfo )

Log a 16 bit information to some storage e.g. text file.

Parameters

const TDesC & aLogInfo

Log(const TDesC8 &)

IMPORT_C TInt Log ( const TDesC8 & aLogInfo )

Log a 8 bit information to some storage e.g. text file.

Parameters

const TDesC8 & aLogInfo

Log(TInt, const TDesC &)

IMPORT_C TInt Log ( TInt aStyle,
const TDesC & aLogInfo
)

Log a 16 bit information to some storage e.g. text file. There is also parameter to styling text information e.g. text color.

Parameters

TInt aStyle
const TDesC & aLogInfo

Log(TInt, const TDesC8 &)

IMPORT_C TInt Log ( TInt aStyle,
const TDesC8 & aLogInfo
)

Log a 8 bit information to some storage e.g. text file. There is also parameter to styling text information e.g. text color.

Parameters

TInt aStyle
const TDesC8 & aLogInfo

Log(TRefByValue< const TDesC >, ...)

IMPORT_C TInt Log ( TRefByValue < const TDesC > aLogInfo,
...
)

Log a 16 bit information to some storage e.g. text file. In this log method may set several parameters.

Parameters

TRefByValue < const TDesC > aLogInfo
...

Log(TRefByValue< const TDesC8 >, ...)

IMPORT_C TInt Log ( TRefByValue < const TDesC8 > aLogInfo,
...
)

Log a 8 bit information to some storage e.g. text file. In this log method may set several parameters.

Parameters

TRefByValue < const TDesC8 > aLogInfo
...

Log(TInt, TRefByValue< const TDesC >, ...)

IMPORT_C TInt Log ( TInt aStyle,
TRefByValue < const TDesC > aLogInfo,
...
)

Log a 16 bit information to some storage e.g. text file. There is also parameter to styling text information e.g. text color.

Parameters

TInt aStyle
TRefByValue < const TDesC > aLogInfo
...

Log(TInt, TRefByValue< const TDesC8 >, ...)

IMPORT_C TInt Log ( TInt aStyle,
TRefByValue < const TDesC8 > aLogInfo,
...
)

Log a 8 bit information to some storage e.g. text file. There is also parameter to styling text information e.g. text color.

Parameters

TInt aStyle
TRefByValue < const TDesC8 > aLogInfo
...

Log(const TLitC< S > &)

TInt Log ( const TLitC < S > & aLogInfo ) [inline]

Log 16 bit _LIT information to some storage e.g. text file.

Parameters

const TLitC < S > & aLogInfo

Log(const TLitC8< S > &)

TInt Log ( const TLitC8 < S > & aLogInfo ) [inline]

Log 8 bit _LIT information to some storage e.g. text file.

Parameters

const TLitC8 < S > & aLogInfo

Log(TInt, const TLitC< S > &)

TInt Log ( TInt aStyle,
const TLitC < S > & aLogInfo
) [inline]

Log 16 bit _LIT information to some storage e.g. text file. There is also parameter to styling text information e.g. text color.

Parameters

TInt aStyle
const TLitC < S > & aLogInfo

Log(TInt, const TLitC8< S > &)

TInt Log ( TInt aStyle,
const TLitC8 < S > & aLogInfo
) [inline]

Log 8 bit _LIT information to some storage e.g. text file. There is also parameter to styling text information e.g. text color.

Parameters

TInt aStyle
const TLitC8 < S > & aLogInfo

NewL(const TDesC &, const TDesC &, TLoggerType, TOutput, TBool, TBool, TBool, TBool, TBool, TBool, TInt, TBool)

IMPORT_C CStifLogger * NewL ( const TDesC & aTestPath,
const TDesC & aTestFile,
TLoggerType aLoggerType = ETxt,
TOutput aOutput = EFile,
TBool aOverWrite = ETrue,
TBool aWithTimeStamp = ETrue,
TBool aWithLineBreak = ETrue,
TBool aWithEventRanking = EFalse,
TBool aThreadIdToLogFile = ETrue,
TBool aCreateLogDir = EFalse,
TInt aStaticBufferSize = 0,
TBool aUnicode = EFalse
) [static]

Two-phased constructor.

Parameters

const TDesC & aTestPath
const TDesC & aTestFile
TLoggerType aLoggerType = ETxt
TOutput aOutput = EFile
TBool aOverWrite = ETrue
TBool aWithTimeStamp = ETrue
TBool aWithLineBreak = ETrue
TBool aWithEventRanking = EFalse
TBool aThreadIdToLogFile = ETrue
TBool aCreateLogDir = EFalse
TInt aStaticBufferSize = 0
TBool aUnicode = EFalse

NewL(const TDesC &, const TDesC &, TLoggerSettings &)

IMPORT_C CStifLogger * NewL ( const TDesC & aTestPath,
const TDesC & aTestFile,
TLoggerSettings & aLoggerSettings
) [protected, static]

Two-phased constructor. TestEngine's and TestServer's are friend. For TestEngine's and TestServer's StifLogger creation.

Parameters

const TDesC & aTestPath
const TDesC & aTestFile
TLoggerSettings & aLoggerSettings

OutputType()

IMPORT_C TOutput OutputType ( )

Get output type. Valid only if CreationResult returns KErrNone.

OverwriteLoggerSettings(TLoggerSettings &, TName &, TName &, TLoggerType &, TOutput &, TBool &, TBool &, TBool &, TBool &, TBool &, TBool &, TBool &)

void OverwriteLoggerSettings ( TLoggerSettings & aLoggerSettings,
TName & aTestPath,
TName & aTestFile,
TLoggerType & aLoggerType,
TOutput & aOutput,
TBool & aOverWrite,
TBool & aWithTimeStamp,
TBool & aWithLineBreak,
TBool & aWithEventRanking,
TBool & aThreadIdToLogFile,
TBool & aCreateLogDir,
TBool & aUnicode
) [protected, static]

Local CStifLogger's method for StifLogger settings overwriting.

Parameters

TLoggerSettings & aLoggerSettings
TName & aTestPath
TName & aTestFile
TLoggerType & aLoggerType
TOutput & aOutput
TBool & aOverWrite
TBool & aWithTimeStamp
TBool & aWithLineBreak
TBool & aWithEventRanking
TBool & aThreadIdToLogFile
TBool & aCreateLogDir
TBool & aUnicode

SaveData(TDesC &)

IMPORT_C TInt SaveData ( TDesC & aData )

Used when is need to save file or data to storage e.g. web page. 16 bit.

Parameters

TDesC & aData

SaveData(TDesC8 &)

IMPORT_C TInt SaveData ( TDesC8 & aData )

Used when is need to save file or data to storage e.g. web page. 8 bit.

Parameters

TDesC8 & aData

Send(TInt, const TDesC &)

TInt Send ( TInt ,
const TDesC &
) [pure virtual]

Pure virtual. Send style information and data to the output module. 16 bit.

Parameters

TInt
const TDesC &

Send(TInt, const TDesC8 &)

TInt Send ( TInt ,
const TDesC8 &
) [pure virtual]

Pure virtual. Send style information and data to the output module. 8 bit.

Parameters

TInt
const TDesC8 &

WriteDelimiter(const TDesC &, TInt)

IMPORT_C TInt WriteDelimiter ( const TDesC & aDelimiter = ( TPtrC ((const TText *) L"#")),
TInt aCount = 60
)

Log a 16 bit delimiter. Default char is '#' and default repeat count is 60. This will be used if parameters are not given when calling this method.

Parameters

const TDesC & aDelimiter = ( TPtrC ((const TText *) L"#"))
TInt aCount = 60

WriteDelimiter(const TDesC8 &, TInt)

IMPORT_C TInt WriteDelimiter ( const TDesC8 & aDelimiter,
TInt aCount
)

Log a 8 bit delimiter. 8 bit delimiter includes no default values. Delimiter may be '#' or 'XO' etc.

Parameters

const TDesC8 & aDelimiter
TInt aCount

Member Enumerations Documentation

Enum TLoggerType

Enumerators

ETxt
EData
EHtml

Enum TOutput

Enumerators

EFile
ERDebug

Enum TStyle

Enumerators

ENoStyle = 0x00000
EBold = 0x00001
ECursive = 0x00002
EUnderline = 0x00004
EBlue = 0x00008
EGreen = 0x00010
ERed = 0x00020
EImportant = 0x00040
EWarning = 0x00080
EError = 0x00100

Member Data Documentation

COutput * iOutput

COutput * iOutput [protected]

Output object.

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.