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