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