com.esri.arcgis.geodatabase

Interface INetworkForwardStarSetup

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

INetworkForwardStarSetupProxy

public interface INetworkForwardStarSetup
extends java.io.Serializable

COM Interface 'INetworkForwardStarSetup'. Generated 9/24/2024 11:01:30 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that specify the configuration for this NetworkForwardStar object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDd68a2a0c_f2b9_47af_8ae6_811513349546
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.

Field Detail

IIDd68a2a0c_f2b9_47af_8ae6_811513349546

static final int IIDd68a2a0c_f2b9_47af_8ae6_811513349546

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getBacktrack

int getBacktrack()
          throws java.io.IOException,
                 AutomationException

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBacktrack

void setBacktrack(int backtrack)
           throws java.io.IOException,
                  AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isForwardTraversal

boolean isForwardTraversal()
                    throws java.io.IOException,
                           AutomationException

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

Returns:

The isForwardTraversal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsForwardTraversal

void setIsForwardTraversal(boolean isForwardTraversal)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

isForwardTraversal - The isForwardTraversal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkDataset

INetworkDataset getNetworkDataset()
                           throws java.io.IOException,
                                  AutomationException

Network dataset on which the NetworkForwardStar object is querying.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addCachedAttribute

void addCachedAttribute(INetworkAttribute attribute)
                 throws java.io.IOException,
                        AutomationException

AddCachedAttribute has been deprecated and should not be called.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllCachedAttributes

void removeAllCachedAttributes()
                        throws java.io.IOException,
                               AutomationException

RemoveAllCachedAttributes has been deprecated and should not be called.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRestriction

void addRestriction(INetworkAttribute attribute)
             throws java.io.IOException,
                    AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestriction

INetworkAttribute getRestriction(int index)
                          throws java.io.IOException,
                                 AutomationException

Restriction network attribute by index applied to the NetworkForwardStar object.

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestrictionCount

int getRestrictionCount()
                 throws java.io.IOException,
                        AutomationException

Number of restriction network attributes applied to the NetworkForwardStar object.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeRestriction

void removeRestriction(int index)
                throws java.io.IOException,
                       AutomationException

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

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHierarchyAttributeByRef

void setHierarchyAttributeByRef(INetworkAttribute attribute)
                         throws java.io.IOException,
                                AutomationException

Network attribute containing the hierarchy values for each network element.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHierarchyAttribute

INetworkAttribute getHierarchyAttribute()
                                 throws java.io.IOException,
                                        AutomationException

Network attribute containing the hierarchy values for each network element.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxHierarchyValue

void setMaxHierarchyValue(int maxValue)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

maxValue - The maxValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxHierarchyValue

int getMaxHierarchyValue()
                  throws java.io.IOException,
                         AutomationException

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

Returns:

The maxValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTraversable

boolean isTraversable(INetworkElement element)
               throws java.io.IOException,
                      AutomationException

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

Parameters:

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

Returns:

The traversable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTraversable

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

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

Parameters:

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

traversable - The traversable (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTraversable2

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

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

Parameters:

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

traversable - The traversable (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllTraversable

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

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

Parameters:

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

traversable - The traversable (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNonTraversableElements

IEnumNetworkElement getNonTraversableElements(int elementType,
                                              int direction)
                                       throws java.io.IOException,
                                              AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.