INetworkForwardStarEx.QueryAdjacencies Method

Finds all network elements that are adjacent to the given sequence of network elements.

[Visual Basic .NET]
Public Sub QueryAdjacencies ( _
    ByVal atJunction As INetworkJunction, _
    ByVal fromEdge As INetworkEdge, _
    ByVal lastExteriorEdge As INetworkEdge, _
    ByVal adjacencies As INetworkForwardStarAdjacencies _
)

[C#]
public void QueryAdjacencies (
    INetworkJunction atJunction,
    INetworkEdge fromEdge,
    INetworkEdge lastExteriorEdge,
    INetworkForwardStarAdjacencies adjacencies
);

[C++]
HRESULT QueryAdjacencies(
  INetworkJunction* atJunction,
  INetworkEdge* fromEdge,
  INetworkEdge* lastExteriorEdge,
  INetworkForwardStarAdjacencies* adjacencies
);

[C++]
Parameters
atJunction [in]

  atJunction is a parameter of type INetworkJunction*
fromEdge [in]

  fromEdge is a parameter of type INetworkEdge*
lastExteriorEdge [in]

  lastExteriorEdge is a parameter of type INetworkEdge*
adjacencies [in]

  adjacencies is a parameter of type INetworkForwardStarAdjacencies*

Product Availability

Remarks

QueryAdjacencies is the primary method for use in network dataset traversal. Using this method, the elements adjacent to the provided atJunction may be filtered based on hierarchy attributes, restriction attributes, BacktrackPolicy and other NetworkForwardStar settings. Any unfiltered elements will be returned in the NetworkForwardStarAdjacencies object. The NetworkForwardStarAdjacencies component is essentially a cursor object used to retrieve the element information relevant to a particular query for adjacency information from the NetworkForwardStar .

QueryAdjacencies requires an instantiated NetworkForwardStarAdjacencies object to return the adjacent elements found when calling QueryAdjacencies. The NetworkForwardStarAdjacencies object is created using the INetworkQuery::CreateForwardStarAdjacencies method. The NetworkForwardStarAdjacencies object should be reused in subsequent calls to QueryAdjacencies .

For standard patterns of queries to the NetworkForwardStar object, the QueryAdjacencies method will inform the related input NetworkForwardStarAdjacencies object of any additional element-specific dynamic restrictions and/or element-specific dynamic attribute adjustments to associate with the adjacent elements.

The fromEdge in an optional parameter that specifies the edge from which the atJunction was approached. This is useful in filtering results based on BacktrackPolicy and network turns.

The lastExteriorEdge is an optional parameter used to determine from where this particular network traversal maneuver began. This is useful in filtering for multi-part turns.

See Also