Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Interface INetworkForwardStarEx

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
INetworkForwardStarExProxy, NetworkForwardStar
public interface INetworkForwardStarEx
extends java.io.Serializable

COM Interface 'INetworkForwardStarEx'. Generated 3/19/2015 1:20:57 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that specify the configuration for this NetworkForwardStar object and query information about adjacent elements in the network dataset.' 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
static java.lang.String IID
          Deprecated. Internal use only
static int IID25c310eb_bff3_4a47_a694_3f17e16fbfda
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addEdgeRestriction(INetworkEdge edge, double fromPosition, double toPosition)
          Restricts the traversability of a range on an edge element in the adjacency queries.
 void addJunctionRestriction(INetworkJunction junction)
          Restricts a junction element from being returned in the adjacency queries.
 void addRestrictionAttribute(INetworkAttribute attribute)
          Adds a restriction network attribute to the NetworkForwardStar object to filter elements from adjacency queries.
 void addTurnRestriction(INetworkTurn turn)
          Restricts a turn in the adjacency queries.
 void adjustEdgeAttributeValue(INetworkEdge edge, double fromPosition, double toPosition, INetworkAttribute attribute, int adjustmentType, java.lang.Object value)
          Adjusts the value of a network attribute for a range on an edge element.
 void adjustJunctionAttributeValue(INetworkJunction junction, INetworkAttribute attribute, int adjustmentType, java.lang.Object value)
          Adjusts the value of a network attribute for a junction element.
 void adjustTurnAttributeValue(INetworkTurn turn, INetworkAttribute attribute, int adjustmentType, java.lang.Object value)
          Adjusts the value of a network attribute for a turn element.
 int getBacktrackPolicy()
          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 getMaxTraversableHierarchyValue()
          Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.
 INetworkDataset getNetworkDataset()
          Network dataset on which the NetworkForwardStar object is querying.
 INetworkAttribute getRestrictionAttribute(int index)
          Restriction network attribute by index in the NetworkForwardStar object.
 int getRestrictionAttributeCount()
          Number of restriction network attributes currently applied to the NetworkForwardStar object.
 boolean isForwardTraversal()
          Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.
 boolean isRestricted(INetworkElement element)
          Indicates if the given network element is restricted from traversal in the NetworkForwardStar object.
 void queryAdjacencies(INetworkJunction atJunction, INetworkEdge fromEdge, INetworkEdge lastExteriorEdge, INetworkForwardStarAdjacencies adjacencies)
          Finds all network elements that are adjacent to the given sequence of network elements.
 void queryAttributeCutoffRange(INetworkEdge edge, INetworkAttribute attribute, double queryPosition, java.lang.Object cutoffValue, double[] fromPosition, double[] toPosition)
          Returns the range of accessible positions within a specified attribute cutoff from a query position along an edge element, respective to any existing attribute adjustments along the edge.
 void queryEdge(int eID, int direction, INetworkEdge edge)
          Performs a network edge element query by element ID and edge direction and populates the given edge element object.
 void queryJunction(int eID, INetworkJunction junction)
          Performs a network junction element query by element ID and populates the given junction element object.
 void queryTraversableRange(INetworkEdge edge, double queryPosition, double[] fromPosition, double[] toPosition, boolean[] isFromPositionAccessible, boolean[] isToPositionAccessible)
          Returns the range of accessible positions from a query position along an edge element, respective to any existing restrictions along the edge.
 void queryTurn(int eID, INetworkTurn turn)
          Performs a network turn element query by element ID and populates the given turn element object.
 void removeAttributeValueAdjustments()
          Removes all element-specific attribute value adjustments currently applied to the NetworkForwardStar object.
 void removeElementRestrictions()
          Removes all element-specific restrictions currently applied to the NetworkForwardStar object.
 void removeRestrictionAttributes()
          Removes all restriction network attributes currently applied to the NetworkForwardStar object.
 void setBacktrackPolicy(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 setMaxTraversableHierarchyValue(int maxValue)
          Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.
 

Field Detail

IID25c310eb_bff3_4a47_a694_3f17e16fbfda

static final int IID25c310eb_bff3_4a47_a694_3f17e16fbfda
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

queryAdjacencies

void queryAdjacencies(INetworkJunction atJunction,
                      INetworkEdge fromEdge,
                      INetworkEdge lastExteriorEdge,
                      INetworkForwardStarAdjacencies adjacencies)
                      throws java.io.IOException,
                             AutomationException
Finds all network elements that are adjacent to the given sequence of network elements.

Parameters:
atJunction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)
fromEdge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
lastExteriorEdge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
adjacencies - A reference to a com.esri.arcgis.geodatabase.INetworkForwardStarAdjacencies (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryJunction

void queryJunction(int eID,
                   INetworkJunction junction)
                   throws java.io.IOException,
                          AutomationException
Performs a network junction element query by element ID and populates the given junction element object.

Parameters:
eID - The eID (in)
junction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryEdge

void queryEdge(int eID,
               int direction,
               INetworkEdge edge)
               throws java.io.IOException,
                      AutomationException
Performs a network edge element query by element ID and edge direction and populates the given edge element object.

Parameters:
eID - The eID (in)
direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (in)
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTurn

void queryTurn(int eID,
               INetworkTurn turn)
               throws java.io.IOException,
                      AutomationException
Performs a network turn element query by element ID and populates the given turn element object.

Parameters:
eID - The eID (in)
turn - A reference to a com.esri.arcgis.geodatabase.INetworkTurn (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTraversableRange

void queryTraversableRange(INetworkEdge edge,
                           double queryPosition,
                           double[] fromPosition,
                           double[] toPosition,
                           boolean[] isFromPositionAccessible,
                           boolean[] isToPositionAccessible)
                           throws java.io.IOException,
                                  AutomationException
Returns the range of accessible positions from a query position along an edge element, respective to any existing restrictions along the edge.

Parameters:
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
queryPosition - The queryPosition (in)
fromPosition - The fromPosition (out: use single element array)
toPosition - The toPosition (out: use single element array)
isFromPositionAccessible - The isFromPositionAccessible (out: use single element array)
isToPositionAccessible - The isToPositionAccessible (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryAttributeCutoffRange

void queryAttributeCutoffRange(INetworkEdge edge,
                               INetworkAttribute attribute,
                               double queryPosition,
                               java.lang.Object cutoffValue,
                               double[] fromPosition,
                               double[] toPosition)
                               throws java.io.IOException,
                                      AutomationException
Returns the range of accessible positions within a specified attribute cutoff from a query position along an edge element, respective to any existing attribute adjustments along the edge.

Parameters:
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)
queryPosition - The queryPosition (in)
cutoffValue - A Variant (in)
fromPosition - The fromPosition (out: use single element array)
toPosition - The toPosition (out: use single element array)
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.

getBacktrackPolicy

int getBacktrackPolicy()
                       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.

setBacktrackPolicy

void setBacktrackPolicy(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.

addRestrictionAttribute

void addRestrictionAttribute(INetworkAttribute attribute)
                             throws java.io.IOException,
                                    AutomationException
Adds a restriction network attribute to the NetworkForwardStar object to filter elements from adjacency queries.

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.

getRestrictionAttribute

INetworkAttribute getRestrictionAttribute(int index)
                                          throws java.io.IOException,
                                                 AutomationException
Restriction network attribute by index in 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.

getRestrictionAttributeCount

int getRestrictionAttributeCount()
                                 throws java.io.IOException,
                                        AutomationException
Number of restriction network attributes currently 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.

removeRestrictionAttributes

void removeRestrictionAttributes()
                                 throws java.io.IOException,
                                        AutomationException
Removes all restriction network attributes currently applied to the NetworkForwardStar object.

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.

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.

getMaxTraversableHierarchyValue

int getMaxTraversableHierarchyValue()
                                    throws java.io.IOException,
                                           AutomationException
Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.

Returns:
The maxValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxTraversableHierarchyValue

void setMaxTraversableHierarchyValue(int maxValue)
                                     throws java.io.IOException,
                                            AutomationException
Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.

Parameters:
maxValue - The maxValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addJunctionRestriction

void addJunctionRestriction(INetworkJunction junction)
                            throws java.io.IOException,
                                   AutomationException
Restricts a junction element from being returned in the adjacency queries.

Parameters:
junction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addEdgeRestriction

void addEdgeRestriction(INetworkEdge edge,
                        double fromPosition,
                        double toPosition)
                        throws java.io.IOException,
                               AutomationException
Restricts the traversability of a range on an edge element in the adjacency queries.

Parameters:
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
fromPosition - The fromPosition (in)
toPosition - The toPosition (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addTurnRestriction

void addTurnRestriction(INetworkTurn turn)
                        throws java.io.IOException,
                               AutomationException
Restricts a turn in the adjacency queries.

Parameters:
turn - A reference to a com.esri.arcgis.geodatabase.INetworkTurn (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeElementRestrictions

void removeElementRestrictions()
                               throws java.io.IOException,
                                      AutomationException
Removes all element-specific restrictions currently applied to the NetworkForwardStar object.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adjustJunctionAttributeValue

void adjustJunctionAttributeValue(INetworkJunction junction,
                                  INetworkAttribute attribute,
                                  int adjustmentType,
                                  java.lang.Object value)
                                  throws java.io.IOException,
                                         AutomationException
Adjusts the value of a network attribute for a junction element.

Parameters:
junction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)
attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)
adjustmentType - A com.esri.arcgis.geodatabase.esriNetworkAttributeAdjustmentType constant (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adjustEdgeAttributeValue

void adjustEdgeAttributeValue(INetworkEdge edge,
                              double fromPosition,
                              double toPosition,
                              INetworkAttribute attribute,
                              int adjustmentType,
                              java.lang.Object value)
                              throws java.io.IOException,
                                     AutomationException
Adjusts the value of a network attribute for a range on an edge element.

Parameters:
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
fromPosition - The fromPosition (in)
toPosition - The toPosition (in)
attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)
adjustmentType - A com.esri.arcgis.geodatabase.esriNetworkAttributeAdjustmentType constant (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adjustTurnAttributeValue

void adjustTurnAttributeValue(INetworkTurn turn,
                              INetworkAttribute attribute,
                              int adjustmentType,
                              java.lang.Object value)
                              throws java.io.IOException,
                                     AutomationException
Adjusts the value of a network attribute for a turn element.

Parameters:
turn - A reference to a com.esri.arcgis.geodatabase.INetworkTurn (in)
attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)
adjustmentType - A com.esri.arcgis.geodatabase.esriNetworkAttributeAdjustmentType constant (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAttributeValueAdjustments

void removeAttributeValueAdjustments()
                                     throws java.io.IOException,
                                            AutomationException
Removes all element-specific attribute value adjustments currently applied to the NetworkForwardStar object.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRestricted

boolean isRestricted(INetworkElement element)
                     throws java.io.IOException,
                            AutomationException
Indicates if the given network element is restricted from traversal in the NetworkForwardStar object.

Parameters:
element - A reference to a com.esri.arcgis.geodatabase.INetworkElement (in)
Returns:
The isRestricted
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD