epoc32/include/mw/lbtgeoareabase.h
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/lbtgeoareabase.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,114 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* 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
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  Geographical base class definition.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef LBTGEOAREABASE_H
    1.23 +#define LBTGEOAREABASE_H
    1.24 +
    1.25 +#include <e32base.h>
    1.26 +#include <s32strm.h>
    1.27 +
    1.28 +/**
    1.29 + * Base class for geographical area.
    1.30 + *
    1.31 + * @lib lbt.lib
    1.32 + *
    1.33 + * @since S60 5.1
    1.34 + */
    1.35 +class CLbtGeoAreaBase : public CBase
    1.36 +    {
    1.37 +public:
    1.38 +    /** 
    1.39 +     * Type of geographical area
    1.40 +     */
    1.41 +    enum TGeoAreaType
    1.42 +        {
    1.43 +        ECircle = 1,    ///<Circular area
    1.44 +        ERectangular = 2,     ///<Rectangular area
    1.45 +        ECellular = 3
    1.46 +        };
    1.47 +    /**
    1.48 +     * Destructor
    1.49 +     */
    1.50 +    IMPORT_C virtual ~CLbtGeoAreaBase();
    1.51 +
    1.52 +    /**
    1.53 +     * Gets the type of the geographical area
    1.54 +     * 
    1.55 +     * @return The type of geographical area.
    1.56 +     */
    1.57 +    virtual TGeoAreaType Type() const = 0;
    1.58 +    
    1.59 +          
    1.60 +    /**
    1.61 +     * Internalizes the trigger condition object's details and attributes 
    1.62 +     * from stream.
    1.63 +     *
    1.64 +     * The presence of this function means that the standard templated 
    1.65 +     * operator>>() ( defined in s32strm.h ) is available to internalize objects 
    1.66 +     * of this class.
    1.67 +     *
    1.68 +     * @param[in] aStream Stream from which the object should be internalized.
    1.69 +     */
    1.70 +    IMPORT_C void InternalizeL( RReadStream& aStream );
    1.71 +    
    1.72 +    /**
    1.73 +     * Externalizes the trigger condition object's details and attributes
    1.74 +     * to stream.
    1.75 +     *
    1.76 +     * The presence of this function means that the standard templated 
    1.77 +     * operator<<() ( defined in s32strm.h ) is available to externalize objects 
    1.78 +     * of this class.
    1.79 +     *
    1.80 +     * @param[in] aStream Stream to which the object should be externalized.
    1.81 +     */
    1.82 +    IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
    1.83 +    
    1.84 +protected:
    1.85 +    /**
    1.86 +     * Default constructor
    1.87 +     */  
    1.88 +    CLbtGeoAreaBase();
    1.89 +  
    1.90 +    /**
    1.91 +     * Internalize method that subclass must implement.
    1.92 +     * @param[in] aStream Stream from which the object should be internalized.
    1.93 +     */
    1.94 +    virtual void DoInternalizeL( RReadStream& aStream ) = 0;
    1.95 +    
    1.96 +    /**
    1.97 +     * Externalize method that subclass must implement.
    1.98 +     * @param[in] aStream Stream to which the object should be externalized.
    1.99 +     */
   1.100 +    virtual void DoExternalizeL( RWriteStream& aStream ) const = 0;
   1.101 +    
   1.102 +
   1.103 +private:
   1.104 +    /**
   1.105 +     * By default, prohibit copy constructor
   1.106 +     */
   1.107 +    CLbtGeoAreaBase( const CLbtGeoAreaBase& );
   1.108 +    
   1.109 +    /**
   1.110 +     * Prohibit assigment operator
   1.111 +     */
   1.112 +    CLbtGeoAreaBase& operator= ( const CLbtGeoAreaBase& );
   1.113 +
   1.114 +    };
   1.115 +
   1.116 +
   1.117 +#endif //LBTGEOAREABASE_H