|
sl@0
|
1 |
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// This file contains the definition of the class CDefaultLogOutput
|
|
sl@0
|
15 |
// This file comment is for DOxygen only and is ignored by EDoc.
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
//
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
/**
|
|
sl@0
|
20 |
@test
|
|
sl@0
|
21 |
*/
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#ifndef __DEFAULTLOGOUTPUT_H__
|
|
sl@0
|
24 |
#define __DEFAULTLOGOUTPUT_H__
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
#include <e32base.h>
|
|
sl@0
|
27 |
#include <flogger.h>
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
#include <ecom/test_bed/dataformat.h>
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
/**
|
|
sl@0
|
32 |
@internalAll
|
|
sl@0
|
33 |
Comments : Default implementation of the MLogOutput interface. This will be used
|
|
sl@0
|
34 |
if an alternative is not supplied at construction of the CTestController.
|
|
sl@0
|
35 |
*/
|
|
sl@0
|
36 |
|
|
sl@0
|
37 |
NONSHARABLE_CLASS(CDefaultLogOutput) : public CBase, public MLogOutput
|
|
sl@0
|
38 |
{
|
|
sl@0
|
39 |
public:
|
|
sl@0
|
40 |
/**
|
|
sl@0
|
41 |
@fn CDefaultLogOutput(const TDesC& aTitle)
|
|
sl@0
|
42 |
Intended Usage : Standard constructor
|
|
sl@0
|
43 |
@leave KErrNoMemory
|
|
sl@0
|
44 |
@since 7.0
|
|
sl@0
|
45 |
@param aTitle The title to be used in the log
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
|
|
sl@0
|
48 |
explicit CDefaultLogOutput(const TDesC& aTitle);
|
|
sl@0
|
49 |
|
|
sl@0
|
50 |
/**
|
|
sl@0
|
51 |
@fn ~CDefaultLogOutput()
|
|
sl@0
|
52 |
Intended Usage : Standard destructor
|
|
sl@0
|
53 |
@since 7.0
|
|
sl@0
|
54 |
*/
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
~CDefaultLogOutput();
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
@fn TInt OpenL()
|
|
sl@0
|
60 |
Intended Usage : Opens the RFileLogger ready for logging
|
|
sl@0
|
61 |
Error Condition : Fails to connect to RFileLogger
|
|
sl@0
|
62 |
@leave @see RFileLogger::Connect()
|
|
sl@0
|
63 |
@since 7.0
|
|
sl@0
|
64 |
@pre This object is fully constructed
|
|
sl@0
|
65 |
@post RFileLogger is opened and ready for logging
|
|
sl@0
|
66 |
*/
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
void OpenL();
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
/**
|
|
sl@0
|
71 |
@fn void Write(const TDesC& aOutput)
|
|
sl@0
|
72 |
Intended Usage : Outputs the specified message to RFileLogger
|
|
sl@0
|
73 |
@since 7.0
|
|
sl@0
|
74 |
@param aOutput The descriptor to be logged
|
|
sl@0
|
75 |
@pre OpenL has previously been called
|
|
sl@0
|
76 |
@post The descriptor has been written to RFileLogger
|
|
sl@0
|
77 |
*/
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
void Write(const TDesC& aOutput);
|
|
sl@0
|
80 |
|
|
sl@0
|
81 |
/**
|
|
sl@0
|
82 |
@fn void Close()
|
|
sl@0
|
83 |
Intended Usage : Closes RFileLogger when logging has completed
|
|
sl@0
|
84 |
@since 7.0
|
|
sl@0
|
85 |
@pre OpenL has previously been called
|
|
sl@0
|
86 |
@post RFileLogger has been closed and this object can be deleted
|
|
sl@0
|
87 |
*/
|
|
sl@0
|
88 |
|
|
sl@0
|
89 |
void Close();
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
protected:
|
|
sl@0
|
92 |
/** The title which is output to the log file */
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
const TDesC& iTitle;
|
|
sl@0
|
95 |
/** Handle to the file logging mechanism for outputting messages */
|
|
sl@0
|
96 |
|
|
sl@0
|
97 |
RFileLogger iFLogger;
|
|
sl@0
|
98 |
};
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
#endif // __DEFAULTLOGOUTPUT_H__
|