1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/inc/UnitTestInfo.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,115 @@
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 CUnitTestInfo
1.18 +// This file comment is for DOxygen only and is ignored by EDoc.
1.19 +//
1.20 +//
1.21 +
1.22 +/**
1.23 + @test
1.24 +*/
1.25 +
1.26 +#ifndef __UNITTESTINFO_H__
1.27 +#define __UNITTESTINFO_H__
1.28 +
1.29 +#include <e32base.h>
1.30 +
1.31 +/**
1.32 + @internalAll
1.33 + Comments : Storage for information about a group of transitions. This group will normally
1.34 + correspond to the contents of a CUnitTest.
1.35 + */
1.36 +
1.37 +NONSHARABLE_CLASS(CUnitTestInfo) : public CBase
1.38 + {
1.39 +public:
1.40 +
1.41 +/**
1.42 + @fn static CUnitTestInfo* NewLC(const TDesC& aSetId)
1.43 + Intended Usage : Two phase constructor which leaves a CTransition* on the cleanup stack
1.44 + Error Condition : Leave with an error code.
1.45 + @leave KErrNoMemory
1.46 + @since 7.0
1.47 + @param aSetId An identifier for this CUnitTestInfo
1.48 + @return CUnitTestInfo* A pointer to the newly created class
1.49 + @pre None
1.50 + @post A CUnitTestInfo is on the CleanupStack
1.51 + */
1.52 +
1.53 + static CUnitTestInfo* NewLC(const TDesC& aSetId);
1.54 +
1.55 +/**
1.56 + @fn static CUnitTestInfo* NewL(const TDesC& aSetId)
1.57 + Intended Usage : Two phase constructor which leaves nothing on the cleanup stack
1.58 + Error Condition :
1.59 + @since 7.0
1.60 + @param aSetId An identifier for this CUnitTestInfo
1.61 + @return CUnitTestInfo* A pointer to the newly created class
1.62 + @pre None
1.63 + @post Nothing is on the CleanupStack
1.64 + */
1.65 +
1.66 + static CUnitTestInfo* NewL(const TDesC& aSetId);
1.67 +
1.68 +/**
1.69 + @fn ~CUnitTestInfo()
1.70 + Intended Usage : Standard destructor
1.71 + Error Condition :
1.72 + @since 7.0
1.73 + */
1.74 +
1.75 + ~CUnitTestInfo();
1.76 +
1.77 +/**
1.78 + @fn inline const TDesC& UnitTestId() const
1.79 + Intended Usage : Returns the identifier of this CUnitTestInfo
1.80 + Error Condition :
1.81 + @since 7.0
1.82 + @return const TDesC& The identifier of this UnitTest
1.83 + @pre None
1.84 + */
1.85 +
1.86 + inline const TDesC& UnitTestId() const;
1.87 +
1.88 +private:
1.89 +/**
1.90 + @fn CUnitTestInfo()
1.91 + Intended Usage : Default constructor
1.92 + Error Condition :
1.93 + @since 7.0
1.94 + */
1.95 +
1.96 + CUnitTestInfo();
1.97 +
1.98 +/**
1.99 + @fn void ConstructL(const TDesC& aSetId)
1.100 + Intended Usage : Second phase of safe construction method
1.101 + Error Condition :
1.102 + @since 7.0
1.103 + @param aSetId An identifier for this CUnitTestInfo
1.104 + @pre First phase of construction is complete
1.105 + @post Object if fully constructed
1.106 + */
1.107 +
1.108 + void ConstructL(const TDesC& aUnitTestId);
1.109 +
1.110 +private:
1.111 +/** An identifier for this unit test */
1.112 +
1.113 + HBufC* iUnitTestId;
1.114 + };
1.115 +
1.116 +#include <ecom/test_bed/unittestinfo.inl>
1.117 +
1.118 +#endif