/*

* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

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

* which accompanies this distribution, and is available

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

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

#ifndef SATNOTIFICATIONS_H

#define SATNOTIFICATIONS_H

//  INCLUDES

#include <e32base.h>    // base class cbase

#include <etelsat.h>    // etel sat response packages

#include <et_tsy.h>     // type declarations for tsy

// CONSTANTS

const TUint8 KRefreshMasterFileHeader             = 0x3F;

// FORWARD DECLARATIONS

class CSatMessHandler;

class CTsySatMessaging;

class TIsiReceiveC;

class CBerTlv;

class CTlv;

// CLASS DECLARATION

/**

*  Sat notifications base class.

*  Base class for SAT command notification classes.

*

*  @lib SIMATKTSY.LIB

*  @since Series 60 Series60_2.6

*/

class CSatNotificationsBase : public CBase

    {

    protected:    // Constructors

        /**

        * C++ default constructor.

        * @since NCP 5.0

        * @param aSatMessHandler pointer to satmessagehandler class

        * @param aSatMessaging pointer to satmessaging class

        */

        CSatNotificationsBase( CSatMessHandler* aSatMessHandler,

            CTsySatMessaging* aSatMessaging );

    public:  // Destructor

        /**

        * Destructor.

        * @since NCP 5.0

        */

        virtual ~CSatNotificationsBase();

    public:     // Pure virtuals

        /**

        * Pure virtual method for derived classes. Handles PCmd ISI messages

        * from phonet which is an interface to CellMo software.

        * @since NCP 5.0

        * @param aIsiMessage received ISI message

        * @return none

        */

        virtual void MessageReceived( const TIsiReceiveC& aIsiMessage ) = 0;

        /**

        * Pure virtual method for derived classes. Etel SAT Notification

        * request.

        * @since Series 60 Series60_2.6

        * @param aReqHandle notify request handle. The request handle

        * has to be non-null (.i.e pending request) in order to process

        * an incoming PCmd ISI message

        * @param aDataPtr pointer to a descriptor. Usually the pointer is

        * casted to a suitable ETel SAT data package in order to access

        * structured data fields and parameters. This is the first step

        * in the adaptation process, CellMo to Symbian.

        * @return none

        */

        virtual void Notify( const TTsyReqHandle aReqHandle,

            TDes8* aDataPtr = NULL ) = 0;

    public:     // New methods

        /**

        * Cancels notification request.

        * @since Series 60 Series60_2.6

        * @param aReqHandle notify request handle

        * @return status

        */

        TInt CancelNotification( const TTsyReqHandle aReqHandle );

        /**

        * Virtual method for derived classes. Handles the

        * terminal response

        * @since NCP 5.0

        * @param aRsp Pointer to a descriptor. Usually the pointer is

        * casted to a suitable ETel SAT data package in order to access

        * structured data fields and parameters. This is the first step

        * in the adaptation process, Symbian to CellMo. The terminal

        * response is reshaped into an ISI message.

        * @return status

        */

        virtual TInt TerminalResponse( TDes8* aRsp );

        /**

        * Return command details of the current proactive command

        * @since Series 60 Series60_2.6

        * @param none

        * @return reference to a descriptor containing the PCmd's command

        * details TLV.

        */

        TDes8& GetCmdDetails();

        /**

        * Return the transaction identifier of the current PCmd ISI message.

        * The transaction identifier is a CellMo specific value.

        * This value cannot be used by Etel clients.

        * @since Series 60 Series60_2.6

        * @param none

        * @return TUint8 Transaction Id value (0-255)

        */

        TUint8 GetTransactionId();

    protected: // New methods

        /**

        * Returns TsyReqhandle to the caller

        * @since Series 60 Series60_2.6

        * param none

        * @return TsyReqHandle

        */

        TTsyReqHandle TsyReqHandle();

        /**

        * Completes the notify request to Etel

        * @since Series 60 Series60_2.6

        * @param aError possible error code

        * @return none

        */

        void CompleteRequest( const TInt aError );

    protected: // Private nested class

        // CLASS DECLARATION

        /**

        *  Protected Sat notifications nested class.

        *  Contains the allowed general results for the specific command

        *

        *  @since NCP 5.1

        */

        class TAllowedResults

            {

            public:

                /**

                * C++ default constructor.

                * @since NCP 5.1

                */

                TAllowedResults();

                /**

                * Equals-operator for TAllowedResults-class. Test wether

                * the provided general result is allowed for the command

                * or not.

                * @since NCP 5.1

                * @param aResult Result to be tested

                * @return ETrue if allowed, EFalse if not.

                */

                TBool operator==( const RSat::TPCmdResult aResult ) const;

                /**

                * Nonequals-operator for TAllowedResults-class. Test wether

                * the provided general result is not allowed for the command

                * or not.

                * @since NCP 5.1

                * @param aResult Result to be tested

                * @return ETrue if not allowed, otherwise EFalse.

                */

                TBool operator!=( const RSat::TPCmdResult aResult ) const;

                /**

                * Assignment operator for TAllowedResults-class. Provided

                * general result is allowed for command.

                * (results = RSat::KSuccess)

                * @since NCP 5.1

                * @param aResult Result to be allowed

                * @return TAllowedResults-class

                */

                TAllowedResults& operator=( const RSat::TPCmdResult aResult );

                /**

                * Increment operator for TAllowedResults-class. Provided

                * general result is allowed for command.

                * (results += RSat::KPartialComprehension)

                * @since NCP 5.1

                * @param aResult Result to be allowed

                * @return TAllowedResults-class

                */

                TAllowedResults& operator+=( const RSat::TPCmdResult aResult );

                /**

                * Increment operator for TAllowedResults-class. Results allowed

                * by the provided results-class are appended.

                * (results += otherResults)

                * @since NCP 5.1

                * @param aResults Results to be allowed

                * @return TAllowedResults-class

                */

                TAllowedResults& operator+=( const TAllowedResults aResults );

                /**

                * Increment operator for TAllowedResults-class. Provided

                * general result is allowed for command.

                * (results = results + RSat::KSuccess)

                * @since NCP 5.1

                * @param aResult Result to be allowed

                * @return TAllowedResults-class

                */

                TAllowedResults& operator+( const RSat::TPCmdResult aResult );

            private:    // Methods

                /**

                * Creates 64-bit field from the provided general result

                * @since NCP 5.1

                * @param aResult Result to be converted

                * @return Bit field representing the general result

                */

                inline TUint64 CreateBitField( const RSat::TPCmdResult aResult ) const;

            private:    // Members

                // Bit field holding the allowed results

                TUint64     iResultField;

            };

    protected: // Data

        // Sat messagehandler pointer

        CSatMessHandler*    iSatMessHandler;

        // Sat messaging pointer

        CTsySatMessaging*   iSatMessaging;

        // Command details Tlv

        TBuf8<5>            iCommandDetails;

        // Transaction ID (0-255)

        TUint8              iTransId;

        // Request handle, coming from ETel

        TTsyReqHandle       iReqHandle;

        // Bit field for allowed general results for specific command

        TAllowedResults     iAllowedResults;

    private: // Friend methods

        /**

        * Overwrite the default plus operator for general results. Combines

        * results into TAllowedResults-class. Has to be declared as a friend

        * method to enable the usage of internal TAllowedResults-class.

        * (results = RSat::KSuccess + RSat::KPartialComprehension)

        * @since NCP 5.1

        * @param aResultA First result to be allowed

        * @param aResultB Second result to be allowed

        * @return TAllowedResults-class

        */

        friend TAllowedResults operator+( const RSat::TPCmdResult aResultA,

            const RSat::TPCmdResult aResultB );

    };

/**

*  SAT Display Text notification class.

*  Instantiated by CSatMessaging class.

*  This PCmd instructs the SAT to display a text message.

*  It allows SIM to define the priority of that message,

*  and the text string format.

*

*  @lib SIMATKTSY.lib

*  @since Series 60 Series60_2.6

*/

class CSatNotifyDisplayText : public CSatNotificationsBase

    {

    public:  // Constructors and destructor

        /**

        * C++ default constructor.

        * @since NCP 5.0

        * @param aSatMessHandler pointer to satmessagehandler class

        * @param aSatMessaging pointer to satmessaging class

        */

        CSatNotifyDisplayText( CSatMessHandler* aSatMessHandler,

            CTsySatMessaging* aSatMessaging );

        /**

        * Destructor.

        */

        ~CSatNotifyDisplayText();

    public: // Methods from base classes

        /**

        * From CSatNotificationsBase Handles DisplayText PCmd ISI message

        * @since NCP 5.0

        * @param aIsiMessage received ISI message

        * @return none

        */

        void MessageReceived( const TIsiReceiveC& aIsiMessage );

        /**

        * From CSatNotificationsBase Notification request received from

        * ETel client

        * @since Series 60 Series60_2.6

        * @param aReqHandle request handle from ETel

        * @param aDataPtr pointer to parameter class

        * @return none

        */

        void Notify( const TTsyReqHandle aReqHandle, TDes8* aDataPtr = NULL );

        /**

        * From CSatNotificationsBase Handles the Display text terminal response

        * @since Series 60 Series60_2.6

        * @param aRsp pointer to a descriptor containing the response structure

        * @return status

        */

        TInt TerminalResponse( TDes8* aRsp );

    private: // Data

        // Package allocated by an Etel client

        RSat::TDisplayTextV2Pckg* iDisplayTextV2Pckg;

    };

/**

*  SAT Get Inkey notification class.

*  Instantiated by CSatMessaging class.

*  This PCmd instructs the SAT to display text and expect the user

*  to enter a single character. Any response entered by the user shall

*  be passed transparently by the SAT to the SIM.

*

*  @lib SIMATKTSY.lib

*  @since Series 60 Series60_2.6

*/

class CSatNotifyGetInkey : public CSatNotificationsBase

    {

    public:  // Constructors and destructor

        /**

        * C++ default constructor.

        * @since NCP 5.0

        * @param aSatMessHandler pointer to satmessagehandler class

        * @param aSatMessaging pointer to satmessaging class

        */

        CSatNotifyGetInkey( CSatMessHandler* aSatMessHandler,

            CTsySatMessaging* aSatMessaging );

        /**

        * Destructor.

        */

        ~CSatNotifyGetInkey();

    public: // Methods from base classes

        /**

        * From CSatNotificationsBase Handles GetInkey PCmd ISI message

        * @since NCP 5.0

        * @param aIsiMessage received ISI message

        * @return none

        */

        void MessageReceived( const TIsiReceiveC& aIsiMessage );

        /**

        * From CSatNotificationsBase Notification request received from

        * ETel client

        * @since Series 60 Series60_2.6

        * @param aReqHandle request handle from ETel

        * @param aDataPtr pointer to parameter class

        * @return none

        */

        void Notify( const TTsyReqHandle aReqHandle, TDes8* aDataPtr = NULL );

        /**

        * From CSatNotificationsBase Handles the Get Inkey terminal response

        * @since Series 60 Series60_2.6

        * @param aRsp pointer to a descriptor containing the response structure

        * @return status

        */

        TInt TerminalResponse( TDes8* aRsp );

    private: // Data

        // Package allocated by an Etel client

        RSat::TGetInkeyV2Pckg* iGetInkeyV2Pckg;

    };

/**

*  SAT Get Input notification class.

*  Instantiated by CSatMessaging class.

*  This PCmd instructs the SAT to display text and that any

*  response string entered by the user shall be passed

*  by the SAT to the SIM. If the SIM provides a default text,

*  the SAT shall display this default text, which user may accept,

*  reject or edit as the response string.

*

*  @lib SIMATKTSY.lib

*  @since Series 60 Series60_2.6

*/

class CSatNotifyGetInput : public CSatNotificationsBase

    {

    public:  // Constructors and destructor

        /**

        * C++ default constructor.

        * @since NCP 5.0

        * @param aSatMessHandler pointer to satmessagehandler class

        * @param aSatMessaging pointer to satmessaging class

        */

        CSatNotifyGetInput( CSatMessHandler* aSatMessHandler,

            CTsySatMessaging* aSatMessaging );

        /**

        * Destructor.

        */

        ~CSatNotifyGetInput();

    public: // Methods from base classes

        /**

        * From CSatNotificationsBase Handles GetInput PCmd ISI message

        * @since NCP 5.0

        * @param aIsiMessage received ISI message

        * @return none

        */

        void MessageReceived( const TIsiReceiveC& aIsiMessage );

        /**

        * From CSatNotificationsBase Notification request received from

        * ETel client

        * @since Series 60 Series60_2.6

        * @param aReqHandle request handle from ETel

        * @param aDataPtr pointer to parameter class

        * @return none

        */

        void Notify( const TTsyReqHandle aReqHandle, TDes8* aDataPtr = NULL );

        /**

        * From CSatNotificationsBase Handles the Get Input terminal response

        * @since Series 60 Series60_2.6

        * @param aRsp pointer to a descriptor containing the response structure

        * @return status

        */

        TInt TerminalResponse( TDes8* aRsp );

    private: // Data

        // Package received from ETel

        RSat::TGetInputV1Pckg* iGetInputV1Pckg;

    };

/**

*  SAT Play Tone notification class.

*  Instantiated by CSatMessaging class.

*  This PCmd instructs the SAT to play an audio tone.

*

*  @lib SIMATKTSY.lib

*  @since Series 60 Series60_2.6

*/

class CSatNotifyPlayTone : public CSatNotificationsBase

    {

    public:  // Constructors and destructor

        /**

        * C++ default constructor.

        * @since NCP 5.0

        * @param aSatMessHandler pointer to satmessagehandler class

        * @param aSatMessaging pointer to satmessaging class

        */

        CSatNotifyPlayTone( CSatMessHandler* aSatMessHandler,

            CTsySatMessaging* aSatMessaging );

        /**

        * Destructor.

        */

        ~CSatNotifyPlayTone();

    public: // Methods from base classes

        /**

        * From CSatNotificationsBase Handles PlayTone PCmd ISI message

        * @since NCP 5.0

        * @param aIsiMessage received ISI message

        * @return none

        */

        void MessageReceived( const TIsiReceiveC& aIsiMessage );

        /**