Geotrigger fence data required for a FenceGeotrigger. More...
| Header: | #include <FenceParameters.h> |
| Since: | Esri::ArcGISRuntime 100.12 |
| Inherits: | Esri::ArcGISRuntime::Object |
| Inherited By: | Esri::ArcGISRuntime::FeatureFenceParameters, Esri::ArcGISRuntime::GraphicFenceParameters, and Esri::ArcGISRuntime::GraphicsOverlayFenceParameters |
This class was introduced in Esri::ArcGISRuntime 100.12.
Public Functions
| virtual | ~FenceParameters() override |
| double | bufferDistance() const |
| Esri::ArcGISRuntime::FenceParametersType | fenceParametersType() const |
Static Public Members
| Esri::ArcGISRuntime::FenceParameters * | createFromGeoElement(Esri::ArcGISRuntime::GeoElement *geoElement, double bufferDistance, QObject *parent = nullptr) |
Detailed Description
The FenceParameters defines all of the target geometries of a FenceGeotrigger. Typically, it is made up of many polygons that objects from the GeotriggerFeed can enter or exit. However, if you set a bufferDistance, point and line geometry can also be used. For example, if the condition is "notify me when my position comes within 50 meters of one of my target areas", the fence data would be "my target areas".
Fence data can be created as one of:
Member Function Documentation
[override virtual] FenceParameters::~FenceParameters ()
Destructor.
double FenceParameters::bufferDistance () const
Returns a buffer distance in meters to apply when checking if a FenceGeotrigger condition is met.
For example, if the rule is "enters within 50 meters" you use a Esri::ArcGISRuntime::FenceRuleType of FenceRuleType::Enter and set this property to 50.
Buffers are Geodetic and created using the following default values:
- GeodeticCurveType::ShapePreserving
- Max deviation =
NaN - LinearUnitId::Meters.
If your fences use point or polyline Geometry then you must set this property to a value greater than 0.
[static] Esri::ArcGISRuntime::FenceParameters *FenceParameters::createFromGeoElement (Esri::ArcGISRuntime::GeoElement *geoElement , double bufferDistance , QObject *parent = nullptr)
Returns static factory function to create a FenceParameters.
- geoElement - An individual GeoElement used to create a FenceParameters object.
- bufferDistance - A buffer distance in meters to apply to the GeoElement when checking if a Geotrigger condition is met.
- parent - The parent QObject
This method creates the appropriate type of FenceParameters based on the type of the GeoElement that was supplied. The supported types of GeoElement are Graphic and Feature.
If passed an unsupported GeoElement, this method will return nullptr.
Esri::ArcGISRuntime::FenceParametersType FenceParameters::fenceParametersType () const
Returns the type of fence data.
The type for a specific fence data object.