diff -r 000000000000 -r bde4ae8d615e os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/ComponentTesterTest/ComponentTesterTransitionValidation.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/ComponentTesterTest/ComponentTesterTransitionValidation.h Fri Jun 15 03:10:57 2012 +0200 @@ -0,0 +1,451 @@ +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// under the terms of "Eclipse Public License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.eclipse.org/legal/epl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// The definitions of the transition classes upon the CComponentTester class methods. +// +// + +#ifndef __COMPONENTTESTERTRANSITIONVALIDATION_H__ +#define __COMPONENTTESTERTRANSITIONVALIDATION_H__ + +#include "ComponentTesterTransitions.h" + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the CtorUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_Ctor_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_Ctor_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_Ctor_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_Ctor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_Ctor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_Ctor_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the DtorUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_Dtor_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_Dtor_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_Dtor_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_Dtor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_Dtor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_Dtor_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the TransitionSetsUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_TransitionSets_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_TransitionSets_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_TransitionSets_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_TransitionSet_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_TransitionSet_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_TransitionSets_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the AddUnitTestUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_AddUnitTest_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_AddUnitTest_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_AddUnitTest_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_AddUnitTest_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_AddUnitTest_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_AddUnitTest_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the AddParamUnitTestUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_AddParamUnitTest_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_AddParamUnitTest_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_AddParamUnitTest_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_AddParamUnitTest_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_AddParamUnitTest_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_AddParamUnitTest_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the TestComponentUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_TestComponent_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_TestComponent_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_TestComponent_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_TestComponent_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_TestComponent_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_TestComponent_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the RunUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_Run_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_Run_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_Run_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_Run_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_Run_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_Run_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + + Comments : Provide all the CompleteUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CComponentTester test class for a transition. + */ +class TComponentTester_Complete_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TComponentTester_Complete_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : Default contructor. + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TComponentTester_Complete_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TComponentTester_Complete_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TComponentTester_Complete_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TComponentTester_Complete_TransitionValidator + + +#include "ComponentTesterTransitionValidation.inl" + +#endif // __COMPONENTTESTERTRANSITIONVALIDATION_H__ +