1 /*

     2 * Copyright (c) 2002-2006 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:   Declaration of the ScanListIterator class

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef HSSSCANLISTITERATOR_H

    21 #define HSSSCANLISTITERATOR_H

    22 

    23 #include "hssscanlist.h"

    24 

    25 class HssScanList;

    26 

    27 /**

    28 *  Iterator for TScanList.

    29 */

    30 class HssScanListIterator

    31 {

    32 public:

    33 

    34     /**

    35     * Return the size of the scan info. The size includes Status Info,

    36     * MAC header and Frame Body.

    37     * @return The size of the scan info in bytes.

    38     */

    39     inline TUint16 Size() const;

    40 

    41     /**

    42     * Find the data of the first access point.

    43     * @return Pointer at the beginning of the first access point stored 

    44     *         in the scan list. NULL if not any.

    45     */

    46     const HssScanFrame* First();

    47 

    48     /**

    49     * Find the data of the next access point.

    50     * @return Pointer at the beginning of the next access point stored

    51     *         in the scan list. NULL if not any.

    52     */

    53     const HssScanFrame* Next();

    54 

    55     /**

    56     * Find the data of the current access point.

    57     * @return Pointer at the beginning of the current access point stored 

    58     *         in the scan list. NULL if not any.

    59     */

    60     const HssScanFrame* Current() const;

    61 

    62     /**

    63     * Find is there any more unhandled access points.

    64     * @return False if there is access points in the list left, 

    65     *         True if not.

    66     */

    67     TBool IsDone() const;

    68     

    69 protected: // Methods

    70 

    71     /**

    72     * C++ default constructor.

    73     *

    74     * Constructor is protected, so, class has to be inherited before use.

    75     */

    76     explicit HssScanListIterator( const HssScanList& scan_list );

    77 

    78 

    79 private: //Methods

    80 

    81     // Prohibit copy constructor if not deriving from CBase.

    82     HssScanListIterator( const HssScanListIterator& );

    83     // Prohibit assigment operator if not deriving from CBase.

    84     HssScanListIterator& operator= ( const HssScanListIterator& );

    85 

    86 protected: // Data

    87     /** Pointer to the beginning of the current item. */

    88     const HssScanFrame* current_m;

    89 

    90 private:   // Data

    91     /** Information about scanned WLAN networks. */

    92     const HssScanList& scan_list_m;

    93 };

    94 

    95 #include "hssscanlistiterator.inl"

    96 

    97 #endif      // HssSCANLISTITERATOR_H