1 /*

     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Location triggering related system settings

    15 *

    16 */

    17 

    18 

    19 #ifndef LBTTRIGGERINGSYSTEMSETTINGS_H

    20 #define LBTTRIGGERINGSYSTEMSETTINGS_H

    21 

    22 #include <lbtcommon.h>

    23 

    24 /**

    25  * Structure for location triggering related system settings.

    26  *

    27  * @lib lbt.lib

    28  *

    29  * @since S60 5.1

    30  */

    31 class TLbtTriggeringSystemSettings

    32     {

    33 public:

    34     /**

    35      * Type of system setting class.

    36      */

    37     enum TType

    38         {

    39         ///System settings

    40         ETypeSystemSettings     = 1,

    41         ///Management system settings

    42         ETypeManagementSystemSettings = 2

    43         };

    44 

    45     /**

    46      * Default constructor.

    47      */

    48     IMPORT_C TLbtTriggeringSystemSettings();

    49     

    50     /**

    51      * Gets the type of system setting class.

    52      */

    53     IMPORT_C virtual TType Type();

    54 

    55     /**

    56      * Returns minimum size of trigger area. 

    57      *

    58      * When creating a trigger with a circular geographical 

    59      * trigger area, the radius of the trigger area must be 

    60      * greater than this setting. 

    61      *

    62      * This function returns zero if the minimum trigger area

    63      * size is not set.

    64      *

    65      * @return The minimum size of trigger area. In meters.

    66      */

    67     IMPORT_C TReal MinimumTriggerAreaSize() const;

    68 

    69     /**

    70      * Sets the minum size of trigger area. This is for internal use only. 

    71      *

    72      * @panic LocTriggering ELbtErrArgument If aSize is negative.

    73      * @param aSize The minimum size of trigger area. In meters.

    74      */

    75     IMPORT_C void SetMinimumTriggerAreaSize(

    76         TReal aSize );

    77 

    78     /**

    79      * Returns the triggering mechanism state. 

    80      *

    81      * This function returns ETriggeringMechanismOn if

    82      * the triggering mechanism state is not set. 

    83      *

    84      * @return The triggering mechanism state. 

    85      */

    86     IMPORT_C TLbtTriggeringMechanismState 

    87         TriggeringMechanismState() const;

    88 

    89     /**

    90      * Sets the triggering mechanism state. This is for internal use only. 

    91      *

    92      * @param aState The triggering mechanism state.

    93      */

    94     IMPORT_C void SetTriggeringMechanismState(

    95         TLbtTriggeringMechanismState aState );

    96 

    97 protected:

    98     /**

    99      * Type of the setting class

   100      */

   101     TType iType;

   102     

   103 private: //data

   104     /**

   105      * The minimum size of trigger area.

   106      */

   107     TReal iMinimumTriggerAreaSize;

   108 

   109     /**

   110      * Triggering mechanism state. 

   111      */

   112     TLbtTriggeringMechanismState iTriggeringState;

   113 

   114     /**

   115      * For future use.

   116      */

   117     TUint8 iUnused[8];

   118     };

   119 

   120 #endif //LBTCOMMON_H