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

/*
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Geographical base class definition.
*
*/


#ifndef LBTGEOAREABASE_H
#define LBTGEOAREABASE_H

#include <e32base.h>
#include <s32strm.h>

/**
 * Base class for geographical area.
 *
 * @lib lbt.lib
 *
 * @since S60 5.1
 */
class CLbtGeoAreaBase : public CBase
    {
public:
    /** 
     * Type of geographical area
     */
    enum TGeoAreaType
        {
        ECircle = 1,    ///<Circular area
        ERectangular = 2,     ///<Rectangular area
        ECellular = 3
        };
    /**
     * Destructor
     */
    IMPORT_C virtual ~CLbtGeoAreaBase();

    /**
     * Gets the type of the geographical area
     * 
     * @return The type of geographical area.
     */
    virtual TGeoAreaType Type() const = 0;
    
          
    /**
     * Internalizes the trigger condition object's details and attributes 
     * from stream.
     *
     * The presence of this function means that the standard templated 
     * operator>>() ( defined in s32strm.h ) is available to internalize objects 
     * of this class.
     *
     * @param[in] aStream Stream from which the object should be internalized.
     */
    IMPORT_C void InternalizeL( RReadStream& aStream );
    
    /**
     * Externalizes the trigger condition object's details and attributes
     * to stream.
     *
     * The presence of this function means that the standard templated 
     * operator<<() ( defined in s32strm.h ) is available to externalize objects 
     * of this class.
     *
     * @param[in] aStream Stream to which the object should be externalized.
     */
    IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
    
protected:
    /**
     * Default constructor
     */  
    CLbtGeoAreaBase();
  
    /**
     * Internalize method that subclass must implement.
     * @param[in] aStream Stream from which the object should be internalized.
     */
    virtual void DoInternalizeL( RReadStream& aStream ) = 0;
    
    /**
     * Externalize method that subclass must implement.
     * @param[in] aStream Stream to which the object should be externalized.
     */
    virtual void DoExternalizeL( RWriteStream& aStream ) const = 0;
    

private:
    /**
     * By default, prohibit copy constructor
     */
    CLbtGeoAreaBase( const CLbtGeoAreaBase& );
    
    /**
     * Prohibit assigment operator
     */
    CLbtGeoAreaBase& operator= ( const CLbtGeoAreaBase& );

    };


#endif //LBTGEOAREABASE_H