1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 #ifndef __MDRIVEROBSERVER_H__

    17 #define __MDRIVEROBSERVER_H__

    18 

    19 #include <e32std.h>

    20 

    21 /**	@class		MDriverObserver

    22 	The MDriverObserver class is the observer for the driver objects. It allows

    23 	the drivers to notify the observer of when a test starts, an error occurs 

    24 	and when a test completes. Also provides a logging mechanism.

    25 	@componentInternal

    26 	@see		CDriverBase

    27 */

    28 class MDriverObserver

    29 	{

    30 public:	// methods

    31 

    32 /**	@fn			NotifyError(TInt aError) =0

    33 	Notifies the observer that an error has occured.

    34 	@componentInternal

    35 	@param		aError	The error code that has occured.

    36 */

    37 	virtual void NotifyError(TInt aError) =0;

    38 

    39 /**	@fn			NotifyStart() =0

    40 	Notifies the observer that the test has started.

    41 	@componentInternal

    42 */

    43 	virtual void NotifyStart() =0;

    44 

    45 /**	@fn			NotifyComplete() =0

    46 	Notifies the observer that the test has completed.

    47 	@componentInternal

    48 */

    49 	virtual void NotifyComplete() =0;

    50 

    51 /** @fn			Log(const TDesC& aComment) =0

    52 	Logs comment to log file, but not the summary file.

    53 	@componentInternal

    54 	@param		aComment	The comment to be logged.

    55 */

    56 	virtual void Log(const TDesC& aComment) =0;

    57 

    58 /**	@fn			Dump(const TDesC8& aData) =0

    59 	Dumps binary data to log file, but not the summary file.

    60 	@componentInternal

    61 	@param		aData	The data to be dumped.

    62 */

    63 	virtual void Dump(const TDesC8& aData) =0;

    64 

    65 	};

    66 

    67 #endif	// __MDRIVEROBSERVER_H__