Provides access to members that specify the adjacent network elements returned by the NetworkForwardStar object.
Members
| Name | Description | |
|---|---|---|
 |
Count | Number of adjacent edges returned by the NetworkForwardStar object. |
|
HasTurn | Indicates if the adjacent edge at the specified index has a turn. |
|
HasTurnRestriction | Indicates if any of the adjacent edges are restricted due to a turn restriction. |
 |
QueryAtJunction | Queries the junction element used as the atJunction in the NetworkForwardStar object. |
|
QueryEdge | Queries the adjacent edge element at the specified index. |
|
QueryToJunction | For the adjacent edge element at the specified index, queries the junction element opposite of the atJunction. |
|
QueryTurn | Queries the turn element that passes through the fromEdge, the atJunction, and the adjacent edge at the specified index. |
INetworkForwardStarAdjacencies.Count Property
Number of adjacent edges returned by the NetworkForwardStar object.
Public ReadOnly Property Count As Integer
public int Count {get;}
Remarks
The Count is the number of adjacent edge elements returned by INetworkForwardStar::QueryAdjacencies. Use this value to iterate over the adjacent elements.
INetworkForwardStarAdjacencies.HasTurn Property
Indicates if the adjacent edge at the specified index has a turn.
Public Function get_HasTurn ( _
ByVal Index As Integer _
) As Boolean
public bool get_HasTurn (
int Index
);
Remarks
The NetworkForwardStarAdjacencies object holds the adjacent network elements that were queried by calling the INetworkForwardStar.QueryAdjacencies method.
The HasTurn property determines whether or not the QueryTurn method will return a turn element. If HasTurn = True for some index value, then the adjacent edge returned by QueryEdge for that same index value is the last edge of a turn. This turn may be retrieved using QueryTurn for that index value.
INetworkForwardStarAdjacencies.HasTurnRestriction Property
Indicates if any of the adjacent edges are restricted due to a turn restriction.
Public ReadOnly Property HasTurnRestriction As Boolean
public bool HasTurnRestriction {get;}
Remarks
The NetworkForwardStarAdjacenciesobject holds the adjacent network elements that were queried by calling the INetworkForwardStar.QueryAdjacencies method.
The HasTurnRestriction property indicates if any of the edges adjacent to the atJunction have not been included in the NetworkForwardStarAdjacencies object due to a turn restriction.
INetworkForwardStarAdjacencies.QueryAtJunction Method
Queries the junction element used as the atJunction in the NetworkForwardStar object.
Public Sub QueryAtJunction ( _
ByVal Junction As INetworkJunction _
)
public void QueryAtJunction (
INetworkJunction Junction
);
Remarks
The QueryAtJunction method retrieves the junction element used by the INetworkForwardStar::QueryAdjacencies method.
The QueryAtJunction method requires an instantiated NetworkJunction object to be passed in as a parameter. You can create an empty NetworkJunction object by using the INetworkQuery::CreateNetworkElement method.
INetworkForwardStarAdjacencies.QueryEdge Method
Queries the adjacent edge element at the specified index.
Public Sub QueryEdge ( _
ByVal Index As Integer, _
ByVal adjacentEdge As INetworkEdge, _
ByRef fromPosition As Double, _
ByRef toPosition As Double _
)
public void QueryEdge (
int Index,
INetworkEdge adjacentEdge,
ref double fromPosition,
ref double toPosition
);
Remarks
The QueryEdge method returns the edge element that is adjacent to the atJunction at the specified index.
The index values range from 0 to (- 1).
The QueryEdge method requires an instantiatedobject to be passed in as a parameter. You can create an empty NetworkEdge object by using themethod.
The fromPosition and toPosition parameters indicate the range of accessible positions (starting from the atJunction) along the network edge element that was queried. The position values can range from 0.0 to 1.0, where 0.0 is at the starting end of the edge element and 1.0 is at the terminating end of the edge element. The fromPosition value will always be less than or equal to the toPosition value, regardless of theproperty of the edge element. In most cases, the entire edge element will be accessible, so the fromPosition parameter will be returned as 0.0 and the toPosition parameter will be returned as 1.0.
In the case when only a portion of the edge element is accessible, this means the edge has been partially restricted by a call to the INetworkForwardStar.AddEdgeRestriction method.
INetworkForwardStarAdjacencies.QueryToJunction Method
For the adjacent edge element at the specified index, queries the junction element opposite of the atJunction.
Public Sub QueryToJunction ( _
ByVal Index As Integer, _
ByVal adjacentJunction As INetworkJunction, _
ByRef IsFiltered As Boolean _
)
public void QueryToJunction (
int Index,
INetworkJunction adjacentJunction,
ref bool IsFiltered
);
Remarks
The QueryToJunction method returns the junction element that is opposite the atJunction via the QueryEdge edge element at the specified index.
The index values range from 0 to (Count - 1).
The QueryToJunction method requires an instantiated NetworkJunction object to be passed in as a parameter. You can create an empty NetworkJunction object by using the INetworkQuery::CreateNetworkElement method.
INetworkForwardStarAdjacencies.QueryTurn Method
Queries the turn element that passes through the fromEdge, the atJunction, and the adjacent edge at the specified index.
Public Sub QueryTurn ( _
ByVal Index As Integer, _
ByVal adjacentTurn As INetworkTurn _
)
public void QueryTurn (
int Index,
INetworkTurn adjacentTurn
);
Remarks
The QueryTurn method returns the turn element that traverses from the fromEdge through the atJunction to the QueryEdge edge element at the specified index. The QueryTurn method does not always return a turn element -- to determine if a turn element will be returned, call the HasTurn property using the same index value.
The index values range from 0 to (Count - 1).
The QueryTurn method requires an instantiated NetworkTurn object to be passed in as a parameter. You can create an empty NetworkTurn object by using the INetworkQuery::CreateNetworkElement method.
Classes that implement INetworkForwardStarAdjacencies
| Classes | Description |
|---|
Remarks
Use the INetworkForwardStarAdjacencies interface to query network elements returned by the INetworkForwardStar::QueryAdjacencies method.
The NetworkForwardStarAdjacencies object is created by calling the INetworkQuery::CreateForwardStarAdjacencies method.