;

FenceGeotrigger Class

  • FenceGeotrigger
  • class Esri::ArcGISRuntime::FenceGeotrigger

    A Geotrigger that defines regions or fences to be monitored using a GeotriggerMonitor. More...

    Header: #include <FenceGeotrigger>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::Geotrigger

    This class was introduced in Esri::ArcGISRuntime 100.12.

    Public Functions

    FenceGeotrigger(Esri::ArcGISRuntime::GeotriggerFeed *feed, Esri::ArcGISRuntime::FenceRuleType ruleType, Esri::ArcGISRuntime::FenceParameters *fenceParameters, Esri::ArcGISRuntime::ArcadeExpression *messageExpression, const QString &geotriggerName, QObject *parent = nullptr)
    FenceGeotrigger(Esri::ArcGISRuntime::GeotriggerFeed *feed, Esri::ArcGISRuntime::FenceRuleType ruleType, Esri::ArcGISRuntime::FenceParameters *fenceParameters, QObject *parent = nullptr)
    virtual ~FenceGeotrigger() override
    Esri::ArcGISRuntime::FenceParameters *fenceParameters() const
    Esri::ArcGISRuntime::FenceRuleType ruleType() const
    void setRuleType(Esri::ArcGISRuntime::FenceRuleType ruleType)

    Detailed Description

    You can monitor areas of interest with a FenceGeotrigger, using spatial rules like enter or exit. This type of operation is also known as "Geofencing".

    Three main components comprise a FenceGeotrigger:

    • The GeotriggerFeed that is monitored for changes - usually the device location read from a AbstractLocationDataSource.
    • The FenceRuleType that describes the check that is performed with the feed and fence data - for example, "enters within 50 meters of".
    • The FenceParameters that the feed data are evaluated against. For example, a set of polygon features representing areas of interest. The FenceParameters can cover many features or graphics that are checked.

    Member Function Documentation

    FenceGeotrigger::FenceGeotrigger(Esri::ArcGISRuntime::GeotriggerFeed *feed, Esri::ArcGISRuntime::FenceRuleType ruleType, Esri::ArcGISRuntime::FenceParameters *fenceParameters, Esri::ArcGISRuntime::ArcadeExpression *messageExpression, const QString &geotriggerName, QObject *parent = nullptr)

    Constructs FenceGeotrigger with an expression and a name.

    • feed - The GeotriggerFeed that is monitored for changes.
    • ruleType - The FenceRuleType that describes the check that will be performed upon the feed data.
    • fenceParameters - The FenceParameters that will be evaluated.
    • messageExpression - The ArcadeExpression that will be evaluated to create a notification message.
    • geotriggerName - The name for the FenceGeotrigger.
    • parent - The optional parent QObject.

    FenceGeotrigger::FenceGeotrigger(Esri::ArcGISRuntime::GeotriggerFeed *feed, Esri::ArcGISRuntime::FenceRuleType ruleType, Esri::ArcGISRuntime::FenceParameters *fenceParameters, QObject *parent = nullptr)

    Constructs a FenceGeotrigger.

    • feed - The GeotriggerFeed that is monitored for changes.
    • ruleType - The FenceRuleType that describes the check that will be performed upon the feed data.
    • fenceParameters - The FenceParameters that will be evaluated.
    • parent - The optional parent QObject.

    [override virtual] FenceGeotrigger::~FenceGeotrigger()

    Destructor.

    Esri::ArcGISRuntime::FenceParameters *FenceGeotrigger::fenceParameters() const

    Returns the FenceParameters that will be evaluated.

    For example, a set of polygon features representing areas of interest. The FenceParameters can cover many features or graphics that will be checked.

    There are three types of FenceParameters:

    Esri::ArcGISRuntime::FenceRuleType FenceGeotrigger::ruleType() const

    Returns the FenceRuleType that describes the check performed with the feed and fence data.

    The rule controls the spatial query that will be used - for example "enter" or "exit".

    See also setRuleType().

    void FenceGeotrigger::setRuleType(Esri::ArcGISRuntime::FenceRuleType ruleType)

    Sets the ruleType to ruleType.

    See also ruleType.

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