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:  Location triggering related system settings
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef LBTTRIGGERINGSYSTEMSETTINGS_H
williamr@2: #define LBTTRIGGERINGSYSTEMSETTINGS_H
williamr@2: 
williamr@2: #include <lbtcommon.h>
williamr@2: 
williamr@2: /**
williamr@2:  * Structure for location triggering related system settings.
williamr@2:  *
williamr@2:  * @lib lbt.lib
williamr@2:  *
williamr@2:  * @since S60 5.1
williamr@2:  */
williamr@2: class TLbtTriggeringSystemSettings
williamr@2:     {
williamr@2: public:
williamr@2:     /**
williamr@2:      * Type of system setting class.
williamr@2:      */
williamr@2:     enum TType
williamr@2:         {
williamr@2:         ///System settings
williamr@2:         ETypeSystemSettings     = 1,
williamr@2:         ///Management system settings
williamr@2:         ETypeManagementSystemSettings = 2
williamr@2:         };
williamr@2: 
williamr@2:     /**
williamr@2:      * Default constructor.
williamr@2:      */
williamr@2:     IMPORT_C TLbtTriggeringSystemSettings();
williamr@2:     
williamr@2:     /**
williamr@2:      * Gets the type of system setting class.
williamr@2:      */
williamr@2:     IMPORT_C virtual TType Type();
williamr@2: 
williamr@2:     /**
williamr@2:      * Returns minimum size of trigger area. 
williamr@2:      *
williamr@2:      * When creating a trigger with a circular geographical 
williamr@2:      * trigger area, the radius of the trigger area must be 
williamr@2:      * greater than this setting. 
williamr@2:      *
williamr@2:      * This function returns zero if the minimum trigger area
williamr@2:      * size is not set.
williamr@2:      *
williamr@2:      * @return The minimum size of trigger area. In meters.
williamr@2:      */
williamr@2:     IMPORT_C TReal MinimumTriggerAreaSize() const;
williamr@2: 
williamr@2:     /**
williamr@2:      * Sets the minum size of trigger area. This is for internal use only. 
williamr@2:      *
williamr@2:      * @panic LocTriggering ELbtErrArgument If aSize is negative.
williamr@2:      * @param aSize The minimum size of trigger area. In meters.
williamr@2:      */
williamr@2:     IMPORT_C void SetMinimumTriggerAreaSize(
williamr@2:         TReal aSize );
williamr@2: 
williamr@2:     /**
williamr@2:      * Returns the triggering mechanism state. 
williamr@2:      *
williamr@2:      * This function returns ETriggeringMechanismOn if
williamr@2:      * the triggering mechanism state is not set. 
williamr@2:      *
williamr@2:      * @return The triggering mechanism state. 
williamr@2:      */
williamr@2:     IMPORT_C TLbtTriggeringMechanismState 
williamr@2:         TriggeringMechanismState() const;
williamr@2: 
williamr@2:     /**
williamr@2:      * Sets the triggering mechanism state. This is for internal use only. 
williamr@2:      *
williamr@2:      * @param aState The triggering mechanism state.
williamr@2:      */
williamr@2:     IMPORT_C void SetTriggeringMechanismState(
williamr@2:         TLbtTriggeringMechanismState aState );
williamr@2: 
williamr@2: protected:
williamr@2:     /**
williamr@2:      * Type of the setting class
williamr@2:      */
williamr@2:     TType iType;
williamr@2:     
williamr@2: private: //data
williamr@2:     /**
williamr@2:      * The minimum size of trigger area.
williamr@2:      */
williamr@2:     TReal iMinimumTriggerAreaSize;
williamr@2: 
williamr@2:     /**
williamr@2:      * Triggering mechanism state. 
williamr@2:      */
williamr@2:     TLbtTriggeringMechanismState iTriggeringState;
williamr@2: 
williamr@2:     /**
williamr@2:      * For future use.
williamr@2:      */
williamr@2:     TUint8 iUnused[8];
williamr@2:     };
williamr@2: 
williamr@2: #endif //LBTCOMMON_H