sl@0: // Copyright (c) 1997-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: // This file contains the definition of the class CComponentInfo
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @test
sl@0: */
sl@0: 
sl@0: #ifndef __COMPONENTINFO_H__
sl@0: #define __COMPONENTINFO_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>
sl@0: 
sl@0: #include <ecom/test_bed/unittestinfo.h>
sl@0: #include <ecom/test_bed/componenttester.h>
sl@0: 
sl@0: /**
sl@0: 	@internalAll
sl@0: 	Comments : Holds information about all the tests within a component.
sl@0:  */
sl@0: 
sl@0: class CComponentInfo : public CBase
sl@0: 	{
sl@0: public:
sl@0: 
sl@0: /**
sl@0: 	@fn			static CComponentInfo* NewLC(ComponentTesterInitialiserLC aEntryFunc,  RPointerArray<CUnitTestInfo>* aUnitTestsInfo)
sl@0: 	Intended Usage	:	Standard two phase construction which leaves a CComponentInfo on the 
sl@0: 	cleanupstack.  This object takes ownership of both parameters.
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0: 	@param			aEntryFunc Ptr to function used to create componentTester
sl@0: 	@param			aUnitTestsInfo The transition sets in this component test
sl@0: 	@return			CComponentInfo* A pointer to the newly created class
sl@0: 	@pre 			None
sl@0: 	@post			CComponentInfo is on the CleanupStack
sl@0:  */
sl@0: 	
sl@0: 	static CComponentInfo* NewLC(ComponentTesterInitialiserLC aEntryFunc, RPointerArray<CUnitTestInfo>* aUnitTestsInfo);
sl@0: 
sl@0: /**
sl@0: 	@fn			static CComponentInfo* NewL(ComponentTesterInitialiserLC aCreateFuncLC,  RPointerArray<CUnitTestInfo>* aUnitTestsInfo)
sl@0: 	Intended Usage	:	Standard two-phase construction which leaves nothing on the 
sl@0: 	cleanup stack.  This object takes ownership of both parameters.
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0: 	@param			aCreateFuncLC Ptr to function used to create componentTester
sl@0: 	@param			aUnitTestsInfo The transition sets in this component test
sl@0: 	@return			CComponentInfo* A pointer to the newly created class
sl@0: 	@pre 			None
sl@0: 	@post			Nothing is on the CleanupStack
sl@0:  */
sl@0: 	
sl@0: 	IMPORT_C static CComponentInfo* NewL(ComponentTesterInitialiserLC aCreateFuncLC, RPointerArray<CUnitTestInfo>* aUnitTestsInfo);
sl@0: 
sl@0: /**
sl@0: 	@fn				~CComponentInfo()
sl@0: 	Intended Usage	:	Standard destructor
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0:  */
sl@0: 	
sl@0: 	~CComponentInfo();
sl@0: 
sl@0: 
sl@0: /**
sl@0: 	@fn				inline ComponentTesterInitialiserLC GlobalEntryFunc() const
sl@0: 	Intended Usage	:	Get the pointer to the function entry point used to
sl@0: 						create the ComponentTester derived object which kick 
sl@0: 						starts the tests.
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0: 	@return			ComponentTesterInitialiserLC Function pointer
sl@0: 	@pre 			None
sl@0:  */
sl@0: 	
sl@0: 	inline ComponentTesterInitialiserLC GlobalEntryFunc() const;
sl@0: 
sl@0: /**
sl@0: 	@fn				inline RPointerArray<CUnitTestInfo>& UnitTestsInfo() const
sl@0: 	Intended Usage	:	Get a list of the transition sets in this component
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0: 	@return			RPointerArray<CUnitTestInfo>& Information on the unit tests contained in 
sl@0: 	this component.
sl@0: 	@pre 			None
sl@0:  */
sl@0: 	
sl@0: 	inline const RPointerArray<CUnitTestInfo>& UnitTestsInfo() const;
sl@0: 
sl@0: private:
sl@0: /**
sl@0: 	@fn			CComponentInfo()
sl@0: 	Intended Usage	:	Standard constructor.  This object takes ownership of both parameters.
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0:  */
sl@0: 	
sl@0: 	CComponentInfo();
sl@0: 
sl@0: /**
sl@0: 	@fn				void Construct(ComponentTesterInitialiserLC aEntryFunc, RPointerArray<CUnitTestInfo>* aUnitTestsInfo)
sl@0: 	Intended Usage	:	Standard second phase of construction
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0: 	@pre 			First phase of construction is complete
sl@0: 	@param			aEntryFunc Ptr to function used to create componentTester
sl@0: 	@param			aUnitTestsInfo The transition sets in this component test
sl@0: 	@post			Object is fully constructed
sl@0:  */
sl@0: 	
sl@0: 	void Construct(ComponentTesterInitialiserLC aEntryFunc, RPointerArray<CUnitTestInfo>* aUnitTestsInfo);
sl@0: 
sl@0: private:
sl@0: 	/** Holds a pointer to the function capable of creating a CComponentTester derived object
sl@0: 	   which will run the unit tests outlined in iUnitTestsInfo.*/
sl@0: 	ComponentTesterInitialiserLC iComponentTesterGlobalCreationFuncLC;
sl@0: /** Array of the subsets of transitions in this component. This object takes ownership of 
sl@0: 	iUnitTestsInfo at construction.*/
sl@0: 	
sl@0: 	RPointerArray<CUnitTestInfo>* iUnitTestsInfo;
sl@0: 	};
sl@0: 
sl@0: #include <ecom/test_bed/componentinfo.inl>
sl@0: 
sl@0: #endif