os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/DefaultLogOutputTest/DefaultLogOutputStateAccessor.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/DefaultLogOutputTest/DefaultLogOutputStateAccessor.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,137 @@
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 +// The definition of the accessor class upon the CDefaultLogOutput
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __DEFAULTLOGOUTPUTSTATEACCESSOR_H__
1.22 +#define __DEFAULTLOGOUTPUTSTATEACCESSOR_H__
1.23 +
1.24 +#include <e32base.h>
1.25 +#include <f32file.h>
1.26 +#include <s32stor.h>
1.27 +#include <s32file.h>
1.28 +
1.29 +#include "TestUtilities.h"
1.30 +#include <ecom/test_bed/testbeddefinitions.h>
1.31 +#include "StateAccessor.h"
1.32 +#include "DefaultLogOutput.h"
1.33 +
1.34 +// ______________________________________________________________________________
1.35 +//
1.36 +/**
1.37 + @internalComponent
1.38 +
1.39 + Comments : State accessor for the CDefaultLogOutput object under test.
1.40 + */
1.41 +class TDefaultLogOutput_StateAccessor : public MStateAccessor
1.42 + {
1.43 +public:
1.44 + /**
1.45 + @fn InvariantTest(TAny* aTestObject)
1.46 + Intended Usage :
1.47 + @since 7.0
1.48 + @param TAny* A pointer to the object under test.
1.49 + @return TInt KErrNone if the invariants were valid, error code otherwise.
1.50 + @pre TDefaultLogOutput_StateAccessor is fully constructed.
1.51 + @post The class under test is set to the state specified.
1.52 + */
1.53 + inline TInt InvariantTest(TAny* aTestObject);
1.54 +
1.55 + /**
1.56 + @fn Internalize(TAny* aTestObject)
1.57 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.58 + @since 7.0
1.59 + @param aTestObject The object to be tested
1.60 + @return KErrNone if the internalize was successful.
1.61 + @return One of the EPOC standard error codes indicating the reason
1.62 + for the failure to load the object state.
1.63 + @pre TDefaultLogOutput_StateAccessor is fully constructed, and
1.64 + valid test object must be passed in.
1.65 + @post The class under test is set to the state specified
1.66 + */
1.67 + inline virtual TInt Internalize(TAny* aTestObject);
1.68 +
1.69 + /**
1.70 + @fn Externalize(TAny* aTestObject)
1.71 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.72 + @since 7.0
1.73 + @param aTestObject The object to be tested
1.74 + @return KErrNone if the internalize was successful.
1.75 + @return One of the EPOC standard error codes indicating the reason
1.76 + for the failure to externalize the object.
1.77 + @pre TDefaultLogOutput_StateAccessor is fully constructed, and
1.78 + valid test object must be passed in.
1.79 + @post Returns an error code dependant on the result of the test
1.80 + */
1.81 + inline virtual TInt Externalize(TAny* aTestObject);
1.82 +
1.83 + /**
1.84 + @fn InternalizeL(RFileReadStream& aStream, CDefaultLogOutput* aDefaultLogOutput)
1.85 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.86 + Error Condition : Leaves with an error code.
1.87 + @since 7.0
1.88 + @param aStream The filestream to read from .
1.89 + @param aDefaultLogOutput A pointer to the CDefaultLogOutput object under test.
1.90 + @return None.
1.91 + @pre TDefaultLogOutput_StateAccessor is fully constructed.
1.92 + @post The class under test is set to the state specified.
1.93 + */
1.94 + inline void InternalizeL(RFileReadStream& aStream, CDefaultLogOutput* aDefaultLogOutput);
1.95 +
1.96 + /**
1.97 + @fn ExternalizeL(RFileWriteStream& aStream, CDefaultLogOutput* aDefaultLogOutput)
1.98 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.99 + Error Condition : Leaves with an error code.
1.100 + @since 7.0
1.101 + @param aStream The filestream to persist into.
1.102 + @param aDefaultLogOutput A pointer to the CDefaultLogOutput object under test.
1.103 + @return None.
1.104 + @pre TDefaultLogOutput_StateAccessor is fully constructed.
1.105 + @post No change to the class under test, its internal state.
1.106 + is persisted.
1.107 + */
1.108 + inline void ExternalizeL(RFileWriteStream& aStream, CDefaultLogOutput* aDefaultLogOutput);
1.109 +
1.110 +private:
1.111 + /**
1.112 + @fn InternalizeL(CDefaultLogOutput* aDefaultLogOutput)
1.113 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.114 + Error Condition : Leaves with an error code.
1.115 + @since 7.0
1.116 + @param TAny* A pointer to the object under test.
1.117 + @return None.
1.118 + @pre TDefaultLogOutput_StateAccessor is fully constructed.
1.119 + @post The class under test is set to the state specified.
1.120 + */
1.121 + inline void InternalizeL(CDefaultLogOutput* aDefaultLogOutput);
1.122 +
1.123 + /**
1.124 + @fn ExternalizeL(CDefaultLogOutput* aDefaultLogOutput)
1.125 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.126 + Error Condition : Leaves with an error code.
1.127 + @since 7.0
1.128 + @param TAny* A pointer to the object under test.
1.129 + @return None.
1.130 + @pre TDefaultLogOutput_StateAccessor is fully constructed.
1.131 + @post No change to the class under test, its internal state.
1.132 + is persisted.
1.133 + */
1.134 + inline void ExternalizeL(CDefaultLogOutput* aDefaultLogOutput);
1.135 + }; // TDefaultLogOutput_StateAccessor
1.136 +
1.137 +#include "DefaultLogOutputStateAccessor.inl"
1.138 +
1.139 +#endif // __DEFAULTLOGOUTPUTSTATEACCESSOR_H__
1.140 +