os/ossrv/lowlevellibsandfws/pluginfw/Framework/LoadManagerTest/LoadManagerStateAccessor.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/LoadManagerTest/LoadManagerStateAccessor.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,140 @@
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 +// The state accessor class definitionss for the CLoadManager class
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __LOADMANAGERSTATEACCESSOR_H__
1.22 +#define __LOADMANAGERSTATEACCESSOR_H__
1.23 +
1.24 +#include <e32base.h>
1.25 +#include <f32file.h>
1.26 +#include <s32stor.h>
1.27 +#include <s32file.h>
1.28 +
1.29 +#include "TestUtilities.h"
1.30 +#include <ecom/test_bed/testbeddefinitions.h>
1.31 +#include "StateAccessor.h"
1.32 +#include "LoadManager.h"
1.33 +
1.34 +const TUid KUniqueDllUid = {0x10009DB1};
1.35 +const TUid KUniqueImplementationUid_Works = {0x10009DC3};
1.36 +const TUid KUniqueImplementationUid_Fails = {0x10009DC1};
1.37 +
1.38 +// ______________________________________________________________________________
1.39 +//
1.40 +/**
1.41 + @internalComponent
1.42 + Comments : State accessor for the CLoadManager object under test.
1.43 + */
1.44 +class TLoadManager_StateAccessor : public MStateAccessor
1.45 + {
1.46 +public:
1.47 + /**
1.48 + @fn InvariantTest(TAny* aTestObject)
1.49 + Intended Usage : Checks that CLoadManager has not violated its invariants.
1.50 + @since 7.0
1.51 + @param TAny* A pointer to the object under test.
1.52 + @return TInt KErrNone if the invariants were valid, error code otherwise.
1.53 + @pre TLoadManager_StateAccessor is fully constructed.
1.54 + @post The class under test is set to the state specified.
1.55 + */
1.56 + inline TInt InvariantTest(TAny* aTestObject);
1.57 +
1.58 + /**
1.59 + @fn Internalize(TAny* aTestObject)
1.60 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.61 + @since 7.0
1.62 + @param aTestObject The object to be tested
1.63 + @return KErrNone if the internalize was successful.
1.64 + @return One of the EPOC standard error codes indicating the reason
1.65 + for the failure to load the object state.
1.66 + @pre TLoadManager_StateAccessor is fully constructed, and
1.67 + valid test object must be passed in.
1.68 + @post The class under test is set to the state specified
1.69 + */
1.70 + inline virtual TInt Internalize(TAny* aTestObject);
1.71 +
1.72 + /**
1.73 + @fn Externalize(TAny* aTestObject)
1.74 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.75 + @since 7.0
1.76 + @param aTestObject The object to be tested
1.77 + @return KErrNone if the internalize was successful.
1.78 + @return One of the EPOC standard error codes indicating the reason
1.79 + for the failure to externalize the object.
1.80 + @pre TLoadManager_StateAccessor is fully constructed, and
1.81 + valid test object must be passed in.
1.82 + @post Returns an error code dependant on the result of the test
1.83 + */
1.84 + inline virtual TInt Externalize(TAny* aTestObject);
1.85 +
1.86 + /**
1.87 + @fn InternalizeL(RFileReadStream& aStream, CLoadManager* aLoadManager)
1.88 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.89 + Error Condition : Leaves with an error code.
1.90 + @since 7.0
1.91 + @param aStream The filestram to read from .
1.92 + @param aLoadManager A pointer to the CLoadManager object under test.
1.93 + @return None.
1.94 + @pre TLoadManager_StateAccessor is fully constructed.
1.95 + @post The class under test is set to the state specified.
1.96 + */
1.97 + inline void InternalizeL(RFileReadStream& aStream, CLoadManager* aLoadManager);
1.98 +
1.99 + /**
1.100 + @fn ExternalizeL(RFileWriteStream& aStream, CLoadManager* aLoadManager)
1.101 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.102 + Error Condition : Leaves with an error code.
1.103 + @since 7.0
1.104 + @param aStream The filestream to persist into.
1.105 + @param aLoadManager A pointer to the CLoadManager object under test.
1.106 + @return None.
1.107 + @pre TLoadManager_StateAccessor is fully constructed.
1.108 + @post No change to the class under test, its internal state.
1.109 + is persisted.
1.110 + */
1.111 + inline void ExternalizeL(RFileWriteStream& aStream, CLoadManager* aLoadManager);
1.112 +
1.113 +private:
1.114 + /**
1.115 + @fn InternalizeL(CLoadManager* aLoadManager)
1.116 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.117 + Error Condition : Leaves with an error code.
1.118 + @since 7.0
1.119 + @param aLoadManager A pointer to the CLoadManager object under test.
1.120 + @return None.
1.121 + @pre TLoadManager_StateAccessor is fully constructed.
1.122 + @post The class under test is set to the state specified.
1.123 + */
1.124 + inline void InternalizeL(CLoadManager* aLoadManager);
1.125 +
1.126 + /**
1.127 + @fn ExternalizeL(CLoadManager* aLoadManager)
1.128 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.129 + Error Condition : Leaves with an error code.
1.130 + @since 7.0
1.131 + @param aLoadManager A pointer to the CLoadManager object under test.
1.132 + @return None.
1.133 + @pre TLoadManager_StateAccessor is fully constructed.
1.134 + @post No change to the class under test, its internal state.
1.135 + is persisted.
1.136 + */
1.137 + inline void ExternalizeL(CLoadManager* aLoadManager);
1.138 + }; // TLoadManager_StateAccessor
1.139 +
1.140 +
1.141 +#include "LoadManagerStateAccessor.inl"
1.142 +
1.143 +#endif // __LOADMANAGERSTATEACCESSOR_H__