Skip To Content

ServiceArea output data types

On successful execution the tool returns the the service areas around the facilities and the status indicating the analysis was successful.

Describes the output data types containing the results from a service area analysis.

Polygons

Provide access to polygon features that representing areas that can be reached from the input locations with a given travel time, travel distance, or travel cost.

This data type supports the following fields. In addition to these fields, the data type also includes all the fields from the input feature class used as facilities for the analysis when generating overlapping or non-overlapping polygons..

Field name

Description

Data type

Name

The name of the service area. It is based on the name of the associated facility and the cutoffs; for instance, Store1: 0.0 – 5.0 represents a service area that covers all traversable streets within five minutes of a facility named Store1.

The break values are returned without the name of the facility, for example, 0.0 – 5.0, when thegeometryAtOverlap property of the analysis object is set to ServiceAreaOverlapGeometry.Dissolve.

Text

FacilityID

The unique identifier of the associated facility that is automatically generated by the analysis.

Multiple facilities may be associated with one service area when geometryAtOverlap property of the analysis object is set to ServiceAreaOverlapGeometry.Dissolve; therefore, FacilityID field values are set to null when service areas are merged.

Long

FacilityOID

The ObjectID value of the input facility feature used to generate the service area polygon. This field is often used to join information from the input facilities.

Multiple facilities may be associated with one service area when geometryAtOverlap property of the analysis object is set to ServiceAreaOverlapGeometry.Dissolve; therefore, FacilityOID field values are set to null when service areas are merged.

Long

FromBreak

The lower bound of the service area's impedance cutoff range. The units for this field value is based on the impedance attribute of the travel mode set for the analysis.

If the impedance attribute is time-based, the value is in the units specified by the timeUnits property; if the impedance attribute is distance-based, the value is in the units specified by the distanceUnits property; and the value is in unknown units if the impedance attribute is neither time-based or distance-based.

Double

ToBreak

The upper bound of the service area's impedance cutoff range. The value is in the same units as the FromBreak field values.

Double

Breaks

The values for this field are copied from the Breaks field on the input facilities.

Text

AdditionalTime

The values for this field are copied from the AdditionalTime field on the input facilities.

Double

AdditionalDistance

The values for this field are copied from the AdditionalDistance field on the input facilities.

Double

AdditionalCost

The values for this field are copied from the AdditionalDistance field on the input facilities.

Double

Lines

Stores the resultant service areas as linear features and covers the streets, or network edges, that can be reached within the given time, distance, or other travel-cost cutoff. Lines are a truer representation of a service area than polygons since service area analyses are based on measurements along the network lines.

This data type supports the following fields:

Field name

Description

Data type

FacilityOID

The ObjectID value of the input facility feature used to generate the service area lines. This field is often used to join information from the input facilities.

Long

SourceName

Each service area line traverses a feature from a network source feature class-a feature class used to create the network dataset on which the service area analysis is performed. This field contains the name of the edge source feature class from which the line was generated.

Text

SourceOID

The ObjectID of the traversed street feature. Summarizing the values for this field can provide useful information such as the number of times a particular street feature is included from which facilities.

Long

FromPosition

Specifies where along the underlying source feature the service area line begins.

  • A value of 0 (zero) indicates the service area line begins at the from-point of the underlying source feature.
  • A value of 1 indicates the service area line begins at the to-point of the source feature.
  • A value between 0 and 1 indicates the line begins at a point along the underlying source feature; for example, a value of 0.25 means the line begins 25 percent along the digitized direction of the underlying source feature.

Double

ToPosition

Specifies where along the underlying source feature the service area line ends.

  • A value of 0 (zero) indicates the service area line ends at the from-point of the underlying source feature.
  • A value of 1 indicates the service area line ends at the to-point of the source feature.
  • A value between 0 and 1 indicates the line ends at a point along the underlying source feature; for example, a value of 0.25 means the line ends 25 percent along the digitized direction of the underlying source feature.

Double

FromCumul_Minutes

This field contains the cumulative cost, in minutes, of the path from the facility to the beginning of the line feature. The cost of the adjacent junction at the beginning of the line is included in this value.

Note:

An additional field FromCumul_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Note:

Additional fieldsFromCumul_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

ToCumul_Minutes

This field contains the cumulative cost, in minutes, of the path from the facility to the end of the line feature. The cost of the adjacent junction at the end of the line is excluded from this value.

Note:

An additional field ToCumul_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Note:

Additional fieldsToCumul_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

FromCumul_Miles

This field contains the cumulative cost, in miles, of the path from the facility to the beginning of the line feature. The cost of the adjacent junction at the beginning of the line is included in this value.

Note:

An additional field FromCumul_[DistanceUnits] is included if the distanceUnits property of the analysis object is not set to DistanceUnits.Miles or DistanceUnits.Kilometers. The field values are in the units specified by the distanceUnits property.

Note:

Additional fieldsFromCumul_[AccumulateAttributeName]_[DistanceUnits] are included for each distance-based cost attribute that is accumulated during the analysis.

Double

ToCumul_Miles

This field contains the cumulative cost, in miles, of the path from the facility to the end of the line feature. The cost of the adjacent junction at the end of the line is excluded from this value.

Note:

An additional field ToCumul_[DistanceUnits] is included if the distanceUnits property of the analysis object is not set to DistanceUnits.Miles or DistanceUnits.Kilometers. The field values are in the units specified by the distanceUnits property.

Note:

Additional fieldsToCumul_[AccumulateAttributeName]_[DistanceUnits] are included for each distance-based cost attribute that is accumulated during the analysis.

Double

FromCumul_Kilometers

This field is analogous to FromCumul_Miles field except the field values are in kilometers instead of miles.

Double

ToCumul_Kilometers

This field is analogous to ToCumul_Miles field except the field values are in kilometers instead of miles.

Double

FromCumul_Other

This field contains the cumulative cost, in unknown units, of the path from the facility to the beginning of the line feature. The cost of the adjacent junction at the beginning of the line is included in this value.

This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based.

Note:

Additional fieldsFromCumul_[AccumulateAttributeName]_Other are included for each cost attribute that is neither time-based or distance-based and accumulated during the analysis.

Double

ToCumul_Other

This field contains the cumulative cost, in unknown units, of the path from the facility to the end of the line feature. The cost of the adjacent junction at the end of the line is excluded from this value.

This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based.

Note:

Additional fieldsToCumul_[AccumulateAttributeName]_Other are included for each cost attribute that is neither time-based or distance-based and accumulated during the analysis.

Double

Facilities

Provides access to the attributes of the facilities that are used in the service area analysis. You can use the attributes from this data type, such as the Status field, to determine why a facility was not used in the analysis.

The data type supports the following fields. In addition to these fields, the data type also includes all the fields from the input feature class used as facilities for the analysis.

Field name

Description

Data type

Name

The name of the facility. The values for this field are copied from the Name field on the input facilities.

Text

FacilityOID

The ObjectID value of the input facility feature. This field is often used to join information from the input facilities.

Long

Breaks

The values for this field are copied from the Breaks field on the input facilities.

Text

AdditionalTime

The values for this field are copied from the AdditionalTime field on the input facilities.

Double

AdditionalDistance

The values for this field are copied from the AdditionalDistance field on the input facilities.

Double

AdditionalCost

The values for this field are copied from the AdditionalDistance field on the input facilities.

Double

SourceID

The numeric identifier of the source feature class containing the source feature that the network location is located on.

Long

SourceOID

The numeric identifier of the source feature in the source feature class.

Long

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. For example a value of 0.47 indicates that the point is positioned 47 percent from the start of the source line feature.

Double

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. The field can have two possible values. A value of 1 indicates the point is on the right side of the line feature and a value of 0 indicates the point is on the left side of the line feature.

Long

CurbApproach

The direction a vehicle may arrive at and depart from the facility. The values for this field are copied from the CurbApproach field on input facilities.

Long

Status

Indicates how the facility was evaluated in the analysis. The possible values are the following:

  • 0 (OK)—The facility was successfully located on the transportation network and analyzed.
  • 1 (Not Located)—The facility was not included in the analysis since a traversable road was not found within the maximum search distance from the facility.
  • 4 (Not Reached)—The facility couldn't be reached due to constraints; for example, a curb approach is set so that a vehicle must travel in the wrong direction on a one-way street to reach the facility.
  • 7 (Not located on closest)— The closest network location to the facility is not traversable because of a restriction or barrier, so the facility has been located on the closest traversable network feature instead.

Long

SnapX

The x-coordinate value for the computed network location.

Double

SnapY

The y-coordinate value for the computed network location.

Double

SnapZ

The z-coordinate value for the computed network location.

The field has a non-zero value only when the input network dataset supports connectivity based on z-coordinate values of the network sources.

Double

DistanceToNetworkInMeters

The distance, in meters, between the location of the point feature and its computed network location.

Double

Bearing

The values for this field are copied from the Bearing field on the input facilities.

Double

BearingTol

The values for this field are copied from the BearingTol field on the input facilities.

Double

NavLatency

The values for this field are copied from the NavLatency field on the input facilities.

Double