1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.location;
/**
* This class represents the characteristics of the geofence.
*
* <p> Use this in conjunction with {@link GeofenceHardware} APIs.
*/
public final class GeofenceHardwareRequest {
static final int GEOFENCE_TYPE_CIRCLE = 0;
private int mType;
private double mLatitude;
private double mLongitude;
private double mRadius;
private int mLastTransition = GeofenceHardware.GEOFENCE_UNCERTAIN;
private int mUnknownTimer = 30000; // 30 secs
private int mMonitorTransitions = GeofenceHardware.GEOFENCE_UNCERTAIN |
GeofenceHardware.GEOFENCE_ENTERED | GeofenceHardware.GEOFENCE_EXITED;
private int mNotificationResponsiveness = 5000; // 5 secs
private void setCircularGeofence(double latitude, double longitude, double radius) {
mLatitude = latitude;
mLongitude = longitude;
mRadius = radius;
mType = GEOFENCE_TYPE_CIRCLE;
}
/**
* Create a circular geofence.
*
* @param latitude Latitude of the geofence
* @param longitude Longitude of the geofence
* @param radius Radius of the geofence (in meters)
*/
public static GeofenceHardwareRequest createCircularGeofence(double latitude,
double longitude, double radius) {
GeofenceHardwareRequest geofenceRequest = new GeofenceHardwareRequest();
geofenceRequest.setCircularGeofence(latitude, longitude, radius);
return geofenceRequest;
}
/**
* Set the last known transition of the geofence.
*
* @param lastTransition The current state of the geofence. Can be one of
* {@link GeofenceHardware#GEOFENCE_ENTERED}, {@link GeofenceHardware#GEOFENCE_EXITED},
* {@link GeofenceHardware#GEOFENCE_UNCERTAIN}.
*/
public void setLastTransition(int lastTransition) {
mLastTransition = lastTransition;
}
/**
* Set the unknown timer for this geofence.
*
* @param unknownTimer The time limit after which the
* {@link GeofenceHardware#GEOFENCE_UNCERTAIN} transition
* should be triggered. This paramter is defined in milliseconds.
*/
public void setUnknownTimer(int unknownTimer) {
mUnknownTimer = unknownTimer;
}
/**
* Set the transitions to be monitored.
*
* @param monitorTransitions Bitwise OR of {@link GeofenceHardware#GEOFENCE_ENTERED},
* {@link GeofenceHardware#GEOFENCE_EXITED}, {@link GeofenceHardware#GEOFENCE_UNCERTAIN}
*/
public void setMonitorTransitions(int monitorTransitions) {
mMonitorTransitions = monitorTransitions;
}
/**
* Set the notification responsiveness of the geofence.
*
* @param notificationResponsiveness (milliseconds) Defines the best-effort description
* of how soon should the callback be called when the transition
* associated with the Geofence is triggered. For instance, if
* set to 1000 millseconds with {@link GeofenceHardware#GEOFENCE_ENTERED},
* the callback will be called 1000 milliseconds within entering
* the geofence.
*/
public void setNotificationResponsiveness(int notificationResponsiveness) {
mNotificationResponsiveness = notificationResponsiveness;
}
/**
* Returns the latitude of this geofence.
*/
public double getLatitude() {
return mLatitude;
}
/**
* Returns the longitude of this geofence.
*/
public double getLongitude() {
return mLongitude;
}
/**
* Returns the radius of this geofence.
*/
public double getRadius() {
return mRadius;
}
/**
* Returns transitions monitored for this geofence.
*/
public int getMonitorTransitions() {
return mMonitorTransitions;
}
/**
* Returns the unknownTimer of this geofence.
*/
public int getUnknownTimer() {
return mUnknownTimer;
}
/**
* Returns the notification responsiveness of this geofence.
*/
public int getNotificationResponsiveness() {
return mNotificationResponsiveness;
}
/**
* Returns the last transition of this geofence.
*/
public int getLastTransition() {
return mLastTransition;
}
int getType() {
return mType;
}
}
|
