Feed data for a Geotrigger created from a AbstractLocationDataSource. More...
| Header: | #include <LocationGeotriggerFeed.h> |
| Since: | Esri::ArcGISRuntime 100.12 |
| Inherits: | Esri::ArcGISRuntime::GeotriggerFeed |
Public Functions
| LocationGeotriggerFeed(QObject *parent = nullptr) | |
| LocationGeotriggerFeed(Esri::ArcGISRuntime::AbstractLocationDataSource *locationDataSource, QObject *parent = nullptr) | |
| virtual | ~LocationGeotriggerFeed() override |
| Esri::ArcGISRuntime::ArcadeExpression * | filter() const |
| Esri::ArcGISRuntime::AbstractLocationDataSource * | locationDataSource() const |
| void | setFilter(Esri::ArcGISRuntime::ArcadeExpression *filter) |
| void | setLocationDataSource(Esri::ArcGISRuntime::AbstractLocationDataSource *locationDataSource) |
Detailed Description
The GeotriggerFeed is the dynamic component of a Geotrigger. Typically, it is the data that moves around and triggers the condition. For example, if the condition is "Notify me when my position comes within 50 meters of one of my target areas", the feed data is "my position".
To receive location updates, the underlying location data source must be started. If you call GeotriggerMonitor::stop, the underlying AbstractLocationDataSource will not be stopped for you. For example, it may continue to receive GPS readings.
If the LocationGeotriggerFeed is from a Geotrigger defined in a GeotriggersInfo, you must supply a AbstractLocationDataSource to provide the device location. Set the locationDataSource to your AbstractLocationDataSource - for example, using the LocationDisplay::dataSource.
A FenceGeotrigger can also take into account floors within buildings. If the feature table used to create the FeatureFenceParameters is referenced by a FeatureLayer that is FloorAware, and the AbstractLocationDataSource used to create the GeotriggerFeed includes LocationSourcePropertiesKeys::floor information, then fences will only be entered when they are intersected by a Location on the correct floor. If the fence or location data does not include valid floor information, the floor is ignored and the fence is entered when it is intersected by the location.
A floor aware feature layer or table must be part of a GeoModel that includes a valid GeoModelFloorDefinition. All layers and tables that are used by the floor definition are loaded when the GeotriggerMonitor is started.
A Location can contain the floor property as part of Location::additionalSourceProperties. This is populated automatically by IndoorsLocationDataSource, or can be supplied as part of your own implementation.
Member Function Documentation
[explicit] LocationGeotriggerFeed::LocationGeotriggerFeed (QObject *parent = nullptr)
Constructs a default LocationGeotriggerFeed.
- parent - The optional parent QObject.
[explicit] LocationGeotriggerFeed::LocationGeotriggerFeed (Esri::ArcGISRuntime::AbstractLocationDataSource *locationDataSource , QObject *parent = nullptr)
Constructs a LocationGeotriggerFeed with an AbstractLocationDataSource.
- locationDataSource - A location data source that provides updates for the device location.
- parent - The optional parent QObject.
[override virtual] LocationGeotriggerFeed::~LocationGeotriggerFeed ()
Destructor.
[since Esri::ArcGISRuntime 100.13] Esri::ArcGISRuntime::ArcadeExpression *LocationGeotriggerFeed::filter() const
Returns an ArcadeExpression that controls whether an update from the LocationGeotriggerFeed is sent to a GeotriggerMonitor.
The expression uses the Arcade language to determine whether feed entity updates are suitable for monitoring. The ArcadeExpression must evaluate to a boolean where:
trueindicates that the update will be used.falseindicates that the update will not be used.
Filtering out undesirable updates reduces inaccurate notifications from your GeotriggerMonitor. For example, you could filter out GPS updates where the horizontal accuracy is poor, to avoid false enter and exit notifications.
With a LocationGeotriggerFeed, the expression inspects a new Location object and returns true if it is suitable and false if not. Typically, your expression excludes Location objects where the Location::horizontalAccuracy does not meet your criteria - but it could also consider other properties such as Location::velocity and Location::course.
Arcade gives you access to the properties of the feed entity with the $locationupdate profile variable. This represents a new Location received from your device GPS. For example, an ArcadeExpression with the following string rejects Location updates with a horizontal accuracy greater than 10 meters:
return $locationupdate.horizontalaccuracy <= 10;
This function was introduced in Esri::ArcGISRuntime 100.13.
See also setFilter().
Esri::ArcGISRuntime::AbstractLocationDataSource *LocationGeotriggerFeed::locationDataSource () const
Returns the location data source which will provide updates for the device location.
To receive location updates, the underlying location data source must be started. If you call GeotriggerMonitor::stop, the underlying AbstractLocationDataSource is not stopped for you. In other words, it may continue to receive GPS readings.
See also setLocationDataSource().
[since Esri::ArcGISRuntime 100.13] void LocationGeotriggerFeed::setFilter (Esri::ArcGISRuntime::ArcadeExpression *filter)
Sets the filter to filter.
This function was introduced in Esri::ArcGISRuntime 100.13.
See also filter.
void LocationGeotriggerFeed::setLocationDataSource (Esri::ArcGISRuntime::AbstractLocationDataSource *locationDataSource )
Sets the locationDataSource to locationDataSource.
See also locationDataSource.