satengine/SatServer/Engine/inc/TSatChannelIDInfo.h
changeset 46 2fa1fa551b0b
parent 42 35488577e233
child 48 78df25012fda
equal deleted inserted replaced
42:35488577e233 46:2fa1fa551b0b
     1 /*
       
     2 * Copyright (c) 2002-2005 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:  Information class for Channel IDs.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef TSATCHANNELIDINFO_H
       
    20 #define TSATCHANNELIDINFO_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32std.h>
       
    24 #include <e32base.h>
       
    25 
       
    26 // CLASS DECLARATION
       
    27 
       
    28 /**
       
    29 *  Container of Channel ID information
       
    30 *
       
    31 *  @lib SatEngine.lib
       
    32 *  @since Series 60 3.0
       
    33 */
       
    34 class TSatChannelIdInfo
       
    35     {
       
    36     public:
       
    37 
       
    38         /**
       
    39         * Constructor.
       
    40         * @param aChannelId Long version of channel ID
       
    41         * @param aShort Short version of channel ID
       
    42         */
       
    43         TSatChannelIdInfo( TInt aChannelId, TUint8 aShort );
       
    44 
       
    45         /**
       
    46         * Returns long channel ID
       
    47         * @return Long channel ID, range RSat::KChannel1-RSat::KChannel7
       
    48         */
       
    49         TInt ChannelId() const;
       
    50 
       
    51         /**
       
    52         * Returns short channel ID
       
    53         * @return Short channel id, range 1-7
       
    54         */
       
    55         TUint8 ShortChannelId() const;
       
    56 
       
    57         /**
       
    58         * Indicates is this channel ID in use
       
    59         * @return TBool indicating the availability of this channel ID
       
    60         */
       
    61         TBool IsReserved() const;
       
    62 
       
    63         /**
       
    64         * Reserves channel ID
       
    65         */
       
    66         void ReserveChannel();
       
    67 
       
    68         /**
       
    69         * Releases channel ID
       
    70         */
       
    71         void ReleaseChannel();
       
    72 
       
    73     private:
       
    74 
       
    75         // Long channel ID, range RSat::KChannel1 - RSat::KChannel7
       
    76         TInt    iChannelId;
       
    77 
       
    78         // Short channel ID, range 1 - 7
       
    79         TUint8  iShortChannelId;
       
    80 
       
    81         // Indicates is this channel in use of free
       
    82         TBool   iActive;
       
    83 
       
    84     };
       
    85 
       
    86 #endif      // TSATCHANNELIDINFO_H
       
    87 
       
    88 // End of File