1 /*

     2 * Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Factory class for creating logger manager and for getting

    15 *				 interfaces for read and write access to history files.

    16 *

    17 */

    18 

    19 

    20 #ifndef __CALOGGERMANAGERFACTORY_H__

    21 #define __CALOGGERMANAGERFACTORY_H__

    22 

    23 //  INCLUDES

    24 

    25 #include <e32std.h>

    26 #include <e32base.h>

    27 

    28 // FORWARD DECLARATIONS

    29 

    30 class MCALoggerMessageFactory;

    31 class MCALoggerReadInterface;

    32 class MCALoggerWriteInterface;

    33 

    34 // CLASS DECLARATION

    35 

    36 /**

    37  *  Logger manager with read access to history files.

    38  *

    39  *  @lib CALogger.dll

    40  *  @since 2.1

    41  */

    42 class CALoggerManagerFactory // CSI: 51 # Not a C-class although begins with CA

    43     {

    44 

    45     private:

    46 

    47         /**

    48          *	Destructor

    49          */

    50         ~CALoggerManagerFactory();

    51 

    52         /**

    53          *	Constructor

    54          */

    55         CALoggerManagerFactory();

    56 

    57         /**

    58          *	Copy constructor

    59          *	@param aOther Copy source.

    60          */

    61         CALoggerManagerFactory( const CALoggerManagerFactory& aOther );

    62 

    63     public:

    64 

    65         /**

    66          *	Calls CCALoggerManagers ReadInstanceL.

    67          *	Caller cannot delete the returned pointer.

    68          *	@since 2.1

    69          *  @param aMessageFactory Factory which is used for message and header

    70          *							creation.NULL value is ignored and not set.

    71          *	@return Read interface to access to history data.

    72          */

    73         IMPORT_C static MCALoggerReadInterface* ReadInstanceL(

    74             MCALoggerMessageFactory* aMessageFactory = NULL, TBool aFirstTime = ETrue );

    75 

    76         /**

    77          *	Calls CCALoggermanagers WriteInstanceL

    78          *	Caller must delete the returned pointer,

    79          *	when it is not needed anymore. Ownership

    80          *	will be transfered to caller.

    81          *	@since 2.1

    82          *  @param aMessageFactory Factory which is used for message and header

    83          *							creation.NULL value is ignored and not set.

    84          *	@return Write interface for writing history data.

    85          */

    86         IMPORT_C static MCALoggerWriteInterface* WriteInstanceL(

    87             MCALoggerMessageFactory* aMessageFactory = NULL );

    88 

    89         /**

    90          *	Release Logger manager instance. This is for testing only.

    91          *	Calls CCALoggerManagers ReleaseInstanceL;

    92          *	@since 2.1

    93          */

    94         IMPORT_C static void ReleaseInstanceL();

    95     };

    96 

    97 #endif      // __CCALOGGERMANAGERFACTORY_H__

    98 

    99 // End of File