cbs/CbsServer/ServerInc/CCbsRecMessage.h
changeset 0 ff3b6d0fd310
equal deleted inserted replaced
-1:000000000000 0:ff3b6d0fd310
       
     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:  This file contains the header file of the CCbsRecMessage class
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CCBSRECMESSAGE_H
       
    20 #define CCBSRECMESSAGE_H
       
    21 
       
    22 // INCLUDES
       
    23 		/*****************************************************
       
    24 		*	Series 60 Customer / ETel
       
    25 		*	Series 60  ETel API
       
    26 		*****************************************************/
       
    27 #include <etelmm.h>
       
    28 
       
    29 #include "CbsCommon.h"
       
    30 #include "CCbsMessage.h"
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35 *   CCbsRecMessage represents a message page generated by CCbsRecEtelMonitor.
       
    36 *
       
    37 *   CCbsRecMessage is constructed from a CB message page received from 
       
    38 *   EPOC Telephony Server.
       
    39 */
       
    40 class CCbsRecMessage : public CCbsMessage
       
    41     {
       
    42     public:        // Constructors and destructors
       
    43 
       
    44         /**
       
    45         *   Constructs a new CCbsRecMessage based on TDes8&
       
    46         *   (which is a descriptor) received from EPOC Telephony Server.
       
    47         *   
       
    48         *   @param  aMessagePage        Source message descriptor
       
    49         *   @return                     A new instance of CCbsRecMessage
       
    50         */
       
    51         static CCbsRecMessage* NewL( const TDes8& aMessagePage );
       
    52 
       
    53         /**
       
    54         *   Copy constructor
       
    55         *
       
    56         *   @param  aMessagePage        Source CCbsRecMessage instance
       
    57         *   @return                     A new instance of CCbsRecMessage
       
    58         */
       
    59         static CCbsRecMessage* NewL( const CCbsMessage& aMessagePage );
       
    60 
       
    61         /**
       
    62         *   Destructor
       
    63         */
       
    64         ~CCbsRecMessage();     
       
    65 
       
    66     public:
       
    67 
       
    68         /**
       
    69         *   Returns the page number of this page in the message page sequence,
       
    70         *
       
    71         *   @return                     Page number of this page.
       
    72         */
       
    73         TUint ThisPage() const;
       
    74 
       
    75         /**
       
    76         *   Returns the total number of pages in this page's message.
       
    77         *
       
    78         *   @return                     Total number of pages in this message
       
    79         */
       
    80         TUint TotalPages() const;        
       
    81 
       
    82     public: // from CCbsMessage
       
    83 
       
    84         /**
       
    85         *   Returns the type of the message (only in WCDMA)
       
    86         *
       
    87         *   @return                     Type of this message
       
    88         */
       
    89         TInt MessageType() const;
       
    90 
       
    91     protected:
       
    92 
       
    93         /**
       
    94         *   Default constructor
       
    95         */
       
    96         CCbsRecMessage();
       
    97 
       
    98     private:
       
    99 
       
   100         /**
       
   101         *   2nd-phase constructor.
       
   102         *
       
   103         *   @param aMessagePage         Message page
       
   104         */
       
   105         void ConstructL( const TDes8& aMessagePage );
       
   106 
       
   107         /**
       
   108         *   2nd-phase copy constructor.
       
   109         *
       
   110         *   @param aMessagePage         Message page
       
   111         */
       
   112         void ConstructL( const CCbsMessage& aMessagePage ); 
       
   113 
       
   114 
       
   115     private:    // prohibited functions and operators
       
   116         
       
   117         // Copy constructor: NewL() used instead
       
   118         CCbsRecMessage( const CCbsRecMessage& );
       
   119 
       
   120         // Assignment operator
       
   121         CCbsRecMessage& operator=( const CCbsRecMessage& );
       
   122 
       
   123     };
       
   124 
       
   125 #endif // CCBSRECMESSAGE_H
       
   126 
       
   127 // End of File