epoc32/include/mw/lbttriggerdynamicinfo.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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:  Data class for trigger's dynamic system information.
    15 *
    16 */
    17 
    18 
    19 #ifndef LBTTRIGGERDYNAMICINFO_H
    20 #define LBTTRIGGERDYNAMICINFO_H
    21 
    22 #include <lbtcommon.h>
    23 
    24 /**
    25  * Data class for trigger's dynamic system information, such as 
    26  * trigger validity and distance to the latest acquired location.
    27  * 
    28  * Client application can get following dynamic information of a trigger
    29  * after it's created. 
    30  *
    31  * -  <B>Validity</B>. A trigger is set as invalid when the specified 
    32  * manager UI, owner process or trigger handling process( for start-up trigger )
    33  * is removed from the system. The process can be removed for example when 
    34  * it resides in removable media( like MMC ), and that media is removed from 
    35  * the terminal. An invalid trigger is not included in the 
    36  * trigger supervision process. When the removable media with the specified
    37  * process is attached back to the terminal, the trigger is set as 
    38  * valid and included in the trigger supervision process, provided 
    39  * that the trigger is not disabled. When a trigger has been invalid longer
    40  * than the system clean-up time, the trigger is removed from the system.  
    41  * The system clean-up time is defined by the system and can't be accessed
    42  * by client application. Note, if a trigger's owner process, manager UI
    43  * or trigger handling process( for start-up trigger ) is uninstalled
    44  * from the system, the trigger will be removed by Location Triggering
    45  * Server.
    46  *
    47  * -  <B>Distance to the Latest Acquired Location</B>. 
    48  *
    49  *  @lib lbt.lib
    50  *  @since S60 5.1
    51  */
    52 struct TLbtTriggerDynamicInfo
    53     {
    54     /**
    55      * Attributes of a trigger's dynamic information.
    56      */
    57     enum TLbtDynamicInfoAttribute
    58         {
    59         /**
    60          * Validity status attribute.
    61          */
    62         EValidityStatus = 0x01,           
    63         
    64         /**
    65          * Distance to latest acquired location fix.
    66          */ 
    67         EDistanceToLatestLocation = 0x02,
    68         
    69         /**
    70          * Last fired location information.
    71          */
    72         EFiredLocality = 0x04   
    73         };
    74     
    75     /**
    76      * Defines the trigger validity status.
    77      */
    78     enum TLbtTriggerValidity
    79         {
    80         /**
    81          * Invalid
    82          */
    83         EInvalid = 1,       
    84         /**
    85          * Valid
    86          */
    87         EValid = 2          
    88         };
    89 
    90     /**
    91      * Defines the trigger validity status.
    92      */
    93     TLbtTriggerValidity iValidity;
    94 
    95     /**
    96      * The distance in meters from the trigger to latest acquired
    97      * location.
    98      */
    99     TReal iDistanceToLatestLocation;
   100     
   101     /**
   102      * Information of the location where the trigger was last fired. The 
   103      * information available will contain the latitude, longitude and 
   104      * horizontal accuracy values. Other details in TLocality will not 
   105      * be updated.
   106      */
   107     TLocality iFiredLocality;
   108 
   109     /**
   110      * For future use
   111      */
   112     TUint8 iUnused[8];
   113     };
   114 
   115 #endif // LBTTRIGGERDYNAMICINFO_H