com.esri.arcgis.geodatabase
Interface INetworkForwardStarSetup

All Superinterfaces:

Serializable

All Known Implementing Classes:

INetworkForwardStarSetupProxy, NetworkForwardStar

public interface INetworkForwardStarSetup
extends Serializable

Provides access to members that specify the configuration for this NetworkForwardStar object.

Remarks

This interface has been superceded by INetworkForwardStarEx. Please refer to that interface for usage instructions.

Product Availability

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

Method Summary

void	addCachedAttribute(INetworkAttribute attribute) AddCachedAttribute has been deprecated and should not be called.
void	addRestriction(INetworkAttribute attribute) Adds a restriction network attribute to the NetworkForwardStar object to filter elements returned.
int	getBacktrack() Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.
INetworkAttribute	getHierarchyAttribute() Network attribute containing the hierarchy values for each network element.
int	getMaxHierarchyValue() Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.
INetworkDataset	getNetworkDataset() Network dataset on which the NetworkForwardStar object is querying.
IEnumNetworkElement	getNonTraversableElements(int elementType, int direction) The collection of network elements of the given type that are set to not traversable.
INetworkAttribute	getRestriction(int index) Restriction network attribute by index applied to the NetworkForwardStar object.
int	getRestrictionCount() Number of restriction network attributes applied to the NetworkForwardStar object.
boolean	isForwardTraversal() Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.
boolean	isTraversable(INetworkElement element) Indicates if the given network element is travserable by the NetworkForwardStar object.
void	removeAllCachedAttributes() RemoveAllCachedAttributes has been deprecated and should not be called.
void	removeRestriction(int index) Removes the given restriction network attribute by index from the NetworkForwardStar object.
void	setAllTraversable(int elementType, boolean traversable) Sets all network elements of the given element type to be traversable or non-traversable.
void	setBacktrack(int backtrack) Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.
void	setHierarchyAttributeByRef(INetworkAttribute attribute) Network attribute containing the hierarchy values for each network element.
void	setIsForwardTraversal(boolean isForwardTraversal) Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.
void	setMaxHierarchyValue(int maxValue) Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.
void	setTraversable(INetworkElement element, boolean traversable) Indicates if the given network element is travserable by the NetworkForwardStar object.
void	setTraversable2(IEnumNetworkElement elements, boolean traversable) Sets the given network elements to be traversable or non-traversable.

Method Detail

getBacktrack

int getBacktrack()
                 throws IOException,
                        AutomationException

Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.

Remarks

This property has been superceded by the BacktrackPolicy property on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBacktrack

void setBacktrack(int backtrack)
                  throws IOException,
                         AutomationException

Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.

Product Availability

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

Parameters:

backtrack - A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isForwardTraversal

boolean isForwardTraversal()
                           throws IOException,
                                  AutomationException

Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.

Remarks

This property has been superceded by the IsForwardTraversal property on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Returns:

The isForwardTraversal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsForwardTraversal

void setIsForwardTraversal(boolean isForwardTraversal)
                           throws IOException,
                                  AutomationException

Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.

Product Availability

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

Parameters:

isForwardTraversal - The isForwardTraversal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkDataset

INetworkDataset getNetworkDataset()
                                  throws IOException,
                                         AutomationException

Network dataset on which the NetworkForwardStar object is querying.

Remarks

This property has been superceded by the NetworkDataset property on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.INetworkDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addCachedAttribute

void addCachedAttribute(INetworkAttribute attribute)
                        throws IOException,
                               AutomationException

AddCachedAttribute has been deprecated and should not be called.

Remarks

This method has been deprecated.

Product Availability

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

Parameters:

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllCachedAttributes

void removeAllCachedAttributes()
                               throws IOException,
                                      AutomationException

RemoveAllCachedAttributes has been deprecated and should not be called.

Remarks

This method has been deprecated.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRestriction

void addRestriction(INetworkAttribute attribute)
                    throws IOException,
                           AutomationException

Adds a restriction network attribute to the NetworkForwardStar object to filter elements returned.

Remarks

This method has been superceded by the AddRestrictionAttribute method on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Parameters:

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestriction

INetworkAttribute getRestriction(int index)
                                 throws IOException,
                                        AutomationException

Restriction network attribute by index applied to the NetworkForwardStar object.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.INetworkAttribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestrictionCount

int getRestrictionCount()
                        throws IOException,
                               AutomationException

Number of restriction network attributes applied to the NetworkForwardStar object.

Remarks

This property has been superceded by the RestrictionAttributeCount property on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeRestriction

void removeRestriction(int index)
                       throws IOException,
                              AutomationException

Removes the given restriction network attribute by index from the NetworkForwardStar object.

Remarks

This property has been superceded by the RemoveRestrictionAttributes method on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHierarchyAttributeByRef

void setHierarchyAttributeByRef(INetworkAttribute attribute)
                                throws IOException,
                                       AutomationException

Network attribute containing the hierarchy values for each network element.

Product Availability

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

Parameters:

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHierarchyAttribute

INetworkAttribute getHierarchyAttribute()
                                        throws IOException,
                                               AutomationException

Network attribute containing the hierarchy values for each network element.

Remarks

This property has been superceded by the HierarchyAttribute property on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.INetworkAttribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxHierarchyValue

void setMaxHierarchyValue(int maxValue)
                          throws IOException,
                                 AutomationException

Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.

Product Availability

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

Parameters:

maxValue - The maxValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxHierarchyValue

int getMaxHierarchyValue()
                         throws IOException,
                                AutomationException

Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.

Remarks

This property has been superceded by the MaxTraversableHierarchyValue property on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Returns:

The maxValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTraversable

boolean isTraversable(INetworkElement element)
                      throws IOException,
                             AutomationException

Indicates if the given network element is travserable by the NetworkForwardStar object.

Product Availability

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

Parameters:

element - A reference to a com.esri.arcgis.geodatabase.INetworkElement (in)

Returns:

The traversable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTraversable

void setTraversable(INetworkElement element,
                    boolean traversable)
                    throws IOException,
                           AutomationException

Indicates if the given network element is travserable by the NetworkForwardStar object.

Remarks

The SetTraversable method with a Traversable parameter value of True sets all network elements in the given enumeration as Traversable.

The SetTraversable method with a Traversable parameter value of False sets all network elements in the given enumeration as not Traversable.

Product Availability

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

Parameters:

element - A reference to a com.esri.arcgis.geodatabase.INetworkElement (in)

traversable - The traversable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTraversable2

void setTraversable2(IEnumNetworkElement elements,
                     boolean traversable)
                     throws IOException,
                            AutomationException

Sets the given network elements to be traversable or non-traversable.

Product Availability

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

Parameters:

elements - A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement (in)

traversable - The traversable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllTraversable

void setAllTraversable(int elementType,
                       boolean traversable)
                       throws IOException,
                              AutomationException

Sets all network elements of the given element type to be traversable or non-traversable.

Remarks

This property has been superceded by the RemoveElementRestrictions property on the INetworkForwardStarEx interface. Please refer to that interface for usage instructions.

Product Availability

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

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

traversable - The traversable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNonTraversableElements

IEnumNetworkElement getNonTraversableElements(int elementType,
                                              int direction)
                                              throws IOException,
                                                     AutomationException

The collection of network elements of the given type that are set to not traversable.

Product Availability

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

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.