epoc32/include/mw/lbtgeoareabase.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /*
     2 * Copyright (c) 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  Geographical base class definition.
    15 *
    16 */
    17 
    18 
    19 #ifndef LBTGEOAREABASE_H
    20 #define LBTGEOAREABASE_H
    21 
    22 #include <e32base.h>
    23 #include <s32strm.h>
    24 
    25 /**
    26  * Base class for geographical area.
    27  *
    28  * @lib lbt.lib
    29  *
    30  * @since S60 5.1
    31  */
    32 class CLbtGeoAreaBase : public CBase
    33     {
    34 public:
    35     /** 
    36      * Type of geographical area
    37      */
    38     enum TGeoAreaType
    39         {
    40         ECircle = 1,    ///<Circular area
    41         ERectangular = 2,     ///<Rectangular area
    42         ECellular = 3
    43         };
    44     /**
    45      * Destructor
    46      */
    47     IMPORT_C virtual ~CLbtGeoAreaBase();
    48 
    49     /**
    50      * Gets the type of the geographical area
    51      * 
    52      * @return The type of geographical area.
    53      */
    54     virtual TGeoAreaType Type() const = 0;
    55     
    56           
    57     /**
    58      * Internalizes the trigger condition object's details and attributes 
    59      * from stream.
    60      *
    61      * The presence of this function means that the standard templated 
    62      * operator>>() ( defined in s32strm.h ) is available to internalize objects 
    63      * of this class.
    64      *
    65      * @param[in] aStream Stream from which the object should be internalized.
    66      */
    67     IMPORT_C void InternalizeL( RReadStream& aStream );
    68     
    69     /**
    70      * Externalizes the trigger condition object's details and attributes
    71      * to stream.
    72      *
    73      * The presence of this function means that the standard templated 
    74      * operator<<() ( defined in s32strm.h ) is available to externalize objects 
    75      * of this class.
    76      *
    77      * @param[in] aStream Stream to which the object should be externalized.
    78      */
    79     IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
    80     
    81 protected:
    82     /**
    83      * Default constructor
    84      */  
    85     CLbtGeoAreaBase();
    86   
    87     /**
    88      * Internalize method that subclass must implement.
    89      * @param[in] aStream Stream from which the object should be internalized.
    90      */
    91     virtual void DoInternalizeL( RReadStream& aStream ) = 0;
    92     
    93     /**
    94      * Externalize method that subclass must implement.
    95      * @param[in] aStream Stream to which the object should be externalized.
    96      */
    97     virtual void DoExternalizeL( RWriteStream& aStream ) const = 0;
    98     
    99 
   100 private:
   101     /**
   102      * By default, prohibit copy constructor
   103      */
   104     CLbtGeoAreaBase( const CLbtGeoAreaBase& );
   105     
   106     /**
   107      * Prohibit assigment operator
   108      */
   109     CLbtGeoAreaBase& operator= ( const CLbtGeoAreaBase& );
   110 
   111     };
   112 
   113 
   114 #endif //LBTGEOAREABASE_H