IndoorsLocationDataSourceConfiguration Class

Member Function Documentation

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

Creates an IndoorsLocationDataSourceConfiguration.

• parent - The optional parent QObject.

[override virtual noexcept] 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.

[since Esri::ArcGISRuntime 200.6] Esri::ArcGISRuntime::IndoorsLocationDataSourceConfiguration *IndoorsLocationDataSourceConfiguration::clone(QObject *parent = nullptr) const

Clones the IndoorsLocationDataSourceConfiguration with an optional parent.

This function was introduced in Esri::ArcGISRuntime 200.6.

bool IndoorsLocationDataSourceConfiguration::isAppleIpsEnabled() const

Always returns false.

ArcGIS Maps SDK for Qt does not support AppleIPS.

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 can help improve the user experience, but may cause the displayed position to lag behind the actual position of the device. 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 false starting from 300.0.0.

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().

[since Esri::ArcGISRuntime 200.6] Esri::ArcGISRuntime::LinearUnit IndoorsLocationDataSourceConfiguration::pathSnappingUnit() const

Returns the unit of the pathSnappingDistance.

Unit is the linear unit by which the value of the path-snapping distance is measured. Currently only LinearUnitId::Meters and LinearUnitId::Feet are supported. 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. By default, the linear unit is meters.

This function was introduced in Esri::ArcGISRuntime 200.6.

See also setPathSnappingUnit().

void IndoorsLocationDataSourceConfiguration::setAppleIpsEnabled(bool appleIpsEnabled)

Sets the appleIpsEnabled to appleIpsEnabled.

ArcGIS Maps SDK for Qt does not support AppleIPS.

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.

[since Esri::ArcGISRuntime 200.6] void IndoorsLocationDataSourceConfiguration::setPathSnappingUnit(const Esri::ArcGISRuntime::LinearUnit &pathSnappingUnit)

Sets the pathSnappingUnit to pathSnappingUnit.

This function was introduced in Esri::ArcGISRuntime 200.6.

See also pathSnappingUnit.