SimulationParameters Class

SimulationParameters

class Esri::ArcGISRuntime::SimulationParameters

Parameters to control how locations are created from a simulated route of travel (Polyline). More...

Header:	`#include <SimulationParameters.h>`
Since:	Esri::ArcGISRuntime 100.8
Inherits:	Esri::ArcGISRuntime::Object

List of all members, including inherited members

Public Functions

	SimulationParameters(QObject *parent = nullptr)
	SimulationParameters(const QDateTime &startTime, double velocity, double horizontalAccuracy, double verticalAccuracy, QObject *parent = nullptr)
virtual	~SimulationParameters() override
double	horizontalAccuracy() const
void	setHorizontalAccuracy(double horizontalAccuracy)
void	setStartTime(const QDateTime &startTime)
void	setVelocity(double velocity)
void	setVerticalAccuracy(double verticalAccuracy)
QDateTime	startTime() const
double	velocity() const
double	verticalAccuracy() const

Detailed Description

This can be provided as an input to the SimulatedLocationDataSource::setLocationsWithPolyline(const Esri::ArcGISRuntime::Polyline&, Esri::ArcGISRuntime::SimulationParameters*) method to specify the start time for the first location, travel velocity (meters per second), and horizontal and vertical accuracy of locations.

Member Function Documentation

`[explicit]` SimulationParameters::SimulationParameters(QObject **parent* = nullptr)

Creates a SimulationParameters.

parent - The optional parent QObject.

SimulationParameters::SimulationParameters(const QDateTime &startTime, double velocity, double horizontalAccuracy, double verticalAccuracy, QObject **parent* = nullptr)

Creates a new SimulationParameters parameters object.

startTime - Date and time of the first location. Each subsequent location will increment its timestamp by one second.
velocity - Rate of travel, in meters per second. Default value is 10.0. Note that very small values for velocity may greatly increase the number of locations created.
horizontalAccuracy - The horizontal accuracy to assign to generated locations. Default value is 0.0.
verticalAccuracy - The vertical accuracy to assign to generated locations. Default value is 0.0.
parent - The optional parent QObject.

`[override virtual noexcept]` SimulationParameters::~SimulationParameters()

Destructor.

double SimulationParameters::horizontalAccuracy() const

Returns the horizontal accuracy to assign to generated locations.

The default value is 0.0.

See also setHorizontalAccuracy().

void SimulationParameters::setHorizontalAccuracy(double horizontalAccuracy)

Sets the horizontalAccuracy to horizontalAccuracy.

See also horizontalAccuracy.

void SimulationParameters::setStartTime(const QDateTime &startTime)

Sets the startTime to startTime.

See also startTime.

void SimulationParameters::setVelocity(double velocity)

Sets the velocity to velocity.

See also velocity.

void SimulationParameters::setVerticalAccuracy(double verticalAccuracy)

Sets the verticalAccuracy to verticalAccuracy.

See also verticalAccuracy.

QDateTime SimulationParameters::startTime() const

Returns date and time of the first location. Each subsequent location will increment its timestamp by one second.

See also setStartTime().

double SimulationParameters::velocity() const

Returns rate of travel, in meters-per-second.

The default value is 10.0. Note that very small values for velocity may greatly increase the number of locations created.

See also setVelocity().

double SimulationParameters::verticalAccuracy() const

Returns the vertical accuracy to assign to generated locations.