williamr@2: /*
williamr@2: * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * 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
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Abstract base class for filter when listing triggers.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef LBTTRIGGERFILTERBASE_H
williamr@2: #define LBTTRIGGERFILTERBASE_H
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <s32strm.h>
williamr@2: 
williamr@2: /**
williamr@2:  * Abstract base class for filter when listing triggers from 
williamr@2:  * Location Triggering Server.
williamr@2:  *
williamr@2:  * @lib lbt.lib
williamr@2:  * @since S60 5.1
williamr@2:  */
williamr@2: class CLbtTriggerFilterBase : public CBase
williamr@2:     {
williamr@2: public:
williamr@2:     /**
williamr@2:      * Specifies the type of the filter
williamr@2:      */
williamr@2:     enum TFilterType
williamr@2:         {
williamr@2:         /**
williamr@2:          * Filter based on the trigger entry's attribute value.
williamr@2:          */
williamr@2:         EFilterByAttribute = 1,
williamr@2:         /**
williamr@2:          * Filter based on the geographical area.
williamr@2:          */
williamr@2:         EFilterByArea = 2,
williamr@2:         /**
williamr@2:          * Composite filter.
williamr@2:          */
williamr@2:         EFilterComposite = 3
williamr@2:         };
williamr@2: 
williamr@2:     /**
williamr@2:      * Returns the type of filter.
williamr@2:      *
williamr@2:      * @return The type of the filter.
williamr@2:      */
williamr@2:     virtual TFilterType Type() const = 0;
williamr@2: 
williamr@2:     /**
williamr@2:      * Destructor.
williamr@2:      */
williamr@2:     IMPORT_C virtual ~CLbtTriggerFilterBase();
williamr@2:     
williamr@2:     
williamr@2:     /**
williamr@2:      * Internalizes the trigger condition object's details and attributes 
williamr@2:      * from stream.
williamr@2:      *
williamr@2:      * The presence of this function means that the standard templated 
williamr@2:      * operator>>() ( defined in s32strm.h ) is available to internalize objects 
williamr@2:      * of this class.
williamr@2:      *
williamr@2:      * @param[in] aStream Stream from which the object should be internalized.
williamr@2:      */
williamr@2:     IMPORT_C void InternalizeL( RReadStream& aStream );
williamr@2:     
williamr@2:     /**
williamr@2:      * Externalizes the trigger condition object's details and attributes
williamr@2:      * to stream.
williamr@2:      *
williamr@2:      * The presence of this function means that the standard templated 
williamr@2:      * operator<<() ( defined in s32strm.h ) is available to externalize objects 
williamr@2:      * of this class.
williamr@2:      *
williamr@2:      * @param[in] aStream Stream to which the object should be externalized.
williamr@2:      */
williamr@2:     IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
williamr@2:     
williamr@2: 
williamr@2: protected:    
williamr@2:     /**
williamr@2:      * Constructor.
williamr@2:      */
williamr@2:     CLbtTriggerFilterBase();
williamr@2:     
williamr@2:     /**
williamr@2:      * Internalize method that subclass must implement.
williamr@2:      * @param[in] aStream Stream from which the object should be internalized.
williamr@2:      */
williamr@2:     virtual void DoInternalizeL( RReadStream& aStream ) = 0;
williamr@2:     
williamr@2:     /**
williamr@2:      * Externalize method that subclass must implement.
williamr@2:      * @param[in] aStream Stream to which the object should be externalized.
williamr@2:      */
williamr@2:     virtual void DoExternalizeL( RWriteStream& aStream ) const = 0;
williamr@2:     
williamr@2: private:
williamr@2:     /**
williamr@2:      * By default, prohibit copy constructor
williamr@2:      */
williamr@2:     CLbtTriggerFilterBase( const CLbtTriggerFilterBase& );
williamr@2:     
williamr@2:     /**
williamr@2:      * Prohibit assigment operator
williamr@2:      */
williamr@2:     CLbtTriggerFilterBase& operator= ( const CLbtTriggerFilterBase& );
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: #endif // LBTTRIGGERFILTERBASE_H