|
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 MStateAccessor
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@test
|
|
sl@0
|
20 |
*/
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#ifndef __STATEACCESSOR_H__
|
|
sl@0
|
23 |
#define __STATEACCESSOR_H__
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#include <e32base.h>
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
@internalAll
|
|
sl@0
|
29 |
Comments : Mixin which is used to define a class used for state checking of
|
|
sl@0
|
30 |
a test object.
|
|
sl@0
|
31 |
*/
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
class MStateAccessor
|
|
sl@0
|
34 |
{
|
|
sl@0
|
35 |
public:
|
|
sl@0
|
36 |
/**
|
|
sl@0
|
37 |
@fn InvariantTest(TAny* aTestObject) = 0
|
|
sl@0
|
38 |
Intended Usage : Override this in the derived class to implement
|
|
sl@0
|
39 |
invariant testing
|
|
sl@0
|
40 |
@since 7.0
|
|
sl@0
|
41 |
@param aTestObject The object to be tested
|
|
sl@0
|
42 |
@return One of the EPOC standard error codes indicating the result of the test
|
|
sl@0
|
43 |
@pre A valid test object must be passed in
|
|
sl@0
|
44 |
@post Returns an error code dependant on the result of the test
|
|
sl@0
|
45 |
*/
|
|
sl@0
|
46 |
|
|
sl@0
|
47 |
virtual TInt InvariantTest(TAny* aTestObject) = 0;
|
|
sl@0
|
48 |
/**
|
|
sl@0
|
49 |
@fn Internalize(TAny* aTestObject) = 0
|
|
sl@0
|
50 |
Intended Usage : Override this in the derived class to implement
|
|
sl@0
|
51 |
object state loading.
|
|
sl@0
|
52 |
@since 7.0
|
|
sl@0
|
53 |
@param aTestObject The object to be tested
|
|
sl@0
|
54 |
@return One of the EPOC standard error codes indicating the outcome of the attempt
|
|
sl@0
|
55 |
to load the object state.
|
|
sl@0
|
56 |
@pre A valid test object must be passed in
|
|
sl@0
|
57 |
@post Returns an error code dependant on the result of the test
|
|
sl@0
|
58 |
*/
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
virtual TInt Internalize(TAny* aTestObject) = 0;
|
|
sl@0
|
61 |
/**
|
|
sl@0
|
62 |
@fn Externalize(TAny* aTestObject) = 0
|
|
sl@0
|
63 |
Intended Usage : Override this in the derived class to implement
|
|
sl@0
|
64 |
object state persistence.
|
|
sl@0
|
65 |
@since 7.0
|
|
sl@0
|
66 |
@param aTestObject The object to be tested
|
|
sl@0
|
67 |
@return One of the EPOC standard error codes indicating the outcome of attempt
|
|
sl@0
|
68 |
to externalize the object.
|
|
sl@0
|
69 |
@pre A valid test object must be passed in
|
|
sl@0
|
70 |
@post Returns an error code dependant on the result of the test
|
|
sl@0
|
71 |
*/
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
virtual TInt Externalize(TAny* aTestObject) = 0;
|
|
sl@0
|
74 |
};
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
#endif
|