clock2/clockengines/clocknitzplugin/inc/clocknitzpluginimpl.h
changeset 0 f979ecb2b13e
child 86 ed599363c2d7
equal deleted inserted replaced
-1:000000000000 0:f979ecb2b13e
       
     1 /*
       
     2 * Copyright (c) 2008 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:   The header file of CClockNitzPluginImpl class.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __CLOCKNITZ_PLUGINIMPL_H__ 
       
    19 #define __CLOCKNITZ_PLUGINIMPL_H__
       
    20 
       
    21 // System includes
       
    22 #include <etelmm.h>
       
    23 #include <e32base.h>
       
    24 
       
    25 // User includes
       
    26 #include "clocknitzlistener.h"
       
    27 
       
    28 // Forward declarations
       
    29 class CClockNitzPlugin;
       
    30 
       
    31 // Class declaration
       
    32 /** 
       
    33 * @class CClockNitzPluginImpl
       
    34 * @brief An instance of class CClockNitzPluginImpl which is the actual implementation of NITZ
       
    35 * 		 algorithm.
       
    36 * @dll clocknitzplugin.dll 
       
    37 */
       
    38 class CClockNitzPluginImpl : public CBase
       
    39 	{
       
    40 	public:			// Constructor and destructor
       
    41 	
       
    42 		/**
       
    43 		* @brief Creates a CClockNitzPluginImpl object
       
    44 		* @return CClockNitzPluginImpl*
       
    45 		*/
       
    46         static CClockNitzPluginImpl* NewL( CClockNitzPlugin* aNitzPlugin );
       
    47 		
       
    48 		/**
       
    49 		* @brief Destroy the object and release all memory objects
       
    50 		*/
       
    51 	    virtual ~CClockNitzPluginImpl();
       
    52 	    
       
    53 	public:			// New functions
       
    54 	
       
    55 		/**
       
    56 		* @brief From CClockTimeSourceInterface, pure virtual at the base. Need to implement here.
       
    57 		* @param aInterfaceAttribute of type TInterfaceAttribute, indicates the type of data requested.
       
    58 		* @param aTimeAttributes The type of data requested
       
    59 		*/
       
    60 		void GetTimeInformationL( TInterfaceAttribute aInterfaceAttribute, STimeAttributes* aTimeAttributes );
       
    61 		
       
    62 		/**
       
    63 		* @brief From CClockTimeSourceInterface, pure virtual at the base. Need to implement here.
       
    64 		* @param aInterfaceAttribute of type TInterfaceAttribute, indicates the type of data requested.
       
    65 		*/
       
    66 		void NotifyOnNITZInfoChange( TInterfaceAttribute aInterfaceAttribute );
       
    67 		
       
    68 		/**
       
    69 		* @brief Notifies any client in case NITZ info is received
       
    70 		* @param aNitzInfo RMobilePhone::TMobilePhoneNITZ
       
    71 		*/
       
    72 		void NotifyNITZInfoChangeL();
       
    73 		
       
    74 	private:		// New functions
       
    75 	
       
    76 		/**
       
    77 		* @brief C++ default constructor
       
    78 		*/
       
    79   		CClockNitzPluginImpl( CClockNitzPlugin* aNitzPlugin );
       
    80 		
       
    81 		/** 
       
    82 		* @brief Symbian OS 2nd phase constructor is private.
       
    83 		*/
       
    84 	    void ConstructL();
       
    85 	    
       
    86 	public:			// Data
       
    87 		
       
    88 		/**
       
    89 		* @var iNitzInfo 
       
    90 		* @brief User define NITZ info structure of type RMobilePhone::TMobilePhoneNITZ
       
    91 		*/
       
    92 		RMobilePhone::TMobilePhoneNITZ 	iNitzInfo;
       
    93 	    
       
    94 	private:		// Data
       
    95 		
       
    96 		/**
       
    97 		* @var iNitzSrv 
       
    98 		* @brief Interface to the NITZ server of type CClockNitzListener*
       
    99 		*/
       
   100 		CClockNitzListener*			   	iNitzSrv;
       
   101 		
       
   102 		/**
       
   103 		* @var iObserver 
       
   104 		* @brief This is essentially the plugin which is waiting for notification from the implementations.
       
   105 		*/
       
   106 		CClockNitzPlugin*				iNitzPlugin;
       
   107 	};
       
   108 
       
   109 #endif		// __CLOCKNITZ_PLUGINIMPL_H__
       
   110 
       
   111 // End of file