Skip To Content ArcGIS for Developers Sign In Dashboard

ServiceAreaFacility Class

class Esri::ArcGISRuntime::ServiceAreaFacility

Represents a service area facility. More...

Header: #include <ServiceAreaFacility>
Since: Esri::ArcGISRuntime 100.1

This class was introduced in Esri::ArcGISRuntime 100.1.

Public Functions

ServiceAreaFacility(Esri::ArcGISRuntime::ServiceAreaFacility &&other)
ServiceAreaFacility(const Esri::ArcGISRuntime::ServiceAreaFacility &other)
ServiceAreaFacility(const Esri::ArcGISRuntime::Point &point)
ServiceAreaFacility()
Esri::ArcGISRuntime::ServiceAreaFacility &operator=(Esri::ArcGISRuntime::ServiceAreaFacility &&other)
Esri::ArcGISRuntime::ServiceAreaFacility &operator=(const Esri::ArcGISRuntime::ServiceAreaFacility &other)
~ServiceAreaFacility()
double addedCost(const QString &attributeName) const
Esri::ArcGISRuntime::CurbApproach curbApproach() const
double currentBearing() const
double currentBearingTolerance() const
double distanceToNetworkLocation() const
int facilityId() const
Esri::ArcGISRuntime::Point geometry() const
QList<double> impedanceCutoffs() const
bool isEmpty() const
Esri::ArcGISRuntime::LocationStatus locationStatus() const
QString name() const
double navigationLatency() const
double navigationSpeed() const
Esri::ArcGISRuntime::NetworkLocation networkLocation() const
void setAddedCost(const QString &attributeName, double costValue)
void setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)
void setCurrentBearing(double currentBearing)
void setCurrentBearingTolerance(double currentBearingTolerance)
void setFacilityId(int id)
void setGeometry(const Esri::ArcGISRuntime::Point &point)
void setImpedanceCutoffs(const QList<double> &impedanceCutoffs)
void setName(const QString &name)
void setNavigationLatency(double navigationLatency)
void setNavigationSpeed(double navigationSpeed)
void setNetworkLocation(const Esri::ArcGISRuntime::NetworkLocation &networkLocation)

Detailed Description

Facilities represent locations from which service areas need to be calculated. For example, a fire station can be set as a facility to find which areas it can serve within a 10 minute service area. A hospital can be set as the facility to find what proportion of the population is within a 2 mile driving distance.

Member Function Documentation

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

Move constructor from other ServiceAreaFacility.

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

Copy constructor from other ServiceAreaFacility.

ServiceAreaFacility::ServiceAreaFacility(const Esri::ArcGISRuntime::Point &point)

Constructor that takes in a point.

ServiceAreaFacility::ServiceAreaFacility()

Default constructor.

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

Move operator from other ServiceAreaFacility.

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

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

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

Returns the curb approach for this ServiceAreaFacility.

See also setCurbApproach().

double ServiceAreaFacility::currentBearing() const

Returns с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.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setCurrentBearing().

double ServiceAreaFacility::currentBearingTolerance() const

Returns the current bearing tolerance of this ServiceAreaFacility.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setCurrentBearingTolerance().

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.

int ServiceAreaFacility::facilityId() const

Returns ID of this facility.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setFacilityId().

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.

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.

QString ServiceAreaFacility::name() const

Returns the name of the ServiceAreaFacility.

See also setName().

Returns the navigation latency in seconds.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setNavigationLatency().

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.

See also setNetworkLocation().

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

Sets the costValue for the attribute named attributeName.

See also addedCost().

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

Sets the curb approach of this ServiceAreaFacility to curbApproach.

See also curbApproach().

void ServiceAreaFacility::setCurrentBearing(double currentBearing)

Sets the current bearing of this ServiceAreaFacility to currentBearing degrees.

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 currentBearing() and setCurrentBearingTolerance.

void ServiceAreaFacility::setCurrentBearingTolerance(double currentBearingTolerance)

Sets the current bearing tolerance of this ServiceAreaFacility to currentBearingTolerance.

Valid values are 0 to 180 or NaN.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also currentBearingTolerance() and setCurrentBearing.

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::setGeometry(const Esri::ArcGISRuntime::Point &point)

Sets the geometry indicating where this ServiceAreaFacility is located to point.

See also geometry().

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

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

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


Feedback on this topic?