NAServerClosestFacilityParams

Base Type: NAServerSolverParams

A class that describes the default properties on a closest facility 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	NAServerLocations	The input locations to load as point 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.
DefaultCutoff	object	The default cutoff to limit how far to search for facilities from each incident.
DefaultTargetFacilityCount	int	The default number of facilities to find from each incident.
DirectionsLanguage	string	The language used when generating directions. This string must match a language listed in the directions.lng file on the server.
DirectionsOutputType	esriDirectionsOutputType	Defines the type of content of directions.
DirectionsOutputTypeSpecified	bool	Indicates if DirectionsOutputType is specified.
DirectionsStyleName	string	The name of the formatting style of directions. For the list of supported styles see NAServer.GetNetworkDescription() and NAServerNetworkDirections.
DirectionsLengthUnits	esriNetworkAttributeUnits	The length units used when generating directions.
DirectionsTimeAttributeName	string	The name of the time network attribute to use when generating directions.
Facilities	NAServerLocations	The input locations to load as facilities.
Incidents	NAServerLocations	The input locations to load as incidents.
OutputLines	esriNAOutputLineType	The type of lines to compute for the output routes. Options include true shapes, true shapes with measures, straight lines, or no lines. If you are not returning routes, set this to none for better performance.
PolygonBarriers	NAServerLocations	The input locations to load as polygon barriers to restrict traversability or scale cost.
PolylineBarriers	NAServerLocations	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.
ReturnCFRouteGeometries	bool	Indicates if the route geometries should be returned in an array of Polyline.
ReturnCFRoutes	bool	Indicates if the route features should be returned as a RecordSet.
ReturnCompactDirections	bool	Indicates if compact driving directions should be returned.
ReturnDirections	bool	Indicates if driving directions should be returned.
ReturnFacilities	bool	Indicates if the facilities used during analysis should be returned as a RecordSet.
ReturnIncidents	bool	Indicates if the incidents 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.
TravelDirection	esriNATravelDirection	The direction of travel; either from or to the facility.
TimeOfDay	dateTime	Indicates time of departing from/arriving at the Facilities or Incidents.
TimeOfDayUsage	esriNATimeOfDayUsage	Indicates how the TimeOfDay value will be used during the analysis.

Remarks

Do not set both ReturnCFRouteGeometries and ReturnCFRoutes to true. If just the geometry is needed, just set ReturnCFRouteGeometries to true. If the geometry and the other fields on the CFRoutes RecordSet are needed, just set ReturnCFRoutes to true since the geometries in the shape field of CFRoutes are the same geometries that are returned in CFRouteGeometries.

Do not set both ReturnDirections and ReturnCompactDirections to true. They each return directions in slightly different formats but contain similar information. Either direction format can be used independently and it is bad practice to return both formats. The time to compute each type of directions is considerable and should not be done unless necessary.