ServiceAreaFacility

A class that describes service area facility. 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.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(point: Point)

Creates a service area facility instance with point. Creates a facility.

Properties

Link copied to clipboard

Curb approach. Default value CurbApproach.EitherSide will be returned on error.

Link copied to clipboard

Current 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.

Link copied to clipboard

Current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The geometry of a service area facility. Gets service area facility's location using geographical point.

Link copied to clipboard

The impedance cutoffs value. 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.

Link copied to clipboard

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

Link copied to clipboard

Service area facility's name. Service area facility's name to be reported.

Link copied to clipboard

Navigation latency in seconds.

Link copied to clipboard

Navigation speed in meters per second.

Link copied to clipboard

Network location. The service area facility's location on the network that can be populated by service area task. Set to null for resetting a network location.

Functions

Link copied to clipboard
Link copied to clipboard
fun getAddedCost(attributeName: String): Double

Gets added cost. Returns added cost value for given impedance or accumulate attribute.

Link copied to clipboard
fun setAddedCost(attributeName: String, addedCost: Double)

Sets added cost. Sets added cost value for given impedance or accumulate attribute.