1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/inc/ComponentInfo.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,140 @@
1.4 +// Copyright (c) 1997-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 +// This file contains the definition of the class CComponentInfo
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 + @test
1.23 +*/
1.24 +
1.25 +#ifndef __COMPONENTINFO_H__
1.26 +#define __COMPONENTINFO_H__
1.27 +
1.28 +#include <e32base.h>
1.29 +#include <f32file.h>
1.30 +
1.31 +#include <ecom/test_bed/unittestinfo.h>
1.32 +#include <ecom/test_bed/componenttester.h>
1.33 +
1.34 +/**
1.35 + @internalAll
1.36 + Comments : Holds information about all the tests within a component.
1.37 + */
1.38 +
1.39 +class CComponentInfo : public CBase
1.40 + {
1.41 +public:
1.42 +
1.43 +/**
1.44 + @fn static CComponentInfo* NewLC(ComponentTesterInitialiserLC aEntryFunc, RPointerArray<CUnitTestInfo>* aUnitTestsInfo)
1.45 + Intended Usage : Standard two phase construction which leaves a CComponentInfo on the
1.46 + cleanupstack. This object takes ownership of both parameters.
1.47 + Error Condition :
1.48 + @since 7.0
1.49 + @param aEntryFunc Ptr to function used to create componentTester
1.50 + @param aUnitTestsInfo The transition sets in this component test
1.51 + @return CComponentInfo* A pointer to the newly created class
1.52 + @pre None
1.53 + @post CComponentInfo is on the CleanupStack
1.54 + */
1.55 +
1.56 + static CComponentInfo* NewLC(ComponentTesterInitialiserLC aEntryFunc, RPointerArray<CUnitTestInfo>* aUnitTestsInfo);
1.57 +
1.58 +/**
1.59 + @fn static CComponentInfo* NewL(ComponentTesterInitialiserLC aCreateFuncLC, RPointerArray<CUnitTestInfo>* aUnitTestsInfo)
1.60 + Intended Usage : Standard two-phase construction which leaves nothing on the
1.61 + cleanup stack. This object takes ownership of both parameters.
1.62 + Error Condition :
1.63 + @since 7.0
1.64 + @param aCreateFuncLC Ptr to function used to create componentTester
1.65 + @param aUnitTestsInfo The transition sets in this component test
1.66 + @return CComponentInfo* A pointer to the newly created class
1.67 + @pre None
1.68 + @post Nothing is on the CleanupStack
1.69 + */
1.70 +
1.71 + IMPORT_C static CComponentInfo* NewL(ComponentTesterInitialiserLC aCreateFuncLC, RPointerArray<CUnitTestInfo>* aUnitTestsInfo);
1.72 +
1.73 +/**
1.74 + @fn ~CComponentInfo()
1.75 + Intended Usage : Standard destructor
1.76 + Error Condition :
1.77 + @since 7.0
1.78 + */
1.79 +
1.80 + ~CComponentInfo();
1.81 +
1.82 +
1.83 +/**
1.84 + @fn inline ComponentTesterInitialiserLC GlobalEntryFunc() const
1.85 + Intended Usage : Get the pointer to the function entry point used to
1.86 + create the ComponentTester derived object which kick
1.87 + starts the tests.
1.88 + Error Condition :
1.89 + @since 7.0
1.90 + @return ComponentTesterInitialiserLC Function pointer
1.91 + @pre None
1.92 + */
1.93 +
1.94 + inline ComponentTesterInitialiserLC GlobalEntryFunc() const;
1.95 +
1.96 +/**
1.97 + @fn inline RPointerArray<CUnitTestInfo>& UnitTestsInfo() const
1.98 + Intended Usage : Get a list of the transition sets in this component
1.99 + Error Condition :
1.100 + @since 7.0
1.101 + @return RPointerArray<CUnitTestInfo>& Information on the unit tests contained in
1.102 + this component.
1.103 + @pre None
1.104 + */
1.105 +
1.106 + inline const RPointerArray<CUnitTestInfo>& UnitTestsInfo() const;
1.107 +
1.108 +private:
1.109 +/**
1.110 + @fn CComponentInfo()
1.111 + Intended Usage : Standard constructor. This object takes ownership of both parameters.
1.112 + Error Condition :
1.113 + @since 7.0
1.114 + */
1.115 +
1.116 + CComponentInfo();
1.117 +
1.118 +/**
1.119 + @fn void Construct(ComponentTesterInitialiserLC aEntryFunc, RPointerArray<CUnitTestInfo>* aUnitTestsInfo)
1.120 + Intended Usage : Standard second phase of construction
1.121 + Error Condition :
1.122 + @since 7.0
1.123 + @pre First phase of construction is complete
1.124 + @param aEntryFunc Ptr to function used to create componentTester
1.125 + @param aUnitTestsInfo The transition sets in this component test
1.126 + @post Object is fully constructed
1.127 + */
1.128 +
1.129 + void Construct(ComponentTesterInitialiserLC aEntryFunc, RPointerArray<CUnitTestInfo>* aUnitTestsInfo);
1.130 +
1.131 +private:
1.132 + /** Holds a pointer to the function capable of creating a CComponentTester derived object
1.133 + which will run the unit tests outlined in iUnitTestsInfo.*/
1.134 + ComponentTesterInitialiserLC iComponentTesterGlobalCreationFuncLC;
1.135 +/** Array of the subsets of transitions in this component. This object takes ownership of
1.136 + iUnitTestsInfo at construction.*/
1.137 +
1.138 + RPointerArray<CUnitTestInfo>* iUnitTestsInfo;
1.139 + };
1.140 +
1.141 +#include <ecom/test_bed/componentinfo.inl>
1.142 +
1.143 +#endif