sl@0: // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // The definition of the accessor class upon the CTransition
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __TRANSITIONSTATEACCESSOR_H__
sl@0: #define __TRANSITIONSTATEACCESSOR_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>
sl@0: #include <s32stor.h>
sl@0: #include <s32file.h>
sl@0: 
sl@0: #include "TestUtilities.h"
sl@0: #include <ecom/test_bed/testbeddefinitions.h>
sl@0: #include "StateAccessor.h"
sl@0: #include <ecom/test_bed/transition.h>
sl@0: 
sl@0: // ______________________________________________________________________________
sl@0: //
sl@0: /**
sl@0: 	@internalComponent
sl@0: 
sl@0: 	Comments : State accessor for the CTransition object under test.
sl@0:  */
sl@0: class TTransition_StateAccessor : public MStateAccessor
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 		@fn				InvariantTest(TAny* aTestObject)
sl@0: 		Intended Usage	:	
sl@0: 		@since			7.0
sl@0: 		@param			TAny* A pointer to the object under test.
sl@0: 		@return			TInt KErrNone if the invariants were valid, error code otherwise.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed.
sl@0: 		@post			The class under test is set to the state specified.
sl@0: 	 */
sl@0: 	inline TInt InvariantTest(TAny* aTestObject);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				Internalize(TAny* aTestObject)
sl@0: 		Intended Usage	: Implemented by the developer to set the state of the object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The object to be tested
sl@0: 		@return			KErrNone if the internalize was successful.
sl@0: 		@return			One of the EPOC standard error codes indicating the reason
sl@0: 						for the failure	to load the object state.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						valid test object must be passed in.
sl@0: 		@post			The class under test is set to the state specified
sl@0: 	 */
sl@0: 	inline virtual TInt Internalize(TAny* aTestObject);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				Externalize(TAny* aTestObject)
sl@0: 		Intended Usage	: Implemented by the developer to persist the state of the object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The object to be tested
sl@0: 		@return			KErrNone if the internalize was successful.
sl@0: 		@return			One of the EPOC standard error codes indicating the reason
sl@0: 						for the failure	to externalize the object.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						valid test object must be passed in.
sl@0: 		@post			Returns an error code dependant on the result of the test
sl@0: 	 */
sl@0: 	inline virtual TInt Externalize(TAny* aTestObject);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				IsRepeated(TAny* aTestObject) const
sl@0: 		Intended Usage	: Implemented by the developer to access the iRepeatThis
sl@0: 						flag in the CTransition object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The CTransition object to be tested
sl@0: 		@return			ETrue if the flag is set.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						a valid test object must be passed in.
sl@0: 	 */
sl@0: 	inline TBool IsRepeated(TAny* aTestObject) const;
sl@0: 
sl@0: 	/**
sl@0: 		@fn				TransitionId(TAny* aTestObject) const
sl@0: 		Intended Usage	: Implemented by the developer to access the iTransitionId
sl@0: 						descriptor in the CTransition object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The CTransition object to be tested
sl@0: 		@return			A pointer to the iTransitionId descriptor.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						a valid test object must be passed in.
sl@0: 	 */
sl@0: 	inline const TDesC* TransitionId(TAny* aTestObject) const;
sl@0: 
sl@0: 	/**
sl@0: 		@fn				TransitionInfo(TAny* aTestObject) const
sl@0: 		Intended Usage	: Implemented by the developer to access the iTransitionId
sl@0: 						descriptor in the CTransition object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The CTransition object to be tested
sl@0: 		@return			A pointer to the iTransitionInfo structure.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						a valid test object must be passed in.
sl@0: 	 */
sl@0: 	inline const TTransitionInfo* TransitionInfo(TAny* aTestObject) const;
sl@0: 
sl@0: 	/**
sl@0: 		@fn				BlockingFlag(TAny* aTestObject) const
sl@0: 		Intended Usage	: Implemented by the developer to access the iBlockingTransition
sl@0: 						flag in the CTransition object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The CTransition object to be tested
sl@0: 		@return			ETrue if the flag is set.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						a valid test object must be passed in.
sl@0: 	 */
sl@0: 	inline TBool BlockingFlag(TAny* aTestObject) const;
sl@0: 
sl@0: 	/**
sl@0: 		@fn				BlockingFlag(TAny* aTestObject) const
sl@0: 		Intended Usage	: Implemented by the developer to access the iLeaveError
sl@0: 						flag in the CTransition object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The CTransition object to be tested
sl@0: 		@return			The current value of the error code.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						a valid test object must be passed in.
sl@0: 	 */
sl@0: 	inline TInt ErrorCode(TAny* aTestObject) const;
sl@0: 
sl@0: 	/**
sl@0: 		@fn				BlockingFlag(TAny* aTestObject) const
sl@0: 		Intended Usage	: Implemented by the developer to access the iStatus
sl@0: 						structure in the CTransition object under test.
sl@0: 		@since			7.0
sl@0: 		@param			aTestObject The CTransition object to be tested
sl@0: 		@return			The contents of iStatus.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed, and
sl@0: 						a valid test object must be passed in.
sl@0: 	 */
sl@0: 	inline TRequestStatus Status(const TAny* aTestObject) const;
sl@0: 
sl@0: 	/**
sl@0: 		@fn				InternalizeL(RFileReadStream& aStream, CTransition* aTransition)
sl@0: 		Intended Usage	: Implemented by the developer to set the state of the object under test.
sl@0: 		Error Condition	: Leaves with an error code.
sl@0: 		@since			7.0
sl@0: 		@param			aStream The filestream to read from .
sl@0: 		@param			aTransition A pointer to the CTransition object under test.
sl@0: 		@return			None.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed.
sl@0: 		@post			The class under test is set to the state specified.
sl@0: 	 */
sl@0: 		inline void InternalizeL(RFileReadStream& aStream, CTransition* aTransition);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				ExternalizeL(RFileWriteStream& aStream, CTransition* aTransition)
sl@0: 		Intended Usage	: Implemented by the developer to persist the state of the object under test.
sl@0: 		Error Condition	: Leaves with an error code.
sl@0: 		@since			7.0
sl@0: 		@param			aStream The filestream to persist into.
sl@0: 		@param			aTransition A pointer to the CTransition object under test.
sl@0: 		@return			None.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed.
sl@0: 		@post			No change to the class under test, its internal state.
sl@0: 						is persisted.
sl@0: 	*/
sl@0: 	inline void ExternalizeL(RFileWriteStream& aStream, CTransition* aTransition);
sl@0: 
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 		@fn				InternalizeL(CTransition* aTransition)
sl@0: 		Intended Usage	: Implemented by the developer to set the state of the object under test.
sl@0: 		Error Condition	: Leaves with an error code.
sl@0: 		@since			7.0
sl@0: 		@param			TAny* A pointer to the object under test.
sl@0: 		@return			None.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed.
sl@0: 		@post			The class under test is set to the state specified.
sl@0: 	*/
sl@0: 	inline void InternalizeL(CTransition* aTransition);
sl@0: 
sl@0: 	/**
sl@0: 		@fn				ExternalizeL(CTransition* aTransition)
sl@0: 		Intended Usage	: Implemented by the developer to persist the state of the object under test.
sl@0: 		Error Condition	: Leaves with an error code.
sl@0: 		@since			7.0
sl@0: 		@param			TAny* A pointer to the object under test.
sl@0: 		@return			None.
sl@0: 		@pre 			TTransition_StateAccessor is fully constructed.
sl@0: 		@post			No change to the class under test, its internal state.
sl@0: 						is persisted.
sl@0: 	*/
sl@0: 	inline void ExternalizeL(CTransition* aTransition);
sl@0: 	};	// TTransition_StateAccessor
sl@0: 
sl@0: #include "TransitionStateAccessor.inl"
sl@0: 
sl@0: #endif // __TRANSITIONSTATEACCESSOR_H__
sl@0: