1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/inc/StateAccessor.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,76 @@
     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 MStateAccessor
    1.18 +// 
    1.19 +//
    1.20 +
    1.21 +/**
    1.22 + @test
    1.23 +*/
    1.24 +
    1.25 +#ifndef __STATEACCESSOR_H__
    1.26 +#define __STATEACCESSOR_H__
    1.27 +
    1.28 +#include <e32base.h>
    1.29 +
    1.30 +/**
    1.31 +	@internalAll	
    1.32 +	Comments : Mixin which is used to define a class used for state checking of 
    1.33 +	a test object.
    1.34 + */
    1.35 +
    1.36 +class MStateAccessor
    1.37 +	{
    1.38 +public:
    1.39 +/**
    1.40 +	@fn				InvariantTest(TAny* aTestObject) = 0
    1.41 +	Intended Usage	:	Override this in the derived class to implement 
    1.42 +						invariant testing
    1.43 +	@since			7.0
    1.44 +	@param			aTestObject The object to be tested
    1.45 +	@return			One of the EPOC standard error codes indicating the result of the test
    1.46 +	@pre 			A valid test object must be passed in
    1.47 +	@post			Returns an error code dependant on the result of the test
    1.48 + */
    1.49 +	
    1.50 +	virtual TInt InvariantTest(TAny* aTestObject) = 0;
    1.51 +/**
    1.52 +	@fn				Internalize(TAny* aTestObject) = 0
    1.53 +	Intended Usage	:	Override this in the derived class to implement 
    1.54 +						object state loading.
    1.55 +	@since			7.0
    1.56 +	@param			aTestObject The object to be tested
    1.57 +	@return			One of the EPOC standard error codes indicating the outcome of the attempt
    1.58 +	to load the object state.
    1.59 +	@pre 			A valid test object must be passed in
    1.60 +	@post			Returns an error code dependant on the result of the test
    1.61 + */
    1.62 +	
    1.63 +	virtual TInt Internalize(TAny* aTestObject) = 0;
    1.64 +/**
    1.65 +	@fn				Externalize(TAny* aTestObject) = 0
    1.66 +	Intended Usage	:	Override this in the derived class to implement 
    1.67 +						object state persistence.
    1.68 +	@since			7.0
    1.69 +	@param			aTestObject The object to be tested
    1.70 +	@return			One of the EPOC standard error codes indicating the outcome of attempt
    1.71 +	to externalize the object.
    1.72 +	@pre 			A valid test object must be passed in
    1.73 +	@post			Returns an error code dependant on the result of the test
    1.74 + */
    1.75 +	
    1.76 +	virtual TInt Externalize(TAny* aTestObject) = 0;
    1.77 +	};
    1.78 +
    1.79 +#endif