sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // This file contains the definition of the class CDefaultLogOutput
sl@0: // This file comment is for DOxygen only and is ignored by EDoc.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @test
sl@0: */
sl@0: 
sl@0: #ifndef __DEFAULTLOGOUTPUT_H__
sl@0: #define __DEFAULTLOGOUTPUT_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <flogger.h>
sl@0: 
sl@0: #include <ecom/test_bed/dataformat.h>
sl@0: 
sl@0: /**
sl@0: 	@internalAll
sl@0: 	Comments : Default implementation of the MLogOutput interface.  This will be used
sl@0: 	if an alternative is not supplied at construction of the CTestController.
sl@0:  */
sl@0: 
sl@0: NONSHARABLE_CLASS(CDefaultLogOutput) : public CBase, public MLogOutput
sl@0: 	{
sl@0: public:
sl@0: /**
sl@0: 	@fn				CDefaultLogOutput(const TDesC& aTitle)
sl@0: 	Intended Usage	:	Standard constructor
sl@0: 	@leave  		KErrNoMemory
sl@0: 	@since			7.0
sl@0: 	@param			aTitle The title to be used in the log
sl@0:  */
sl@0: 	
sl@0: 	explicit CDefaultLogOutput(const TDesC& aTitle);
sl@0: 
sl@0: /**
sl@0: 	@fn				~CDefaultLogOutput()
sl@0: 	Intended Usage	:	Standard destructor
sl@0: 	@since			7.0
sl@0:  */
sl@0: 	
sl@0: 	~CDefaultLogOutput();
sl@0: 
sl@0: /**
sl@0: 	@fn				TInt OpenL()
sl@0: 	Intended Usage	:	Opens the RFileLogger ready for logging
sl@0: 	Error Condition	:	Fails to connect to RFileLogger
sl@0: 	@leave  		@see RFileLogger::Connect()
sl@0: 	@since			7.0
sl@0: 	@pre 			This object is fully constructed
sl@0: 	@post			RFileLogger is opened and ready for logging
sl@0:  */
sl@0: 	
sl@0: 	void OpenL();
sl@0: 
sl@0: /**
sl@0: 	@fn				void Write(const TDesC& aOutput)
sl@0: 	Intended Usage	:	Outputs the specified message to RFileLogger
sl@0: 	@since			7.0
sl@0: 	@param			aOutput The descriptor to be logged
sl@0: 	@pre 			OpenL has previously been called
sl@0: 	@post			The descriptor has been written to RFileLogger
sl@0:  */
sl@0: 	
sl@0: 	void Write(const TDesC& aOutput);
sl@0: 
sl@0: /**
sl@0: 	@fn				void Close()
sl@0: 	Intended Usage	:	Closes RFileLogger when logging has completed
sl@0: 	@since			7.0
sl@0: 	@pre 			OpenL has previously been called
sl@0: 	@post			RFileLogger has been closed and this object can be deleted
sl@0:  */
sl@0: 	
sl@0: 	void Close();
sl@0: 
sl@0: protected:
sl@0: /** The title which is output to the log file */
sl@0: 	
sl@0: 	const TDesC&	iTitle;
sl@0: /** Handle to the file logging mechanism for outputting messages */
sl@0: 	
sl@0: 	RFileLogger		iFLogger;
sl@0: 	};
sl@0: 
sl@0: #endif	// __DEFAULTLOGOUTPUT_H__