FeatureFenceParameters Class

  • FeatureFenceParameters
  • class Esri::ArcGISRuntime::FeatureFenceParameters

    Geotrigger fence data created from features. More...

    Header: #include <FeatureFenceParameters.h>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::FenceParameters

    This class was introduced in Esri::ArcGISRuntime 100.12.

    Public Functions

    FeatureFenceParameters(Esri::ArcGISRuntime::FeatureTable *featureTable, double bufferDistance, QObject *parent = nullptr)
    FeatureFenceParameters(Esri::ArcGISRuntime::FeatureTable *featureTable, QObject *parent = nullptr)
    virtual ~FeatureFenceParameters() override
    Esri::ArcGISRuntime::Geometry areaOfInterest() const
    Esri::ArcGISRuntime::FeatureTable *featureTable() const
    void setAreaOfInterest(const Esri::ArcGISRuntime::Geometry &areaOfInterest)
    void setWhereClause(const QString &whereClause)
    QString whereClause() const

    Detailed Description

    The features that create a FeatureFenceParameters provide a set of geometries (and attributes) that define targets for the Geotrigger. For example, if the condition is "notify me when my position comes within 50 meters of one of my target areas", the fence data are "my target areas" and each Feature is one target area.

    Create a FeatureFenceParameters using a FeatureTable. The features can have point, line, or polygon geometry. For points and lines, you must also supply a FenceParameters::bufferDistance. Each feature in the table represents a single fence.

    You can filter features using attributes or geometry by supplying a where clause. For example, you could further refine "my target areas" to be "my target areas that are open and are in California".

    The number of features fetched by querying an online table is limited by the layer's ArcGISFeatureLayerInfo::maxRecordCount. Service feature tables that support pagination ArcGISFeatureLayerInfo::isSupportsPagination are not subject to the maximum feature count limit.

    When saving new geotriggers into a web map, ensure that all feature layer's are assigned a unique Layer::layerId. This ensures the saved FeatureFenceParameters::featureTable is associated with the corresponding layer. When the saved Map and GeoModel::geotriggersInfo are loaded, the layer and geotrigger will use the same FeatureTable.

    Member Function Documentation

    FeatureFenceParameters::FeatureFenceParameters(Esri::ArcGISRuntime::FeatureTable *featureTable, double bufferDistance, QObject *parent = nullptr)

    Creates a FeatureFenceParameters using all of the features in the FeatureTable.

    FeatureFenceParameters::FeatureFenceParameters(Esri::ArcGISRuntime::FeatureTable *featureTable, QObject *parent = nullptr)

    Creates a FeatureFenceParameters using all of the features in the FeatureTable.

    [override virtual] FeatureFenceParameters::~FeatureFenceParameters()

    Destructor.

    Esri::ArcGISRuntime::Geometry FeatureFenceParameters::areaOfInterest() const

    Returns the geometry that can be used to spatially filter fences.

    This needs to be either an Envelope or Polygon. Use this to define which features in the FeatureTable are to be used as fences by defining an area of interest. If this property is empty, we will use the full extent of the feature table.

    See also setAreaOfInterest().

    Esri::ArcGISRuntime::FeatureTable *FeatureFenceParameters::featureTable() const

    Returns the FeatureTable that contains the features to use in the FeatureFenceParameters.

    This table can be shared with a FeatureLayer::featureTable. When saving new geotriggers into a web map, ensure all feature layer's are assigned a unique Layer::layerId. This ensures the saved FeatureFenceParameters::featureTable is associated with the corresponding layer. When the saved Map and GeoModel::geotriggersInfo are loaded, the layer and geotrigger will use the same FeatureTable.

    void FeatureFenceParameters::setAreaOfInterest(const Esri::ArcGISRuntime::Geometry &areaOfInterest)

    Sets the areaOfInterest to areaOfInterest.

    See also areaOfInterest.

    void FeatureFenceParameters::setWhereClause(const QString &whereClause)

    Sets the whereClause to whereClause.

    See also whereClause.

    QString FeatureFenceParameters::whereClause() const

    Returns a where clause that defines the features from the FeatureTable to use as fences.

    The number of features fetched by querying an online table is limited by the layer's ArcGISFeatureLayerInfo::maxRecordCount. Service feature tables that support pagination ArcGISFeatureLayerInfo::isSupportsPagination are not subject to the maximum feature count limit.

    The string that is used as the FeatureFenceParameters::whereClause should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS.

    The number of features fetched by querying an online table is limited by the layer's ArcGISFeatureLayerInfo::maxRecordCount. Service feature tables that support pagination (ArcGISFeatureLayerInfo::isSupportsPagination) are not subject to the maximum feature count limit.

    See also setWhereClause().

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.