os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/TransitionTest/TransitionStateAccessor.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/TransitionTest/TransitionStateAccessor.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,210 @@
1.4 +// Copyright (c) 2001-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 CTransition
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __TRANSITIONSTATEACCESSOR_H__
1.22 +#define __TRANSITIONSTATEACCESSOR_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 <ecom/test_bed/transition.h>
1.33 +
1.34 +// ______________________________________________________________________________
1.35 +//
1.36 +/**
1.37 + @internalComponent
1.38 +
1.39 + Comments : State accessor for the CTransition object under test.
1.40 + */
1.41 +class TTransition_StateAccessor : public MStateAccessor
1.42 + {
1.43 +public:
1.44 + /**
1.45 + @fn InvariantTest(TAny* aTestObject)
1.46 + Intended Usage :
1.47 + @since 7.0
1.48 + @param TAny* A pointer to the object under test.
1.49 + @return TInt KErrNone if the invariants were valid, error code otherwise.
1.50 + @pre TTransition_StateAccessor is fully constructed.
1.51 + @post The class under test is set to the state specified.
1.52 + */
1.53 + inline TInt InvariantTest(TAny* aTestObject);
1.54 +
1.55 + /**
1.56 + @fn Internalize(TAny* aTestObject)
1.57 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.58 + @since 7.0
1.59 + @param aTestObject The object to be tested
1.60 + @return KErrNone if the internalize was successful.
1.61 + @return One of the EPOC standard error codes indicating the reason
1.62 + for the failure to load the object state.
1.63 + @pre TTransition_StateAccessor is fully constructed, and
1.64 + valid test object must be passed in.
1.65 + @post The class under test is set to the state specified
1.66 + */
1.67 + inline virtual TInt Internalize(TAny* aTestObject);
1.68 +
1.69 + /**
1.70 + @fn Externalize(TAny* aTestObject)
1.71 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.72 + @since 7.0
1.73 + @param aTestObject The object to be tested
1.74 + @return KErrNone if the internalize was successful.
1.75 + @return One of the EPOC standard error codes indicating the reason
1.76 + for the failure to externalize the object.
1.77 + @pre TTransition_StateAccessor is fully constructed, and
1.78 + valid test object must be passed in.
1.79 + @post Returns an error code dependant on the result of the test
1.80 + */
1.81 + inline virtual TInt Externalize(TAny* aTestObject);
1.82 +
1.83 + /**
1.84 + @fn IsRepeated(TAny* aTestObject) const
1.85 + Intended Usage : Implemented by the developer to access the iRepeatThis
1.86 + flag in the CTransition object under test.
1.87 + @since 7.0
1.88 + @param aTestObject The CTransition object to be tested
1.89 + @return ETrue if the flag is set.
1.90 + @pre TTransition_StateAccessor is fully constructed, and
1.91 + a valid test object must be passed in.
1.92 + */
1.93 + inline TBool IsRepeated(TAny* aTestObject) const;
1.94 +
1.95 + /**
1.96 + @fn TransitionId(TAny* aTestObject) const
1.97 + Intended Usage : Implemented by the developer to access the iTransitionId
1.98 + descriptor in the CTransition object under test.
1.99 + @since 7.0
1.100 + @param aTestObject The CTransition object to be tested
1.101 + @return A pointer to the iTransitionId descriptor.
1.102 + @pre TTransition_StateAccessor is fully constructed, and
1.103 + a valid test object must be passed in.
1.104 + */
1.105 + inline const TDesC* TransitionId(TAny* aTestObject) const;
1.106 +
1.107 + /**
1.108 + @fn TransitionInfo(TAny* aTestObject) const
1.109 + Intended Usage : Implemented by the developer to access the iTransitionId
1.110 + descriptor in the CTransition object under test.
1.111 + @since 7.0
1.112 + @param aTestObject The CTransition object to be tested
1.113 + @return A pointer to the iTransitionInfo structure.
1.114 + @pre TTransition_StateAccessor is fully constructed, and
1.115 + a valid test object must be passed in.
1.116 + */
1.117 + inline const TTransitionInfo* TransitionInfo(TAny* aTestObject) const;
1.118 +
1.119 + /**
1.120 + @fn BlockingFlag(TAny* aTestObject) const
1.121 + Intended Usage : Implemented by the developer to access the iBlockingTransition
1.122 + flag in the CTransition object under test.
1.123 + @since 7.0
1.124 + @param aTestObject The CTransition object to be tested
1.125 + @return ETrue if the flag is set.
1.126 + @pre TTransition_StateAccessor is fully constructed, and
1.127 + a valid test object must be passed in.
1.128 + */
1.129 + inline TBool BlockingFlag(TAny* aTestObject) const;
1.130 +
1.131 + /**
1.132 + @fn BlockingFlag(TAny* aTestObject) const
1.133 + Intended Usage : Implemented by the developer to access the iLeaveError
1.134 + flag in the CTransition object under test.
1.135 + @since 7.0
1.136 + @param aTestObject The CTransition object to be tested
1.137 + @return The current value of the error code.
1.138 + @pre TTransition_StateAccessor is fully constructed, and
1.139 + a valid test object must be passed in.
1.140 + */
1.141 + inline TInt ErrorCode(TAny* aTestObject) const;
1.142 +
1.143 + /**
1.144 + @fn BlockingFlag(TAny* aTestObject) const
1.145 + Intended Usage : Implemented by the developer to access the iStatus
1.146 + structure in the CTransition object under test.
1.147 + @since 7.0
1.148 + @param aTestObject The CTransition object to be tested
1.149 + @return The contents of iStatus.
1.150 + @pre TTransition_StateAccessor is fully constructed, and
1.151 + a valid test object must be passed in.
1.152 + */
1.153 + inline TRequestStatus Status(const TAny* aTestObject) const;
1.154 +
1.155 + /**
1.156 + @fn InternalizeL(RFileReadStream& aStream, CTransition* aTransition)
1.157 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.158 + Error Condition : Leaves with an error code.
1.159 + @since 7.0
1.160 + @param aStream The filestream to read from .
1.161 + @param aTransition A pointer to the CTransition object under test.
1.162 + @return None.
1.163 + @pre TTransition_StateAccessor is fully constructed.
1.164 + @post The class under test is set to the state specified.
1.165 + */
1.166 + inline void InternalizeL(RFileReadStream& aStream, CTransition* aTransition);
1.167 +
1.168 + /**
1.169 + @fn ExternalizeL(RFileWriteStream& aStream, CTransition* aTransition)
1.170 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.171 + Error Condition : Leaves with an error code.
1.172 + @since 7.0
1.173 + @param aStream The filestream to persist into.
1.174 + @param aTransition A pointer to the CTransition object under test.
1.175 + @return None.
1.176 + @pre TTransition_StateAccessor is fully constructed.
1.177 + @post No change to the class under test, its internal state.
1.178 + is persisted.
1.179 + */
1.180 + inline void ExternalizeL(RFileWriteStream& aStream, CTransition* aTransition);
1.181 +
1.182 +
1.183 +private:
1.184 + /**
1.185 + @fn InternalizeL(CTransition* aTransition)
1.186 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.187 + Error Condition : Leaves with an error code.
1.188 + @since 7.0
1.189 + @param TAny* A pointer to the object under test.
1.190 + @return None.
1.191 + @pre TTransition_StateAccessor is fully constructed.
1.192 + @post The class under test is set to the state specified.
1.193 + */
1.194 + inline void InternalizeL(CTransition* aTransition);
1.195 +
1.196 + /**
1.197 + @fn ExternalizeL(CTransition* aTransition)
1.198 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.199 + Error Condition : Leaves with an error code.
1.200 + @since 7.0
1.201 + @param TAny* A pointer to the object under test.
1.202 + @return None.
1.203 + @pre TTransition_StateAccessor is fully constructed.
1.204 + @post No change to the class under test, its internal state.
1.205 + is persisted.
1.206 + */
1.207 + inline void ExternalizeL(CTransition* aTransition);
1.208 + }; // TTransition_StateAccessor
1.209 +
1.210 +#include "TransitionStateAccessor.inl"
1.211 +
1.212 +#endif // __TRANSITIONSTATEACCESSOR_H__
1.213 +