/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "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:  This file contains the header file of the CPEEngineInfoImpl object.

*

*/

#ifndef CPEENGINEINFOIMPL_H

#define CPEENGINEINFOIMPL_H

//INCLUDES

#include <e32base.h>

#include <badesca.h>

#include <ccpdefs.h>

#include <pevirtualengine.h>

#include "cperemoteinfo.h"

#include "mpedatastore.h"

#include "cpeengineinfo.h"

// CONSTANTS

// None.

// MACROS

// None.

// DATA TYPES

NONSHARABLE_STRUCT( TPECallCommandInfo )                  // For Mobile Originated Call Commands

    {

    TChar iKeyCode;                         // pressed key code

    TInt iAudioMute;                        // state of microphone ( 0 = false, 1 = true )

    TInt iAudioVolume;                      // Audio volume

    TPEAudioOutput iAudioOutput;            // audio output path

    TBool iShowNote;                        // Status of call audio route info note.

    TInt iCallId;                           // Calls ID

    TPEDtmfString iDtmfString;              // Dtmf string to be sent.

    TPEPhoneNumber iPhoneNumber;            // Dialed Phonenumber, set by client

    TPECallType iCallType;                  // Type of the attempted call

    TUint32 iServiceId;                     // ServiceId    

    TPECallOrigin iCallOrigin;              // Origin of the attempted call (Phone, client or SAT)

    RMobileCall::TMobileCallIdRestriction iIdRestrict; // Call Id restriction setting to be used for this call

    TPEPhoneNumber iEmergencyNumber;        // For checking is this number emergency number.

    TPEUserToUserInfo iUserToUserInfo;      // User to user information.

    TPEPhoneNumber iSwitchToNumber;         // Dialed Phonenumber, set by client

    TPEPhoneNumber iTransferToAddress;      // Unattended transfer target address   

    TInt iForwardToAddressIndex;            // Array index for a address to be forwarded

    };

NONSHARABLE_STRUCT( TPEBasicInfo )                         // Contains information of the phone related variables 

    {

    TBool iAudioMute;                       // state of microphone.                 

    TBool iTwoDigitSupportStatus;           // Two Digit support status

    TBool iALSLineSupport;                  // ALS line support.                

    TInt iAudioOutputPreference;            // Audio output preference (private/public) - TODO: change type to enum when available

    TInt iAudioVolume;                      // Audio volume                 

    TInt iKeypadVolume;                     // Keypad volume                    

    TInt iLastCallDuration;                 // Call duration (seconds)                  

    TInt iPersonalToneStatus;               // Personal tone status                 

    TInt iProfileId;                        // the id number of the profile                 

    TInt iRingingVolume;                    // Current ringing volume                   

    TBool iTextToSpeech;                    // Current text-to-speech setting

    TBool iPhoneNumberIsServiceCode;        // flag indicating if the phone number is a service code

    TNWNetworkRegistrationStatus iNetworkRegistrationStatus;                    

    CCCECallParameters::TCCELineType iALSLine;        // includes active als line.                  

    TPEContactFileName iRingingToneName1;   // Current ringingtone name                 

    TPEContactFileName iRingingToneName2;

    TPEContactFileName iVideoCallRingingTone; // Video call ringingtone name                                    

    TPEDtmfString iDtmfString;              // Dtmf string.                 

    TPEErrorInfo iErrorInfo;                // possible error code                  

    TPEProfileName iProfileName;            // the name of the profile                  

    TProfileRingingType iRingingType;       // Includes current ringing type                    

    TPEVoiceMailBoxNumberInfo iVMBXNumbers; // Voice mail box numbers

    TPEPhoneAudioRouteParameters iPhoneAudioRouteParameters; // the phone audio route parameters

    TCCPTone iInbandTone;                   // Inband tone needed to play in a call state transition or error

    TPEActiveForwardInfo iActiveForward;    // active forward information.

    TPEBarringInfo iBarringInfo;            // includes call barring information.

    TPESimState iSimState;

    TPESSCommandInfo iSSCommandInfo;        // Contains information of the Suplementary Services command.

    TBool iSecureSpecified;                 // Secure specified status

    TName iDataPortName;                    // the name of data port currently on-loan

    TBool iSwitchToOngoing;                 // Switch to operation status

    };

NONSHARABLE_STRUCT( TPEConferenceCallInfo ) // Contains conference call related variables 

    {

    TPEState iConferenceCallState;

    };

class CPECallInfo;

// CLASS DECLARATION

/**

*  Handles telephony related information structures.

*  

*

*  @lib engineinfo.lib

*  @since Series60_4.0

*/

NONSHARABLE_CLASS( CPEEngineInfoImpl )

        : public CPEEngineInfo

{

    public:     //Constructors and destructor

        /**

        * Two-phased constructor.

        */

        IMPORT_C static CPEEngineInfoImpl* NewL();

        /**

        * Destructor.

        */

        virtual ~CPEEngineInfoImpl();

    public:     //New functions

        // Functions from MPEEngineInfo

        /**

        * Gets active als line of the phone from TPEBasicInfo-structure

        * @return active als line of the phone

        */

        const CCCECallParameters::TCCELineType& ALSLine() const;

        /**

        * Gets ALS support of the phone from TPEBasicInfo-structure

        * @return ETrue if als is supported.

        */

        const TBool& ALSLineSupport() const;

        /**

        * Gets audio mute value

        * @return audio mute value

        */

        const TBool& AudioMute() const;

        /**

        * Gets current audio output path

        * @return audio output path

        */

        const TPEAudioOutput& AudioOutput() const;

        /**

        * Gets phone audio route parameters

        * @return phone audio route parameters. 

        */

        const TPEPhoneAudioRouteParameters& RouteParameters() const;

        /**

        * Gets audio output path availability

        * @return audio output path availability status

        */

        TBool AudioOutputAvailable( 

            const TPEAudioOutput aOutput ) const;

        /**

        * Gets audio output preference

        * @return audio output preference

        */

        const TInt& AudioOutputPreference() const;

        /**

        * Gets audio volume value

        * @return audio volume value

        */

        const TInt& AudioVolume() const;

        /**

        * Gets call direction of the specified call

        * @param aCallId is the call identification number

        * @return call direction of the specified call

        */

        RMobileCall::TMobileCallDirection CallDirection( 

            const TInt aCallId ) const;

        /**

        * Gets duration of the last call to go idle

        * @return call duration of the last active call

        */

        const TInt& CallDuration() const;

        /**

        * Gets call duration of the ongoing or last active call with specified id

        * @param aCallId is the call identification number

        * @return call duration of the ongoing or last active call

        */

        TTimeIntervalSeconds CallDuration( const TInt aCallId ) const;

        /**

        * Gets line information for the specified call

        * @param aCallId is the call identification number

        * @return line information for the specified call

        */

        CCCECallParameters::TCCELineType CallALSLine( const TInt aCallId ) const;

        /**

        * Gets call origin for next call attempt

        * @return value indicates if the call is phone, client or SAT originated

        */

        const TPECallOrigin& CallOriginCommand() const;

        /**

        * Gets start time for the specified call

        * @param aCallId is the call identification number

        * @return time of the call

        */

        const TTime& CallStartTime( const TInt aCallId ) const;

        /**

        * Gets state of the specified call

        * @param aCallId is the call identification number.

        * @return call state of a specified call

        */

        TPEState CallState( const TInt aCallId ) const;

        /**

        * Gets type of the specified call

        * @param aCallId is the call identification number.

        * @return call state of a specified call

        */

        TPECallType CallType( const TInt aCallId ) const;

        /**

        * Gets call state of a conference call

        * @return call state

        */

        TPEState ConferenceCallState() const;

        /**

        * Gets the name of data port currently on-loan.

        * Data port loaning is handled by CSPlugin and happens when a data

        * call goes into connected state. The dataport is released when VT components

        * indicate it can be released, i.e. video call hangup.

        * @return data port name

        */

        const TName& DataPortName() const;

        /**

        * Gets secure status from call info

        * @param aCallId is the call identification number.

        * @return TBool the secure status (on/off)

        */

        TBool IsSecureCall( const TInt aCallId ) const;

        /**

        * Gets dtmf postfix

        * @param aCallId is the call identification number.

        * @return dtmf postfix

        */

        const TPEDtmfString& DtmfPostFix( const TInt aCallId ) const;

        /**

        * Gets dtmf string

        * @return dtmf string

        */

        const TPEDtmfString& DtmfString() const;

        /**

        * Gets error code and cause values for the latest error

        * @return error code and cause values for the latest error

        */

        const TPEErrorInfo& ErrorInfo() const;

        /**

        * Gets correct inband tone for specific call state transition or error

        * @return the inband tone to be played

        */

        const TCCPTone& InbandTone() const;

        /**

        * Gets network registration status

        * @return TNWNetworkRegistrationStatus Network registration status

        */

        const TNWNetworkRegistrationStatus& NetworkRegistrationStatus() const;

        /**

        * Gets phone number

        * @return Reference to TPEPhoneNumber, containing the phone number of the remote party.

        */

        const TPEPhoneNumber& PhoneNumber() const;

        /**

        * Gets phone number parsing result

        * @return ETrue if phone number is a service code

        */

        const TBool& PhoneNumberIsServiceCode() const;

        /**

        * Gets profile id

        * @return profile id

        */

        const TInt& ProfileId() const;

        /**

        * Gets remote party identity 

        * @param aCallId is the Call identification number

        * @return remote party identity

        */

        RMobileCall::TMobileCallRemoteIdentityStatus RemoteIdentity( 

            const TInt aCallId ) const;

        /**

        * Gets ringing type

        * @return ringing type

        */

        const TProfileRingingType& RingingType() const;

        /**

        * Sets active als line value to the TPEGsmBasicInfo structure.

        * @param aALSLine is the active als line value.

        */

        void SetALSLine( const CCCECallParameters::TCCELineType& aALSLine );

        /**

        * Sets ALS support value to the TPEGsmBasicInfo structure.

        * @param aALSLineSupport is the ALS support value.

        */

        void SetALSLineSupport( const TBool& aALSLineSupport );

        /**

        * Sets audio mute command to TPEBasicInfo-structure

        * @param aAudioMute is audio mute

        */

        void SetAudioMuteCommand( const TInt& aAudioMute );

        /**

        * Sets audio output command to TPEBasicInfo-structure

        * @param aOutput is audio output path

        * @param aShowNote is audio note value 

        * @return None.

        */

        void SetAudioOutputCommand( const TPEAudioOutput& aOutput,

                                             const TBool aShowNote  );

        /**

        * Sets audio volume of the phone to TPEBasicInfo-structure

        * @param aAudioVolume is audio volume of the phone

        */

        void SetAudioVolumeCommand( const TInt& aAudioVolume );

        /**

        * Sets CallId value to TPECallCommandInfo-structure

        * @param aPhoneMumber is the phone number

        */ 

        void SetCallId( const TInt& aCallId );

        /**

        * Sets alsline value to TPEGsmCallInfo-structure

        * @param aALSLine informs which line is selected active

        * @param aCallId is the Call identification number.

        */

        void SetCallALSLine( const CCCECallParameters::TCCELineType& aALSLine, const TInt aCallId );

        /**

        * Sets call type information for the following command message

        * @param aCallType is call type value.

        * @param aCallId is the Call identification number.

        */

        void SetCallTypeCommand( const TPECallType& aCallType );

        /**

        * Sets the name of data port currently on-loan.

        * Data port loaning is handled by CSPlugin and happens when a data

        * call goes into connected state. The dataport is released when VT components

        * indicate it can be released, i.e. video call hangup.

        * @param aName is Data port name

        */

        void SetDataPortName( const TName& aDataPortName );

        /**

        * Sets dtmf string value to TPECommandInfo-structure

        * @param aDtmfString is the dtmf string to be sent. 

        */

        void SetDtmfStringCommand( const TPEDtmfString& aDtmfString );

        /**

        * Sets correct inband tone for specific call state transition or error

        * @param aTone is the inband tone to be played

        */

        void SetInbandTone( const TCCPTone aTone ) ;

        /**

        * Sets key code value to TPECallCommandInfo-structure

        * @param aKeyCode is the ascii coded key code.

        */

        void SetKeyCode( const TChar& aKeyCode );

        /**

        * Sets phone number to TPECallCommandInfo-structure

        * @param aPhoneNumber is the phone number

        */

        void SetPhoneNumber( const TPEPhoneNumber& aPhoneNumber );

        /**

        * Gets active forwarding information from TPEBasicInfo-structure

        * @return deflect information

        */

        const TPEActiveForwardInfo& ActiveForwardingInfo() const;

        /**

        * Gets barring information from TPEBasicInfo-structure

        * @return barring information

        */

        const TPEBarringInfo& BarringInfo() const;

        /**

        * Gets conference value from TPECallInfo-structure

        * @param aCallId is the call identification number

        * @return call conference value

        */

        TInt CallConference( const TInt aCallId ) const;

        /**

        * Gets call control caps from the TPECallInfo-structure

        * @param aCallId is the call identification number

        * @return call control capabilities

        */

        TPECallControlCaps CallControlCaps( const TInt aCallId ) const;

        /**

        * Gets forwarded value from TPECallInfo-structure

        * @param aCallId is the call identification number

        * @return is call forwarded or not

        */

        TBool CallForwarded( const TInt aCallId ) const;

        /**

        * Gets Service information from TPECallInfo-structure

        * @param aCallId is the call identification number.

        * @return mobile call service type

        */

        RMobilePhone::TMobileService CallService( const TInt aCallId ) const;

        /**

        * Gets Conference call capabilities

        * @param aCallId is the call identification number

        * @return conference call capabilities

        */

        TUint32 ConferenceCallCaps( const TInt aCallId ) const;

        /**

        * Gets Conference call capabilities

        * @param aCallId is the call identification number

        * @return conference call member name

        */

        const TName& ConferenceMemberName( const TInt aCallId ) const;

        /**

        * Gets Conference call capabilities

        * @param aCallId is the call identification number

        * @return conference call member id

        */

        TInt IsConferenceMemberId( const TInt aCallId ) const;

        /**

        * Gets number of the conference members

        * @param aCallId is the call identification number

        * @return number of conference members

        */

        TInt NumberOfConferenceMembers( const TInt aCallId ) const;

        /**

        * Gets Sim state

        * @return current Sim state

        */

        const TPESimState& SimState() const;

        /**

        * Gets secure specified status from call info

        * @return TBool the secure specified status (on/off)

        */

        TBool SecureSpecified( ) const;

        /**

        * Gets the last suplementary services string command information 

        * from TPESSCommandInfo-structure

        * @since Series90_1.1

        * @return Suplementary Services command information. 

        */

        const TPESSCommandInfo& SSCommandInfo() const;

        /**

        * Sets emergency numbers of the phone to TPEGsmBasicInfo-structure

        * @since Series90_1.1

        * @param aEmergencyNumber for emergency number checking.

        * @return None.

        */

        void SetEmergencyNumber( const TPEPhoneNumber& aEmergencyNumbers );

        /**

         * Gets remote party name. Contains possible CNAP name or received 

         * skype identification

         * @param aCallId Call identification number.

         * @return Name of the remote party detemined by network.

         */

        const TPEContactName& RemotePartyName( 

            const TInt aCallId ) const;

        /**

         * Gets error code from TPEBasicInfo-structure

         * @return Error code

         */

         TInt ErrorCode() const;

         /**

         * Sets switch to  number to TPECallCommandInfo-structure

         * @param aPhoneNumber is the phone number

         */

         void SetSwitchToNumberCommand( const TPEPhoneNumber& aPhoneNumber );

         /**

         * Gets switch to number

         * @return Reference to TPEPhoneNumber, containing the phone number.

         */

         const TPEPhoneNumber& SwitchToNumberCommand() const;

         /**

          * Returns transfer target from the last received unattended transfer 

          * request or KNullDesC if transfer target is not available.