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@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.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 trigger condition classes.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef LBTTRIGGERCONDITIONBASE_H
williamr@2: #define LBTTRIGGERCONDITIONBASE_H
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <s32strm.h>
williamr@2: 
williamr@2: /**
williamr@2:  * Abstract base class for trigger condition classes.
williamr@2:  * 
williamr@2:  * This class is not meant to be derived nor instantiated by client application.
williamr@2:  * It defines methods that concrete trigger condition class must implement.
williamr@2:  *
williamr@2:  * @lib lbt.lib
williamr@2:  * @since S60 5.1
williamr@2:  */
williamr@2: class CLbtTriggerConditionBase : public CBase
williamr@2:     {
williamr@2: public:
williamr@2:     /**
williamr@2:      * Enumeration for trigger condition types.
williamr@2:      */
williamr@2:     enum TType
williamr@2:         {
williamr@2:         /** 
williamr@2:          * Trigger condition based on geographical area and movement of 
williamr@2:          * the terminal. A trigger is fired when the 
williamr@2:          * terminal enters or leaves the specified trigger area.
williamr@2:          */
williamr@2:         ETriggerConditionArea = 1
williamr@2:         };
williamr@2:         
williamr@2:     /**
williamr@2:      * Destructor
williamr@2:      */
williamr@2:     virtual ~CLbtTriggerConditionBase();
williamr@2:     
williamr@2:     /**
williamr@2:      * Gets the type of trigger condition class.
williamr@2:      * @return The type of trigger condition class.
williamr@2:      */
williamr@2:     virtual TType Type() const = 0;
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: protected:
williamr@2:     /**
williamr@2:      * Constructor
williamr@2:      */
williamr@2:     CLbtTriggerConditionBase();
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:     CLbtTriggerConditionBase( const CLbtTriggerConditionBase& );
williamr@2:     
williamr@2:     /**
williamr@2:      * Prohibit assigment operator
williamr@2:      */
williamr@2:     CLbtTriggerConditionBase& operator= ( const CLbtTriggerConditionBase& );
williamr@2: 
williamr@2:     };
williamr@2:     
williamr@2:  
williamr@2: #endif // LBTTRIGGERCONDITIONBASE_H