1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/inc/DefaultLogOutput.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,100 @@
     1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// This file contains the definition of the class CDefaultLogOutput
    1.18 +// This file comment is for DOxygen only and is ignored by EDoc.
    1.19 +// 
    1.20 +//
    1.21 +
    1.22 +/**
    1.23 + @test
    1.24 +*/
    1.25 +
    1.26 +#ifndef __DEFAULTLOGOUTPUT_H__
    1.27 +#define __DEFAULTLOGOUTPUT_H__
    1.28 +
    1.29 +#include <e32base.h>
    1.30 +#include <flogger.h>
    1.31 +
    1.32 +#include <ecom/test_bed/dataformat.h>
    1.33 +
    1.34 +/**
    1.35 +	@internalAll
    1.36 +	Comments : Default implementation of the MLogOutput interface.  This will be used
    1.37 +	if an alternative is not supplied at construction of the CTestController.
    1.38 + */
    1.39 +
    1.40 +NONSHARABLE_CLASS(CDefaultLogOutput) : public CBase, public MLogOutput
    1.41 +	{
    1.42 +public:
    1.43 +/**
    1.44 +	@fn				CDefaultLogOutput(const TDesC& aTitle)
    1.45 +	Intended Usage	:	Standard constructor
    1.46 +	@leave  		KErrNoMemory
    1.47 +	@since			7.0
    1.48 +	@param			aTitle The title to be used in the log
    1.49 + */
    1.50 +	
    1.51 +	explicit CDefaultLogOutput(const TDesC& aTitle);
    1.52 +
    1.53 +/**
    1.54 +	@fn				~CDefaultLogOutput()
    1.55 +	Intended Usage	:	Standard destructor
    1.56 +	@since			7.0
    1.57 + */
    1.58 +	
    1.59 +	~CDefaultLogOutput();
    1.60 +
    1.61 +/**
    1.62 +	@fn				TInt OpenL()
    1.63 +	Intended Usage	:	Opens the RFileLogger ready for logging
    1.64 +	Error Condition	:	Fails to connect to RFileLogger
    1.65 +	@leave  		@see RFileLogger::Connect()
    1.66 +	@since			7.0
    1.67 +	@pre 			This object is fully constructed
    1.68 +	@post			RFileLogger is opened and ready for logging
    1.69 + */
    1.70 +	
    1.71 +	void OpenL();
    1.72 +
    1.73 +/**
    1.74 +	@fn				void Write(const TDesC& aOutput)
    1.75 +	Intended Usage	:	Outputs the specified message to RFileLogger
    1.76 +	@since			7.0
    1.77 +	@param			aOutput The descriptor to be logged
    1.78 +	@pre 			OpenL has previously been called
    1.79 +	@post			The descriptor has been written to RFileLogger
    1.80 + */
    1.81 +	
    1.82 +	void Write(const TDesC& aOutput);
    1.83 +
    1.84 +/**
    1.85 +	@fn				void Close()
    1.86 +	Intended Usage	:	Closes RFileLogger when logging has completed
    1.87 +	@since			7.0
    1.88 +	@pre 			OpenL has previously been called
    1.89 +	@post			RFileLogger has been closed and this object can be deleted
    1.90 + */
    1.91 +	
    1.92 +	void Close();
    1.93 +
    1.94 +protected:
    1.95 +/** The title which is output to the log file */
    1.96 +	
    1.97 +	const TDesC&	iTitle;
    1.98 +/** Handle to the file logging mechanism for outputting messages */
    1.99 +	
   1.100 +	RFileLogger		iFLogger;
   1.101 +	};
   1.102 +
   1.103 +#endif	// __DEFAULTLOGOUTPUT_H__