cbs/cbsserver/ServerInc/CCbsRecMessage.h
author hgs
Fri, 06 Aug 2010 13:08:23 +0300
changeset 36 7c428525956b
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201031
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  This file contains the header file of the CCbsRecMessage class
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef CCBSRECMESSAGE_H
hgs
parents:
diff changeset
    20
#define CCBSRECMESSAGE_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// INCLUDES
hgs
parents:
diff changeset
    23
		/*****************************************************
hgs
parents:
diff changeset
    24
		*	Series 60 Customer / ETel
hgs
parents:
diff changeset
    25
		*	Series 60  ETel API
hgs
parents:
diff changeset
    26
		*****************************************************/
hgs
parents:
diff changeset
    27
#include <etelmm.h>
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
#include "CbsCommon.h"
hgs
parents:
diff changeset
    30
#include "CCbsMessage.h"
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
// CLASS DECLARATION
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
/**
hgs
parents:
diff changeset
    35
*   CCbsRecMessage represents a message page generated by CCbsRecEtelMonitor.
hgs
parents:
diff changeset
    36
*
hgs
parents:
diff changeset
    37
*   CCbsRecMessage is constructed from a CB message page received from 
hgs
parents:
diff changeset
    38
*   EPOC Telephony Server.
hgs
parents:
diff changeset
    39
*/
hgs
parents:
diff changeset
    40
class CCbsRecMessage : public CCbsMessage
hgs
parents:
diff changeset
    41
    {
hgs
parents:
diff changeset
    42
    public:        // Constructors and destructors
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
        /**
hgs
parents:
diff changeset
    45
        *   Constructs a new CCbsRecMessage based on TDes8&
hgs
parents:
diff changeset
    46
        *   (which is a descriptor) received from EPOC Telephony Server.
hgs
parents:
diff changeset
    47
        *   
hgs
parents:
diff changeset
    48
        *   @param  aMessagePage        Source message descriptor
hgs
parents:
diff changeset
    49
        *   @return                     A new instance of CCbsRecMessage
hgs
parents:
diff changeset
    50
        */
hgs
parents:
diff changeset
    51
        static CCbsRecMessage* NewL( const TDes8& aMessagePage );
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
        /**
hgs
parents:
diff changeset
    54
        *   Copy constructor
hgs
parents:
diff changeset
    55
        *
hgs
parents:
diff changeset
    56
        *   @param  aMessagePage        Source CCbsRecMessage instance
hgs
parents:
diff changeset
    57
        *   @return                     A new instance of CCbsRecMessage
hgs
parents:
diff changeset
    58
        */
hgs
parents:
diff changeset
    59
        static CCbsRecMessage* NewL( const CCbsMessage& aMessagePage );
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
        /**
hgs
parents:
diff changeset
    62
        *   Destructor
hgs
parents:
diff changeset
    63
        */
hgs
parents:
diff changeset
    64
        ~CCbsRecMessage();     
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
    public:
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
        /**
hgs
parents:
diff changeset
    69
        *   Returns the page number of this page in the message page sequence,
hgs
parents:
diff changeset
    70
        *
hgs
parents:
diff changeset
    71
        *   @return                     Page number of this page.
hgs
parents:
diff changeset
    72
        */
hgs
parents:
diff changeset
    73
        TUint ThisPage() const;
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
        /**
hgs
parents:
diff changeset
    76
        *   Returns the total number of pages in this page's message.
hgs
parents:
diff changeset
    77
        *
hgs
parents:
diff changeset
    78
        *   @return                     Total number of pages in this message
hgs
parents:
diff changeset
    79
        */
hgs
parents:
diff changeset
    80
        TUint TotalPages() const;        
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
    public: // from CCbsMessage
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
        /**
hgs
parents:
diff changeset
    85
        *   Returns the type of the message (only in WCDMA)
hgs
parents:
diff changeset
    86
        *
hgs
parents:
diff changeset
    87
        *   @return                     Type of this message
hgs
parents:
diff changeset
    88
        */
hgs
parents:
diff changeset
    89
        TInt MessageType() const;
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
    protected:
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
        /**
hgs
parents:
diff changeset
    94
        *   Default constructor
hgs
parents:
diff changeset
    95
        */
hgs
parents:
diff changeset
    96
        CCbsRecMessage();
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
    private:
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
        /**
hgs
parents:
diff changeset
   101
        *   2nd-phase constructor.
hgs
parents:
diff changeset
   102
        *
hgs
parents:
diff changeset
   103
        *   @param aMessagePage         Message page
hgs
parents:
diff changeset
   104
        */
hgs
parents:
diff changeset
   105
        void ConstructL( const TDes8& aMessagePage );
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
        /**
hgs
parents:
diff changeset
   108
        *   2nd-phase copy constructor.
hgs
parents:
diff changeset
   109
        *
hgs
parents:
diff changeset
   110
        *   @param aMessagePage         Message page
hgs
parents:
diff changeset
   111
        */
hgs
parents:
diff changeset
   112
        void ConstructL( const CCbsMessage& aMessagePage ); 
hgs
parents:
diff changeset
   113
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
    private:    // prohibited functions and operators
hgs
parents:
diff changeset
   116
        
hgs
parents:
diff changeset
   117
        // Copy constructor: NewL() used instead
hgs
parents:
diff changeset
   118
        CCbsRecMessage( const CCbsRecMessage& );
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
        // Assignment operator
hgs
parents:
diff changeset
   121
        CCbsRecMessage& operator=( const CCbsRecMessage& );
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
    };
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
#endif // CCBSRECMESSAGE_H
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
// End of File