com.esri.arcgis.networkanalyst
Interface INAStopRenderer

All Superinterfaces:

Serializable

All Known Subinterfaces:

INAStopRenderer2

All Known Implementing Classes:

NAStopRenderer

public interface INAStopRenderer
extends Serializable

Provides access to symbols used to display stops.

Superseded By

INAStopRenderer2

Remarks

INAStopRenderer has been superseded by INAStopRenderer2.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IMarkerSymbol	getErrorSymbol() The symbol used for a stop that has an error.
IMarkerSymbol	getStopSymbol() The symbol used for a located stop.
ITextSymbol	getTextSymbol() The text symbol used for a stop.
IMarkerSymbol	getTimeViolationSymbol() The symbol used for a stop that has a time window violation.
IMarkerSymbol	getUnlocatedSymbol() The symbol used for a stop that could not be found on the network.
void	setErrorSymbol(IMarkerSymbol symbol) The symbol used for a stop that has an error.
void	setStopSymbol(IMarkerSymbol symbol) The symbol used for a located stop.
void	setTextSymbol(ITextSymbol symbol) The text symbol used for a stop.
void	setTimeViolationSymbol(IMarkerSymbol symbol) The symbol used for a stop that has a time window violation.
void	setUnlocatedSymbol(IMarkerSymbol symbol) The symbol used for a stop that could not be found on the network.

Method Detail

getStopSymbol

IMarkerSymbol getStopSymbol()
                            throws IOException,
                                   AutomationException

The symbol used for a located stop.

Remarks

The StopSymbol specifies the marker symbol to use for drawing ordinary stops with no error status.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopSymbol

void setStopSymbol(IMarkerSymbol symbol)
                   throws IOException,
                          AutomationException

The symbol used for a located stop.

Remarks

The StopSymbol specifies the marker symbol to use for drawing ordinary stops with no error status.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnlocatedSymbol

IMarkerSymbol getUnlocatedSymbol()
                                 throws IOException,
                                        AutomationException

The symbol used for a stop that could not be found on the network.

Remarks

The UnlocatedSymbol specifies the marker symbol to use for drawing unlocated stops.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnlocatedSymbol

void setUnlocatedSymbol(IMarkerSymbol symbol)
                        throws IOException,
                               AutomationException

The symbol used for a stop that could not be found on the network.

Remarks

The UnlocatedSymbol specifies the marker symbol to use for drawing unlocated stops.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorSymbol

IMarkerSymbol getErrorSymbol()
                             throws IOException,
                                    AutomationException

The symbol used for a stop that has an error.

Remarks

The ErrorSymbol specifies the marker symbol to use for drawing stops with one or more errors determined during solve.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorSymbol

void setErrorSymbol(IMarkerSymbol symbol)
                    throws IOException,
                           AutomationException

The symbol used for a stop that has an error.

Remarks

The ErrorSymbol specifies the marker symbol to use for drawing stops with one or more errors determined during solve.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeViolationSymbol

IMarkerSymbol getTimeViolationSymbol()
                                     throws IOException,
                                            AutomationException

The symbol used for a stop that has a time window violation.

Remarks

The TimeViolationSymbol specifies the marker symbol to use for drawing stops with time window violations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeViolationSymbol

void setTimeViolationSymbol(IMarkerSymbol symbol)
                            throws IOException,
                                   AutomationException

The symbol used for a stop that has a time window violation.

Remarks

The TimeViolationSymbol specifies the marker symbol to use for drawing stops with time window violations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

The text symbol used for a stop.

Remarks

The TextSymbol property specifies the text symbol that is drawn on top of the ErrorSymbol, StopSymbol, TimeWindowViolationSymbol, and UnlocatedSymbol. The text used for each stop is the value in the Sequence field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbol

void setTextSymbol(ITextSymbol symbol)
                   throws IOException,
                          AutomationException

The text symbol used for a stop.

Remarks

The TextSymbol property specifies the text symbol that is drawn on top of the ErrorSymbol, StopSymbol, TimeWindowViolationSymbol, and UnlocatedSymbol. The text used for each stop is the value in the Sequence field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.