wlan_bearer/wlanldd/wlan_common/osa_common/inc/wlanobject.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2007 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 the License "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:   WlanObject declaration
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 3 %
       
    20 */
       
    21 
       
    22 #ifndef WLANOBJECT_H
       
    23 #define WLANOBJECT_H
       
    24 
       
    25 /**
       
    26  *  base object for every object instance that needs its validy
       
    27  *  checked after constructor call
       
    28  *
       
    29  *
       
    30  *  @lib wlanosa.lib
       
    31  *  @since S60 v3.2
       
    32  */
       
    33 class WlanObject 
       
    34     {
       
    35 
       
    36 public: 
       
    37 
       
    38     /**
       
    39      * checks validy
       
    40      *
       
    41      * @since S60 v3.2
       
    42      * @return ETrue for valid object any other for invalid object
       
    43      */
       
    44     inline TBool IsValid() const;
       
    45 
       
    46 protected:
       
    47 
       
    48     /**
       
    49      * Constructor.
       
    50      *
       
    51      * @since S60 v3.2
       
    52      */
       
    53     WlanObject() : iValid( ETrue ) {};
       
    54 
       
    55     /**
       
    56      * validates object
       
    57      *
       
    58      * @since S60 v3.2
       
    59      */
       
    60     inline void Validate();
       
    61 
       
    62     /**
       
    63      * invalidates the object
       
    64      *
       
    65      * @since S60 v3.2
       
    66      */
       
    67     inline void InValidate();
       
    68 
       
    69 private: // data
       
    70 
       
    71     /**
       
    72      * marker to mark is the object valid or not
       
    73      */
       
    74     TBool iValid;
       
    75 
       
    76     };
       
    77 
       
    78 #include "wlanobject.inl"
       
    79 
       
    80 #endif // WLANOBJECT_H