1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/lbttriggeringsystemsettings.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,120 @@
     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:  Location triggering related system settings
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef LBTTRIGGERINGSYSTEMSETTINGS_H
    1.23 +#define LBTTRIGGERINGSYSTEMSETTINGS_H
    1.24 +
    1.25 +#include <lbtcommon.h>
    1.26 +
    1.27 +/**
    1.28 + * Structure for location triggering related system settings.
    1.29 + *
    1.30 + * @lib lbt.lib
    1.31 + *
    1.32 + * @since S60 5.1
    1.33 + */
    1.34 +class TLbtTriggeringSystemSettings
    1.35 +    {
    1.36 +public:
    1.37 +    /**
    1.38 +     * Type of system setting class.
    1.39 +     */
    1.40 +    enum TType
    1.41 +        {
    1.42 +        ///System settings
    1.43 +        ETypeSystemSettings     = 1,
    1.44 +        ///Management system settings
    1.45 +        ETypeManagementSystemSettings = 2
    1.46 +        };
    1.47 +
    1.48 +    /**
    1.49 +     * Default constructor.
    1.50 +     */
    1.51 +    IMPORT_C TLbtTriggeringSystemSettings();
    1.52 +    
    1.53 +    /**
    1.54 +     * Gets the type of system setting class.
    1.55 +     */
    1.56 +    IMPORT_C virtual TType Type();
    1.57 +
    1.58 +    /**
    1.59 +     * Returns minimum size of trigger area. 
    1.60 +     *
    1.61 +     * When creating a trigger with a circular geographical 
    1.62 +     * trigger area, the radius of the trigger area must be 
    1.63 +     * greater than this setting. 
    1.64 +     *
    1.65 +     * This function returns zero if the minimum trigger area
    1.66 +     * size is not set.
    1.67 +     *
    1.68 +     * @return The minimum size of trigger area. In meters.
    1.69 +     */
    1.70 +    IMPORT_C TReal MinimumTriggerAreaSize() const;
    1.71 +
    1.72 +    /**
    1.73 +     * Sets the minum size of trigger area. This is for internal use only. 
    1.74 +     *
    1.75 +     * @panic LocTriggering ELbtErrArgument If aSize is negative.
    1.76 +     * @param aSize The minimum size of trigger area. In meters.
    1.77 +     */
    1.78 +    IMPORT_C void SetMinimumTriggerAreaSize(
    1.79 +        TReal aSize );
    1.80 +
    1.81 +    /**
    1.82 +     * Returns the triggering mechanism state. 
    1.83 +     *
    1.84 +     * This function returns ETriggeringMechanismOn if
    1.85 +     * the triggering mechanism state is not set. 
    1.86 +     *
    1.87 +     * @return The triggering mechanism state. 
    1.88 +     */
    1.89 +    IMPORT_C TLbtTriggeringMechanismState 
    1.90 +        TriggeringMechanismState() const;
    1.91 +
    1.92 +    /**
    1.93 +     * Sets the triggering mechanism state. This is for internal use only. 
    1.94 +     *
    1.95 +     * @param aState The triggering mechanism state.
    1.96 +     */
    1.97 +    IMPORT_C void SetTriggeringMechanismState(
    1.98 +        TLbtTriggeringMechanismState aState );
    1.99 +
   1.100 +protected:
   1.101 +    /**
   1.102 +     * Type of the setting class
   1.103 +     */
   1.104 +    TType iType;
   1.105 +    
   1.106 +private: //data
   1.107 +    /**
   1.108 +     * The minimum size of trigger area.
   1.109 +     */
   1.110 +    TReal iMinimumTriggerAreaSize;
   1.111 +
   1.112 +    /**
   1.113 +     * Triggering mechanism state. 
   1.114 +     */
   1.115 +    TLbtTriggeringMechanismState iTriggeringState;
   1.116 +
   1.117 +    /**
   1.118 +     * For future use.
   1.119 +     */
   1.120 +    TUint8 iUnused[8];
   1.121 +    };
   1.122 +
   1.123 +#endif //LBTCOMMON_H