IndoorsLocationDataSourceConfiguration Class

  • IndoorsLocationDataSourceConfiguration
  • class Esri::ArcGISRuntime::IndoorsLocationDataSourceConfiguration

    Stores configuration settings for an IndoorsLocationDataSource. More...

    Header: #include <IndoorsLocationDataSourceConfiguration.h>
    Since: Esri::ArcGISRuntime 200.4
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    IndoorsLocationDataSourceConfiguration(QObject *parent = nullptr)
    virtual ~IndoorsLocationDataSourceConfiguration() override
    bool areInfoMessagesEnabled() const
    bool isAppleIpsEnabled() const
    bool isGnssEnabled() const
    bool isIpsAreaSnappingEnabled() const
    bool isMotionSmoothingEnabled() const
    bool isPathSnappingEnabled() const
    double pathSnappingDistance() const
    void setAppleIpsEnabled(bool appleIpsEnabled)
    void setGnssEnabled(bool gnssEnabled)
    void setInfoMessagesEnabled(bool areInfoMessagesEnabled)
    void setIpsAreaSnappingEnabled(bool ipsAreaSnappingEnabled)
    void setMotionSmoothingEnabled(bool motionSmoothingEnabled)
    void setPathSnappingDistance(double pathSnappingDistance)
    void setPathSnappingEnabled(bool pathSnappingEnabled)

    Detailed Description

    Member Function Documentation

    [explicit] IndoorsLocationDataSourceConfiguration::IndoorsLocationDataSourceConfiguration(QObject *parent = nullptr)

    Creates an IndoorsLocationDataSourceConfiguration.

    • parent - The optional parent QObject.

    [override virtual] IndoorsLocationDataSourceConfiguration::~IndoorsLocationDataSourceConfiguration()

    Destructor.

    [since Esri::ArcGISRuntime 200.5] bool IndoorsLocationDataSourceConfiguration::areInfoMessagesEnabled() const

    Returns true to enable reporting info messages.

    If enabled, IndoorsLocationDataSource sends additional messages that are otherwise not forwarded to the user. These messages may be useful for diagnosing issues and troubleshooting. The additional messages are sent through the IndoorsLocationDataSource::messageReceived event. Enabling this setting is meant for debugging purposes and might negatively affect performance. Changes to areInfoMessagesEnabled do not require stopping of the data source to take effect. Default is false.

    This function was introduced in Esri::ArcGISRuntime 200.5.

    bool IndoorsLocationDataSourceConfiguration::isAppleIpsEnabled() const

    Returns true to enable Apple IPS position, false otherwise.

    This configuration is used during the start of IndoorsLocationDataSource. For configuration changes to take effect, you must stop the data source before making changes and then restart with the updated configuration. Default is true.

    bool IndoorsLocationDataSourceConfiguration::isGnssEnabled() const

    Returns true to enable GNSS position, false otherwise.

    This configuration is used during the start of IndoorsLocationDataSource. For configuration changes to take effect, you must stop the data source before making changes and then restart with the updated configuration. Default is true.

    bool IndoorsLocationDataSourceConfiguration::isIpsAreaSnappingEnabled() const

    Returns true to enable snapping to the IPS area, false otherwise.

    If enabled, IndoorsLocationDataSource will snap Bluetooth and WiFi-based positions to the IPS area that is currently defined by the positioning file or indoor positioning data service. This configuration is used during the start of IndoorsLocationDataSource. For configuration changes to take effect, you must stop the data source before making changes and then restart with the updated configuration. Default is true.

    bool IndoorsLocationDataSourceConfiguration::isMotionSmoothingEnabled() const

    Returns true to enable motion smoothing, false otherwise.

    If enabled, IndoorsLocationDataSource uses an average of the last N positions to display the position with smoother motion and smaller jumps between updates. This configuration is used during the start of IndoorsLocationDataSource. For configuration changes to take effect, you must stop the data source before making changes and then restart with the updated configuration. Default is true.

    bool IndoorsLocationDataSourceConfiguration::isPathSnappingEnabled() const

    Returns true to enable path snapping, false otherwise.

    If enabled, IndoorsLocationDataSource will snap the position to the closest point on the pathways. This configuration is used during the start of IndoorsLocationDataSource. For configuration changes to take effect, you must stop the data source before making changes and then restart with the updated configuration. Default is true.

    double IndoorsLocationDataSourceConfiguration::pathSnappingDistance() const

    Returns a tolerance within which the position is snapped to the nearest point on a path.

    This is a map distance in meters and must be greater than zero. This configuration is used during the start of IndoorsLocationDataSource. For configuration changes to take effect, you must stop the data source before making changes and then restart with the updated configuration. Default is 5 meters.

    See also setPathSnappingDistance().

    void IndoorsLocationDataSourceConfiguration::setAppleIpsEnabled(bool appleIpsEnabled)

    Sets the appleIpsEnabled to appleIpsEnabled.

    See also isAppleIpsEnabled.

    void IndoorsLocationDataSourceConfiguration::setGnssEnabled(bool gnssEnabled)

    Sets the gnssEnabled to gnssEnabled.

    See also isGnssEnabled.

    [since Esri::ArcGISRuntime 200.5] void IndoorsLocationDataSourceConfiguration::setInfoMessagesEnabled(bool areInfoMessagesEnabled)

    Sets the areInfoMessagesEnabled to areInfoMessagesEnabled.

    This function was introduced in Esri::ArcGISRuntime 200.5.

    See also areInfoMessagesEnabled.

    void IndoorsLocationDataSourceConfiguration::setIpsAreaSnappingEnabled(bool ipsAreaSnappingEnabled)

    Sets the ipsAreaSnappingEnabled to ipsAreaSnappingEnabled.

    See also isIpsAreaSnappingEnabled.

    void IndoorsLocationDataSourceConfiguration::setMotionSmoothingEnabled(bool motionSmoothingEnabled)

    Sets the motionSmoothingEnabled to motionSmoothingEnabled.

    See also isMotionSmoothingEnabled.

    void IndoorsLocationDataSourceConfiguration::setPathSnappingDistance(double pathSnappingDistance)

    Sets the pathSnappingDistance to pathSnappingDistance.

    See also pathSnappingDistance.

    void IndoorsLocationDataSourceConfiguration::setPathSnappingEnabled(bool pathSnappingEnabled)

    Sets the pathSnappingEnabled to pathSnappingEnabled.

    See also isPathSnappingEnabled.

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