|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface INAServiceAreaSolver
Provides access to the service area solver.
INAServerSolverResults has been superseded by INAServerSolverResults2.
| Method Summary | |
|---|---|
IDoubleArray |
getDefaultBreaks()
The default break(s) of the traversal. |
IStringArray |
getExcludeSourcesFromPolygons()
A collection of network source names to NOT use when generating polygons. |
int |
getOutputLines()
The type of line(s) generated. |
int |
getOutputPolygons()
The type of polygon(s) generated. |
int |
getTravelDirection()
The direction of the traversal. |
boolean |
isMergeSimilarPolygonRanges()
Indicates if similar ranges should be merged in the result polygons. |
boolean |
isOverlapLines()
Indicates if lines should overlap from multiple facilities. |
boolean |
isSplitLinesAtBreaks()
Indicates if lines should be split at breaks. |
boolean |
isSplitPolygonsAtBreaks()
Indicates if polygons should be split at break values. |
void |
setDefaultBreaks(IDoubleArray value)
The default break(s) of the traversal. |
void |
setExcludeSourcesFromPolygons(IStringArray networkSourceNames)
A collection of network source names to NOT use when generating polygons. |
void |
setMergeSimilarPolygonRanges(boolean value)
Indicates if similar ranges should be merged in the result polygons. |
void |
setOutputLines(int value)
The type of line(s) generated. |
void |
setOutputPolygons(int value)
The type of polygon(s) generated. |
void |
setOverlapLines(boolean value)
Indicates if lines should overlap from multiple facilities. |
void |
setSplitLinesAtBreaks(boolean value)
Indicates if lines should be split at breaks. |
void |
setSplitPolygonsAtBreaks(boolean value)
Indicates if polygons should be split at break values. |
void |
setTravelDirection(int value)
The direction of the traversal. |
| Method Detail |
|---|
int getTravelDirection()
throws IOException,
AutomationException
TravelDirection specifies if it is traveling from the facility (default) or traveling to the facility.
This can make a difference in the computed service area if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setTravelDirection(int value)
throws IOException,
AutomationException
TravelDirection specifies if it is traveling from the facility (default) or traveling to the facility.
This can make a difference in the computed service area if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network.
value - A com.esri.arcgis.networkanalyst.esriNATravelDirection constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IDoubleArray getDefaultBreaks()
throws IOException,
AutomationException
DefaultBreaks specifies how many rings to compute around each facility.
The breaks are specified as a double array of numbers like 2.0, 4.0, 6.0. This will result in three polygons around the facility at 2.0, 4.0 and 6.0 cumulative attribute value units from each facility.
DefaultBreaks is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the Breaks_<attribute name> field of an individual feature.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setDefaultBreaks(IDoubleArray value)
throws IOException,
AutomationException
DefaultBreaks specifies how many rings to compute around each facility.
The breaks are specified as a double array of numbers like 2.0, 4.0, 6.0. This will result in three polygons around the facility at 2.0, 4.0 and 6.0 cumulative attribute value units from each facility.
DefaultBreaks is considered “default” because it can be overridden on a feature-by-feature basis by the presence of a non-null value in the Breaks_<attribute name> field of an individual feature.
value - A reference to a com.esri.arcgis.system.IDoubleArray (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isSplitPolygonsAtBreaks()
throws IOException,
AutomationException
SplitPolygonsAtBreaks specifies to the solver 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).
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setSplitPolygonsAtBreaks(boolean value)
throws IOException,
AutomationException
SplitPolygonsAtBreaks specifies to the solver if the service area polygons will be split at the specified breaks. If they are not split then 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).
value - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isOverlapLines()
throws IOException,
AutomationException
OverlapLines specifies if the service area lines of two or more facilities will overlap and return coincident features.
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.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setOverlapLines(boolean value)
throws IOException,
AutomationException
OverlapLines specifies if the service area lines of two or more facilities will overlap and return coincident features.
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.
value - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IStringArray getExcludeSourcesFromPolygons()
throws IOException,
AutomationException
ExcludeSourcesFromPolygons specifies if certain network sources should be excluded 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.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setExcludeSourcesFromPolygons(IStringArray networkSourceNames)
throws IOException,
AutomationException
ExcludeSourcesFromPolygons specifies if certain network sources should be excluded 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.
networkSourceNames - A reference to a com.esri.arcgis.system.IStringArray (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isMergeSimilarPolygonRanges()
throws IOException,
AutomationException
MergeSimillarPolygons specifies if polygons with same break values from different facilities should be merged together.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMergeSimilarPolygonRanges(boolean value)
throws IOException,
AutomationException
MergeSimillarPolygons specifies if polygons with same break values from different facilities should be merged together.
value - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isSplitLinesAtBreaks()
throws IOException,
AutomationException
SplitLinesAtBreaks specifies if the service area lines will be split at the break values.
A service area with a set of break values like 2.0, 4.0, 6.0 will normally only return each edge in the input network with its from and to cumulative cost attribute. If this property is set to true, service area lines are also split at the location where the actual value of the break is reached.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setSplitLinesAtBreaks(boolean value)
throws IOException,
AutomationException
SplitLinesAtBreaks specifies if the service area lines will be split at the break values.
A service area with a set of break values like 2.0, 4.0, 6.0 will normally only return each edge in the input network with its from and to cumulative cost attribute. If this property is set to true, service area lines are also split at the location where the actual value of the break is reached.
value - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getOutputPolygons()
throws IOException,
AutomationException
OutputPolygons specifies if the service area polygons should be generated or not.
If they are to be generated, it specifies 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.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setOutputPolygons(int value)
throws IOException,
AutomationException
OutputPolygons specifies if the service area polygons should be generated or not.
If they are to be generated it specifies 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.
value - A com.esri.arcgis.networkanalyst.esriNAOutputPolygonType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getOutputLines()
throws IOException,
AutomationException
OutputLines specifies the type of lines to be generated by the service area solver. The choice is to the generate the lines with or without measures or to generate no lines.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setOutputLines(int value)
throws IOException,
AutomationException
OutputLines specifies the type of lines to be generated by the service area solver. The choice is to the generate the lines with or without measures or to generate no lines.
value - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||