ServiceAreaFacility Class

Member Function Documentation

ServiceAreaFacility::ServiceAreaFacility()

Default constructor.

[explicit] ServiceAreaFacility::ServiceAreaFacility(const Esri::ArcGISRuntime::Point &point)

Constructor that takes in a point.

ServiceAreaFacility::ServiceAreaFacility(const Esri::ArcGISRuntime::ServiceAreaFacility &other)

Copy constructor from other ServiceAreaFacility.

ServiceAreaFacility::ServiceAreaFacility(Esri::ArcGISRuntime::ServiceAreaFacility &&other)

Move constructor from other ServiceAreaFacility.

ServiceAreaFacility::~ServiceAreaFacility()

Destructor.

double ServiceAreaFacility::addedCost(const QString &attributeName) const

Returns the added cost of the attribute named attributeName.

See also setAddedCost().

[since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::ServiceAreaFacility ServiceAreaFacility::clone() const

Clones the ServiceAreaFacility to a new instance.

Returns a new instance of the current ServiceAreaFacility.

This function was introduced in Esri::ArcGISRuntime 200.1.

Esri::ArcGISRuntime::CurbApproach ServiceAreaFacility::curbApproach() const

Returns the curb approach for this ServiceAreaFacility.

Default value CurbApproach::EitherSide will be returned on error.

See also setCurbApproach().

[since Esri::ArcGISRuntime 100.7] double ServiceAreaFacility::currentBearing() const

Returns the сurrent bearing in degrees.

Current bearing in degrees, measured clockwise from True-North. Typical values are 0 to 360 or NaN, negative values will be subtracted from 360 (e.g. -15 => 345), values greater than 360 will be have 360 subtracted from them (e.g. 385 => 25). For this property to be used the bearing tolerance also has to be set.

Bearing and bearing tolerance are meant to be used together. If you only set one, then the other is ignored.

Bearing and bearing tolerance help to disambiguate how to locate facilities. For example, if you are driving on a freeway overpass and you need to reroute, then you would pass in your device compass bearing and a tolerance (say 45 degrees). This information is used to filter out streets that are potentially closer to your device x,y but are heading in the wrong direction (e.g. An underpass street might be closer to the x,y of your device but it is heading in the wrong direction and would be filtered out).

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setCurrentBearingTolerance.

[since Esri::ArcGISRuntime 100.7] double ServiceAreaFacility::currentBearingTolerance() const

Returns the current bearing tolerance of this ServiceAreaFacility.

Valid values are 0 to 180 or NaN.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setCurrentBearingTolerance() and setCurrentBearing.

double ServiceAreaFacility::distanceToNetworkLocation() const

Returns the distance in meters along a network path of this ServiceAreaFacility to a network feature.

Returns NaN if the facility has not been located.

The distance to network location in meters can be populated by service area task.

[since Esri::ArcGISRuntime 100.6] int ServiceAreaFacility::facilityId() const

Returns the service area facility ID.

This is a caller supplied foreign key that can be used to associate output facilities with input facilities.

{ServiceAreaParameters::setFacilities(const QList<Esri::ArcGISRuntime::ServiceAreaFacility&>)}, {Esri::ArcGISRuntime::ServiceAreaResult::facilities} {ServiceAreaResult::facilities}

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setFacilityId() and Esri::ArcGISRuntime::ServiceAreaParameters::setFacilities(const QList<Esri::ArcGISRuntime::ServiceAreaFacility>&).

Esri::ArcGISRuntime::Point ServiceAreaFacility::geometry() const

Returns the geometry indicating where this ServiceAreaFacility is located.

See also setGeometry().

QList<double> ServiceAreaFacility::impedanceCutoffs() const

Returns the impedance cutoffs of this ServiceAreaFacility.

Cutoffs specify the quantity of the impedance to apply. They constrain the extent of the service area to be calculated. For example, if you apply breaks of 5, 10, and 15 when the impedance is set to Time, the service area will include those streets that can be reached within 5, 10, and 15 minutes. The value specified in the impedance cutoffs property overrides the Default Cutoffs analysis setting. If no value for the impedance cutoffs property is specified, service area are generated for the facility based on the Default Cutoffs setting.

See also setImpedanceCutoffs().

bool ServiceAreaFacility::isEmpty() const

Returns true if this ServiceAreaFacility is empty.

Esri::ArcGISRuntime::LocationStatus ServiceAreaFacility::locationStatus() const

Returns the LocationStatus of this ServiceAreaFacility.

Facility location's status can be populated by service area task. Default value LocationStatus::NotLocated will be returned on error.

QString ServiceAreaFacility::name() const

Returns the name of the ServiceAreaFacility.

See also setName().

[since Esri::ArcGISRuntime 100.7] double ServiceAreaFacility::navigationLatency() const

Returns the navigation latency in seconds.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setNavigationLatency().

[since Esri::ArcGISRuntime 100.7] double ServiceAreaFacility::navigationSpeed() const

Returns the navigation speed of this ServiceAreaFacility in meters-per-second.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setNavigationSpeed().

Esri::ArcGISRuntime::NetworkLocation ServiceAreaFacility::networkLocation() const

Returns the network location of this ServiceAreaFacility.

The service area facility's location on the network that can be populated by service area task.

See also setNetworkLocation().

void ServiceAreaFacility::setAddedCost(const QString &attributeName, double costValue)

Sets added cost.

• attributeName - The name of attribute.
• costValue - The added cost.

Sets added cost value for given impedance or accumulate attribute.

See also addedCost().

void ServiceAreaFacility::setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)

Sets the curb approach of this ServiceAreaFacility to curbApproach.

See also curbApproach.

[since Esri::ArcGISRuntime 100.7] void ServiceAreaFacility::setCurrentBearing(double currentBearing)

Sets the current bearing of this ServiceAreaFacility to currentBearing degrees.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also currentBearing.

[since Esri::ArcGISRuntime 100.7] void ServiceAreaFacility::setCurrentBearingTolerance(double currentBearingTolerance)

Sets the current bearing tolerance of this ServiceAreaFacility to currentBearingTolerance.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also currentBearingTolerance.

[since Esri::ArcGISRuntime 100.6] void ServiceAreaFacility::setFacilityId(int id)

Sets the id of this facility.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also facilityId.

void ServiceAreaFacility::setImpedanceCutoffs(const QList<double> &impedanceCutoffs)

Sets the impedance cutoffs of this ServiceAreaFacility to impedanceCutoffs.

See also impedanceCutoffs.

void ServiceAreaFacility::setName(const QString &name)

Sets the name of the ServiceAreaFacility.

See also name().

[since Esri::ArcGISRuntime 100.7] void ServiceAreaFacility::setNavigationLatency(double navigationLatency)

Sets the navigation latency of this ServiceAreaFacility to navigationLatency seconds.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also navigationLatency.

[since Esri::ArcGISRuntime 100.7] void ServiceAreaFacility::setNavigationSpeed(double navigationSpeed)

Sets the navigationSpeed in meters-per-second.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also navigationSpeed.

void ServiceAreaFacility::setNetworkLocation(const Esri::ArcGISRuntime::NetworkLocation &networkLocation)

Sets the network location of this ServiceAreaFacility to networkLocation.

See also networkLocation.

Esri::ArcGISRuntime::ServiceAreaFacility &ServiceAreaFacility::operator=(const Esri::ArcGISRuntime::ServiceAreaFacility &other)

Assignment operator from other ServiceAreaFacility.

Esri::ArcGISRuntime::ServiceAreaFacility &ServiceAreaFacility::operator=(Esri::ArcGISRuntime::ServiceAreaFacility &&other)

Move operator from other ServiceAreaFacility.