|
sl@0
|
1 |
// Copyright (c) 2001-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 |
// The definition of the accessor class upon the CTransition
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
#ifndef __TRANSITIONSTATEACCESSOR_H__
|
|
sl@0
|
19 |
#define __TRANSITIONSTATEACCESSOR_H__
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
#include <e32base.h>
|
|
sl@0
|
22 |
#include <f32file.h>
|
|
sl@0
|
23 |
#include <s32stor.h>
|
|
sl@0
|
24 |
#include <s32file.h>
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
#include "TestUtilities.h"
|
|
sl@0
|
27 |
#include <ecom/test_bed/testbeddefinitions.h>
|
|
sl@0
|
28 |
#include "StateAccessor.h"
|
|
sl@0
|
29 |
#include <ecom/test_bed/transition.h>
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
// ______________________________________________________________________________
|
|
sl@0
|
32 |
//
|
|
sl@0
|
33 |
/**
|
|
sl@0
|
34 |
@internalComponent
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
Comments : State accessor for the CTransition object under test.
|
|
sl@0
|
37 |
*/
|
|
sl@0
|
38 |
class TTransition_StateAccessor : public MStateAccessor
|
|
sl@0
|
39 |
{
|
|
sl@0
|
40 |
public:
|
|
sl@0
|
41 |
/**
|
|
sl@0
|
42 |
@fn InvariantTest(TAny* aTestObject)
|
|
sl@0
|
43 |
Intended Usage :
|
|
sl@0
|
44 |
@since 7.0
|
|
sl@0
|
45 |
@param TAny* A pointer to the object under test.
|
|
sl@0
|
46 |
@return TInt KErrNone if the invariants were valid, error code otherwise.
|
|
sl@0
|
47 |
@pre TTransition_StateAccessor is fully constructed.
|
|
sl@0
|
48 |
@post The class under test is set to the state specified.
|
|
sl@0
|
49 |
*/
|
|
sl@0
|
50 |
inline TInt InvariantTest(TAny* aTestObject);
|
|
sl@0
|
51 |
|
|
sl@0
|
52 |
/**
|
|
sl@0
|
53 |
@fn Internalize(TAny* aTestObject)
|
|
sl@0
|
54 |
Intended Usage : Implemented by the developer to set the state of the object under test.
|
|
sl@0
|
55 |
@since 7.0
|
|
sl@0
|
56 |
@param aTestObject The object to be tested
|
|
sl@0
|
57 |
@return KErrNone if the internalize was successful.
|
|
sl@0
|
58 |
@return One of the EPOC standard error codes indicating the reason
|
|
sl@0
|
59 |
for the failure to load the object state.
|
|
sl@0
|
60 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
61 |
valid test object must be passed in.
|
|
sl@0
|
62 |
@post The class under test is set to the state specified
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
inline virtual TInt Internalize(TAny* aTestObject);
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
@fn Externalize(TAny* aTestObject)
|
|
sl@0
|
68 |
Intended Usage : Implemented by the developer to persist the state of the object under test.
|
|
sl@0
|
69 |
@since 7.0
|
|
sl@0
|
70 |
@param aTestObject The object to be tested
|
|
sl@0
|
71 |
@return KErrNone if the internalize was successful.
|
|
sl@0
|
72 |
@return One of the EPOC standard error codes indicating the reason
|
|
sl@0
|
73 |
for the failure to externalize the object.
|
|
sl@0
|
74 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
75 |
valid test object must be passed in.
|
|
sl@0
|
76 |
@post Returns an error code dependant on the result of the test
|
|
sl@0
|
77 |
*/
|
|
sl@0
|
78 |
inline virtual TInt Externalize(TAny* aTestObject);
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
/**
|
|
sl@0
|
81 |
@fn IsRepeated(TAny* aTestObject) const
|
|
sl@0
|
82 |
Intended Usage : Implemented by the developer to access the iRepeatThis
|
|
sl@0
|
83 |
flag in the CTransition object under test.
|
|
sl@0
|
84 |
@since 7.0
|
|
sl@0
|
85 |
@param aTestObject The CTransition object to be tested
|
|
sl@0
|
86 |
@return ETrue if the flag is set.
|
|
sl@0
|
87 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
88 |
a valid test object must be passed in.
|
|
sl@0
|
89 |
*/
|
|
sl@0
|
90 |
inline TBool IsRepeated(TAny* aTestObject) const;
|
|
sl@0
|
91 |
|
|
sl@0
|
92 |
/**
|
|
sl@0
|
93 |
@fn TransitionId(TAny* aTestObject) const
|
|
sl@0
|
94 |
Intended Usage : Implemented by the developer to access the iTransitionId
|
|
sl@0
|
95 |
descriptor in the CTransition object under test.
|
|
sl@0
|
96 |
@since 7.0
|
|
sl@0
|
97 |
@param aTestObject The CTransition object to be tested
|
|
sl@0
|
98 |
@return A pointer to the iTransitionId descriptor.
|
|
sl@0
|
99 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
100 |
a valid test object must be passed in.
|
|
sl@0
|
101 |
*/
|
|
sl@0
|
102 |
inline const TDesC* TransitionId(TAny* aTestObject) const;
|
|
sl@0
|
103 |
|
|
sl@0
|
104 |
/**
|
|
sl@0
|
105 |
@fn TransitionInfo(TAny* aTestObject) const
|
|
sl@0
|
106 |
Intended Usage : Implemented by the developer to access the iTransitionId
|
|
sl@0
|
107 |
descriptor in the CTransition object under test.
|
|
sl@0
|
108 |
@since 7.0
|
|
sl@0
|
109 |
@param aTestObject The CTransition object to be tested
|
|
sl@0
|
110 |
@return A pointer to the iTransitionInfo structure.
|
|
sl@0
|
111 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
112 |
a valid test object must be passed in.
|
|
sl@0
|
113 |
*/
|
|
sl@0
|
114 |
inline const TTransitionInfo* TransitionInfo(TAny* aTestObject) const;
|
|
sl@0
|
115 |
|
|
sl@0
|
116 |
/**
|
|
sl@0
|
117 |
@fn BlockingFlag(TAny* aTestObject) const
|
|
sl@0
|
118 |
Intended Usage : Implemented by the developer to access the iBlockingTransition
|
|
sl@0
|
119 |
flag in the CTransition object under test.
|
|
sl@0
|
120 |
@since 7.0
|
|
sl@0
|
121 |
@param aTestObject The CTransition object to be tested
|
|
sl@0
|
122 |
@return ETrue if the flag is set.
|
|
sl@0
|
123 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
124 |
a valid test object must be passed in.
|
|
sl@0
|
125 |
*/
|
|
sl@0
|
126 |
inline TBool BlockingFlag(TAny* aTestObject) const;
|
|
sl@0
|
127 |
|
|
sl@0
|
128 |
/**
|
|
sl@0
|
129 |
@fn BlockingFlag(TAny* aTestObject) const
|
|
sl@0
|
130 |
Intended Usage : Implemented by the developer to access the iLeaveError
|
|
sl@0
|
131 |
flag in the CTransition object under test.
|
|
sl@0
|
132 |
@since 7.0
|
|
sl@0
|
133 |
@param aTestObject The CTransition object to be tested
|
|
sl@0
|
134 |
@return The current value of the error code.
|
|
sl@0
|
135 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
136 |
a valid test object must be passed in.
|
|
sl@0
|
137 |
*/
|
|
sl@0
|
138 |
inline TInt ErrorCode(TAny* aTestObject) const;
|
|
sl@0
|
139 |
|
|
sl@0
|
140 |
/**
|
|
sl@0
|
141 |
@fn BlockingFlag(TAny* aTestObject) const
|
|
sl@0
|
142 |
Intended Usage : Implemented by the developer to access the iStatus
|
|
sl@0
|
143 |
structure in the CTransition object under test.
|
|
sl@0
|
144 |
@since 7.0
|
|
sl@0
|
145 |
@param aTestObject The CTransition object to be tested
|
|
sl@0
|
146 |
@return The contents of iStatus.
|
|
sl@0
|
147 |
@pre TTransition_StateAccessor is fully constructed, and
|
|
sl@0
|
148 |
a valid test object must be passed in.
|
|
sl@0
|
149 |
*/
|
|
sl@0
|
150 |
inline TRequestStatus Status(const TAny* aTestObject) const;
|
|
sl@0
|
151 |
|
|
sl@0
|
152 |
/**
|
|
sl@0
|
153 |
@fn InternalizeL(RFileReadStream& aStream, CTransition* aTransition)
|
|
sl@0
|
154 |
Intended Usage : Implemented by the developer to set the state of the object under test.
|
|
sl@0
|
155 |
Error Condition : Leaves with an error code.
|
|
sl@0
|
156 |
@since 7.0
|
|
sl@0
|
157 |
@param aStream The filestream to read from .
|
|
sl@0
|
158 |
@param aTransition A pointer to the CTransition object under test.
|
|
sl@0
|
159 |
@return None.
|
|
sl@0
|
160 |
@pre TTransition_StateAccessor is fully constructed.
|
|
sl@0
|
161 |
@post The class under test is set to the state specified.
|
|
sl@0
|
162 |
*/
|
|
sl@0
|
163 |
inline void InternalizeL(RFileReadStream& aStream, CTransition* aTransition);
|
|
sl@0
|
164 |
|
|
sl@0
|
165 |
/**
|
|
sl@0
|
166 |
@fn ExternalizeL(RFileWriteStream& aStream, CTransition* aTransition)
|
|
sl@0
|
167 |
Intended Usage : Implemented by the developer to persist the state of the object under test.
|
|
sl@0
|
168 |
Error Condition : Leaves with an error code.
|
|
sl@0
|
169 |
@since 7.0
|
|
sl@0
|
170 |
@param aStream The filestream to persist into.
|
|
sl@0
|
171 |
@param aTransition A pointer to the CTransition object under test.
|
|
sl@0
|
172 |
@return None.
|
|
sl@0
|
173 |
@pre TTransition_StateAccessor is fully constructed.
|
|
sl@0
|
174 |
@post No change to the class under test, its internal state.
|
|
sl@0
|
175 |
is persisted.
|
|
sl@0
|
176 |
*/
|
|
sl@0
|
177 |
inline void ExternalizeL(RFileWriteStream& aStream, CTransition* aTransition);
|
|
sl@0
|
178 |
|
|
sl@0
|
179 |
|
|
sl@0
|
180 |
private:
|
|
sl@0
|
181 |
/**
|
|
sl@0
|
182 |
@fn InternalizeL(CTransition* aTransition)
|
|
sl@0
|
183 |
Intended Usage : Implemented by the developer to set the state of the object under test.
|
|
sl@0
|
184 |
Error Condition : Leaves with an error code.
|
|
sl@0
|
185 |
@since 7.0
|
|
sl@0
|
186 |
@param TAny* A pointer to the object under test.
|
|
sl@0
|
187 |
@return None.
|
|
sl@0
|
188 |
@pre TTransition_StateAccessor is fully constructed.
|
|
sl@0
|
189 |
@post The class under test is set to the state specified.
|
|
sl@0
|
190 |
*/
|
|
sl@0
|
191 |
inline void InternalizeL(CTransition* aTransition);
|
|
sl@0
|
192 |
|
|
sl@0
|
193 |
/**
|
|
sl@0
|
194 |
@fn ExternalizeL(CTransition* aTransition)
|
|
sl@0
|
195 |
Intended Usage : Implemented by the developer to persist the state of the object under test.
|
|
sl@0
|
196 |
Error Condition : Leaves with an error code.
|
|
sl@0
|
197 |
@since 7.0
|
|
sl@0
|
198 |
@param TAny* A pointer to the object under test.
|
|
sl@0
|
199 |
@return None.
|
|
sl@0
|
200 |
@pre TTransition_StateAccessor is fully constructed.
|
|
sl@0
|
201 |
@post No change to the class under test, its internal state.
|
|
sl@0
|
202 |
is persisted.
|
|
sl@0
|
203 |
*/
|
|
sl@0
|
204 |
inline void ExternalizeL(CTransition* aTransition);
|
|
sl@0
|
205 |
}; // TTransition_StateAccessor
|
|
sl@0
|
206 |
|
|
sl@0
|
207 |
#include "TransitionStateAccessor.inl"
|
|
sl@0
|
208 |
|
|
sl@0
|
209 |
#endif // __TRANSITIONSTATEACCESSOR_H__
|
|
sl@0
|
210 |
|