NAServerServiceAreaParams
Base Type: NAServerSolverParams
A class that describes the default properties on a service area network analysis layer and is used to set the input properties that are used by the Solve method to perform network analysis.
Property |
Type |
Description |
---|---|---|
Barriers |
The input locations to load as barriers to restrict traversability during analysis. | |
CreateTraversalResult |
bool |
Specifies if the analysis will internally create a traversal result. If the output lines are none or straight and directions aren't returned, this can be set to false for better performance. |
DefaultBreaks |
double[] |
The default breaks to indicate how many rings to compute for each facility. For example, if {3,5} was specified, it would mean to create 2 service area polygons for each facility representing traveling out 3 and 5 minutes. |
ExcludeSourcesFromPolygons |
string[] |
The names of the sources to exclude from the service area polygon generation. A service area on a multi-modal network where only one mode is being used to compute the service area would get a more appropriate shape if other modes are excluded from the polygons. |
Facilities |
Indicates if the "SourceID", "SourceOID", "FromPosition" and "ToPosition" fields on the SALines feature class will be populated or not. If this property is set to true, you can use these fields on the SALines to determine the source features and position along the feature that were part of the service area. | |
IncludeSourceInformationOnLines |
bool |
Indicates if polygons with same break values from different facilities should be merged together. |
MergeSimilarPolygonRanges |
bool |
Indicates if similar ranges should be merged in the result polygons. |
OutputLines |
The type of lines to compute for the output service area lines. Options include true shapes, true shapes with measures, straight lines, or no lines. If ReturnSALines is false, set this to none for better performance. | |
OutputPolygons |
The type of polygons to be generated. For example, the choice could be simplified, detailed, or none. The detailed option accurately models the service area lines and may contain islands of unreached areas. The simplified option runs faster but is not as accurate at some fringes. | |
OverlapLines |
bool |
Indicates if service area lines of two or more facilities will overlap and return coincident features or will be apportioned to the closest facility. For example, a break value of 3.0 minutes will return all of the lines that can be reached within 3.0 minutes of the facility. If OverlapLines is set to false then only the line to the closest facility will be returned. In cases where parts of a line correspond to different facilities, the single line will be split and the two resulting lines will be apportioned appropriately. |
OverlapPolygons |
bool |
Indicates if service area polygons from multiple facilities may overlap. If set to false, the service area polygons generated will not overlap and each polygon will encompass the area reached by the closest facility. |
PolygonBarriers |
The input locations to load as polygon barriers to restrict traversability or scale cost during analysis. | |
PolylineBarriers |
The input locations to load as line barriers to restrict traversability or scale cost during analysis. | |
ReturnBarriers |
bool |
Indicates if the point barriers used during analysis should be returned. |
ReturnFacilities |
bool |
Indicates if the facilities used during analysis should be returned as a RecordSet. |
ReturnPolygonBarriers |
bool |
Indicates if the polygon barriers used during analysis should be returned. |
ReturnPolygonBarriersSpecified |
bool |
Indicates if ReturnPolygonBarriers is specified. |
ReturnPolylineBarriers |
bool |
Indicates if the polyline barriers used during analysis should be returned. |
ReturnPolylineBarriersSpecified |
bool |
Indicates if ReturnPolylineBarriers is specified. |
ReturnSALineGeometries |
bool |
Indicates if the geometries representing the streets reached should be returned in an array of Polyline. |
ReturnSALines |
bool |
Indicates if the service area line features should be returned as a RecordSet. |
ReturnSAPolygonGeometries |
bool |
Indicates if the geometries representing the area reached should be returned in an array of Polygons. |
ReturnSAPolygons |
bool |
Indicates if the service area polygon features should be returned as a RecordSet. |
SplitLinesAtBreaks |
bool |
Indicates if service area lines will be split at break values. |
SplitPolygonsAtBreaks |
bool |
Indicates if the service area polygons will be split at the specified breaks. If they are not split, each break value gets a polygon starting from the start facility. If they are split at break values, then each polygon is like a donut (i.e., starts at the previous break value and ends at the next break value). |
TravelDirection |
The direction of travel; either from or to the facility. | |
TrimOuterPolygon |
bool |
Indicates if the outer polygon will be adjusted to be within the TrimPolygonDistance of the source features. It is used to make the outer ring more cartographically pleasing by shrinking it to within a specified distance. This operation is not the same as clipping or buffering. Small values for TrimPolygonDistance will increase processing time and may result in unusual looking polygons. |
TrimPolygonDistance |
double |
The distance (based on units specified by TrimPolygonDistanceUnits) that the outer service area polygon should be from the source features. This is useful to reduce the area of the outer service area polygon in sparse networks. |
TrimPolygonDistanceUnits |
The units used by the TrimPolygonDistance property. | |
UseHierarchy | bool | Makes the Service Area solver use network hierarchy during the analysis. This makes the polygon building process much faster but applies the following limitations; only simplified polygons can be built, no SALines can be output. |
TimeOfDay | dateTime | Indicates time at the Facility. |
TimeOfDayUsage | Indicates how the TimeOfDay value will be used during the analysis. |
Remarks
Do not set both ReturnSALineGeometries and ReturnSALines to true. If just the geometry is needed, just set ReturnSALineGeometries to true. If the geometry and the other fields on the SALines RecordSet are needed, just set ReturnSALines to true since the geometries in the shape field of SALines are the same geometries that are returned in ReturnSALineGeometries.
The same applies to ReturnSAPolygonGeometries and ReturnSAPolygons as well.
The TimeOfDay always specifies time at the Facility (Facilities).
- If TravelDirection equals esriNATravelDirectionFromFacility, TimeOfDayUsage must be set to esriNATimeOfDayUseAsStartTime or esriNATimeOfDayNotUsed.
- If TravelDirection equals esriNATravelDirectionToFacility, TimeOfDayUsage must be set to esriNATimeOfDayUseAsEndTime or esriNATimeOfDayNotUsed.