1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/lbttriggerdynamicinfo.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,115 @@
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: Data class for trigger's dynamic system information.
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef LBTTRIGGERDYNAMICINFO_H
1.23 +#define LBTTRIGGERDYNAMICINFO_H
1.24 +
1.25 +#include <lbtcommon.h>
1.26 +
1.27 +/**
1.28 + * Data class for trigger's dynamic system information, such as
1.29 + * trigger validity and distance to the latest acquired location.
1.30 + *
1.31 + * Client application can get following dynamic information of a trigger
1.32 + * after it's created.
1.33 + *
1.34 + * - <B>Validity</B>. A trigger is set as invalid when the specified
1.35 + * manager UI, owner process or trigger handling process( for start-up trigger )
1.36 + * is removed from the system. The process can be removed for example when
1.37 + * it resides in removable media( like MMC ), and that media is removed from
1.38 + * the terminal. An invalid trigger is not included in the
1.39 + * trigger supervision process. When the removable media with the specified
1.40 + * process is attached back to the terminal, the trigger is set as
1.41 + * valid and included in the trigger supervision process, provided
1.42 + * that the trigger is not disabled. When a trigger has been invalid longer
1.43 + * than the system clean-up time, the trigger is removed from the system.
1.44 + * The system clean-up time is defined by the system and can't be accessed
1.45 + * by client application. Note, if a trigger's owner process, manager UI
1.46 + * or trigger handling process( for start-up trigger ) is uninstalled
1.47 + * from the system, the trigger will be removed by Location Triggering
1.48 + * Server.
1.49 + *
1.50 + * - <B>Distance to the Latest Acquired Location</B>.
1.51 + *
1.52 + * @lib lbt.lib
1.53 + * @since S60 5.1
1.54 + */
1.55 +struct TLbtTriggerDynamicInfo
1.56 + {
1.57 + /**
1.58 + * Attributes of a trigger's dynamic information.
1.59 + */
1.60 + enum TLbtDynamicInfoAttribute
1.61 + {
1.62 + /**
1.63 + * Validity status attribute.
1.64 + */
1.65 + EValidityStatus = 0x01,
1.66 +
1.67 + /**
1.68 + * Distance to latest acquired location fix.
1.69 + */
1.70 + EDistanceToLatestLocation = 0x02,
1.71 +
1.72 + /**
1.73 + * Last fired location information.
1.74 + */
1.75 + EFiredLocality = 0x04
1.76 + };
1.77 +
1.78 + /**
1.79 + * Defines the trigger validity status.
1.80 + */
1.81 + enum TLbtTriggerValidity
1.82 + {
1.83 + /**
1.84 + * Invalid
1.85 + */
1.86 + EInvalid = 1,
1.87 + /**
1.88 + * Valid
1.89 + */
1.90 + EValid = 2
1.91 + };
1.92 +
1.93 + /**
1.94 + * Defines the trigger validity status.
1.95 + */
1.96 + TLbtTriggerValidity iValidity;
1.97 +
1.98 + /**
1.99 + * The distance in meters from the trigger to latest acquired
1.100 + * location.
1.101 + */
1.102 + TReal iDistanceToLatestLocation;
1.103 +
1.104 + /**
1.105 + * Information of the location where the trigger was last fired. The
1.106 + * information available will contain the latitude, longitude and
1.107 + * horizontal accuracy values. Other details in TLocality will not
1.108 + * be updated.
1.109 + */
1.110 + TLocality iFiredLocality;
1.111 +
1.112 + /**
1.113 + * For future use
1.114 + */
1.115 + TUint8 iUnused[8];
1.116 + };
1.117 +
1.118 +#endif // LBTTRIGGERDYNAMICINFO_H