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