INetworkForwardStar Interface

Provides access to members that query information about adjacent elements in the network dataset.

Members

Name Description
Method AddEdgeRestriction Restricts the traversability of a range on an edge element in the adjacency queries.
Method AddJunctionRestriction Restricts a junction element from being returned in the adjacency queries.
Method AddRestrictionAttribute Adds a restriction network attribute to the NetworkForwardStar object to filter elements from adjacency queries.
Method AddTurnRestriction Restricts a turn in the adjacency queries.
Method AdjustEdgeAttributeValue Adjusts the value of a network attribute for a range on an edge element.
Method AdjustJunctionAttributeValue Adjusts the value of a network attribute for a junction element.
Method AdjustTurnAttributeValue Adjusts the value of a network attribute for a turn element.
Read/write property BacktrackPolicy Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.
Read/write property HierarchyAttribute Network attribute containing the hierarchy values for each network element.
Read-only property IsFiltered Indicates if the given network element is filtered out from the adjacencies object.
Read/write property IsForwardTraversal Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.
Read-only property IsRestricted Indicates if the given network element is restricted from traversal in the NetworkForwardStar object.
Read/write property MaxTraversableHierarchyValue Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.
Read-only property NetworkDataset Network dataset on which the NetworkForwardStar object is querying.
Method QueryAdjacencies Finds all network elements that are adjacent to the given sequence of network elements.
Method QueryAttributeCutoffRange 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.
Method QueryEdge Performs a network edge element query by element ID and edge direction and populates the given edge element object.
Method QueryJunction Performs a network junction element query by element ID and populates the given junction element object.
Method QueryTraversableRange Returns the range of accessible positions from a query position along an edge element, respective to any existing restrictions along the edge.
Method QueryTurn Performs a network turn element query by element ID and populates the given turn element object.
Method RemoveAttributeValueAdjustments Removes all element-specific attribute value adjustments currently applied to the NetworkForwardStar object.
Method RemoveElementRestrictions Removes all element-specific restrictions currently applied to the NetworkForwardStar object.
Method RemoveRestrictionAttributes Removes all restriction network attributes currently applied to the NetworkForwardStar object.
Read-only property RestrictionAttribute Restriction network attribute by index in the NetworkForwardStar object.
Read-only property RestrictionAttributeCount Number of restriction network attributes currently applied to the NetworkForwardStar object.

INetworkForwardStar.AddEdgeRestriction Method

Restricts the traversability of a range on an edge element in the adjacency queries.

Public Sub AddEdgeRestriction ( _
    ByVal Edge As INetworkEdge, _
    ByVal fromPosition As Double, _
    ByVal toPosition As Double _
)
public void AddEdgeRestriction (
    INetworkEdge Edge,
    double fromPosition,
    double toPosition
);

INetworkForwardStar.AddJunctionRestriction Method

Restricts a junction element from being returned in the adjacency queries.

Public Sub AddJunctionRestriction ( _
    ByVal Junction As INetworkJunction _
)
public void AddJunctionRestriction (
    INetworkJunction Junction
);

INetworkForwardStar.AddRestrictionAttribute Method

Adds a restriction network attribute to the NetworkForwardStar object to filter elements from adjacency queries.

Public Sub AddRestrictionAttribute ( _
    ByVal Attribute As INetworkAttribute _
)
public void AddRestrictionAttribute (
    INetworkAttribute Attribute
);

INetworkForwardStar.AddTurnRestriction Method

Restricts a turn in the adjacency queries.

Public Sub AddTurnRestriction ( _
    ByVal Turn As INetworkTurn _
)
public void AddTurnRestriction (
    INetworkTurn Turn
);

INetworkForwardStar.AdjustEdgeAttributeValue Method

Adjusts the value of a network attribute for a range on an edge element.

Public Sub AdjustEdgeAttributeValue ( _
    ByVal Edge As INetworkEdge, _
    ByVal fromPosition As Double, _
    ByVal toPosition As Double, _
    ByVal Attribute As INetworkAttribute, _
    ByVal adjustmentType As esriNetworkAttributeAdjustmentType, _
    ByVal Value As Object _
)
public void AdjustEdgeAttributeValue (
    INetworkEdge Edge,
    double fromPosition,
    double toPosition,
    INetworkAttribute Attribute,
    esriNetworkAttributeAdjustmentType adjustmentType,
    object Value
);

INetworkForwardStar.AdjustJunctionAttributeValue Method

Adjusts the value of a network attribute for a junction element.

Public Sub AdjustJunctionAttributeValue ( _
    ByVal Junction As INetworkJunction, _
    ByVal Attribute As INetworkAttribute, _
    ByVal adjustmentType As esriNetworkAttributeAdjustmentType, _
    ByVal Value As Object _
)
public void AdjustJunctionAttributeValue (
    INetworkJunction Junction,
    INetworkAttribute Attribute,
    esriNetworkAttributeAdjustmentType adjustmentType,
    object Value
);

INetworkForwardStar.AdjustTurnAttributeValue Method

Adjusts the value of a network attribute for a turn element.

Public Sub AdjustTurnAttributeValue ( _
    ByVal Turn As INetworkTurn, _
    ByVal Attribute As INetworkAttribute, _
    ByVal adjustmentType As esriNetworkAttributeAdjustmentType, _
    ByVal Value As Object _
)
public void AdjustTurnAttributeValue (
    INetworkTurn Turn,
    INetworkAttribute Attribute,
    esriNetworkAttributeAdjustmentType adjustmentType,
    object Value
);

INetworkForwardStar.BacktrackPolicy Property

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

Public Property BacktrackPolicy As esriNetworkForwardStarBacktrack
public esriNetworkForwardStarBacktrack BacktrackPolicy {get; set;}

INetworkForwardStar.HierarchyAttribute Property

Network attribute containing the hierarchy values for each network element.

Public Property HierarchyAttribute As INetworkAttribute
public INetworkAttribute HierarchyAttribute {get; set;}

INetworkForwardStar.IsFiltered Property

Indicates if the given network element is filtered out from the adjacencies object.

Public Function get_IsFiltered ( _
    ByVal Element As INetworkElement _
) As Boolean
public bool get_IsFiltered (
    INetworkElement Element
);

Remarks

This property has been superceded by the IsRestricted property.

INetworkForwardStar.IsForwardTraversal Property

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

Public Property IsForwardTraversal As Boolean
public bool IsForwardTraversal {get; set;}

INetworkForwardStar.IsRestricted Property

Indicates if the given network element is restricted from traversal in the NetworkForwardStar object.

Public Function get_IsRestricted ( _
    ByVal Element As INetworkElement _
) As Boolean
public bool get_IsRestricted (
    INetworkElement Element
);

INetworkForwardStar.MaxTraversableHierarchyValue Property

Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.

Public Property MaxTraversableHierarchyValue As Integer
public int MaxTraversableHierarchyValue {get; set;}

INetworkForwardStar.NetworkDataset Property

Network dataset on which the NetworkForwardStar object is querying.

Public ReadOnly Property NetworkDataset As INetworkDataset
public INetworkDataset NetworkDataset {get;}

INetworkForwardStar.QueryAdjacencies Method

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

Public Sub QueryAdjacencies ( _
    ByVal atJunction As INetworkJunction, _
    ByVal fromEdge As INetworkEdge, _
    ByVal lastExteriorEdge As INetworkEdge, _
    ByVal adjacencies As INetworkForwardStarAdjacencies _
)
public void QueryAdjacencies (
    INetworkJunction atJunction,
    INetworkEdge fromEdge,
    INetworkEdge lastExteriorEdge,
    INetworkForwardStarAdjacencies adjacencies
);

Remarks

INetworkForwardStar.QueryAttributeCutoffRange Method

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.

Public Sub QueryAttributeCutoffRange ( _
    ByVal Edge As INetworkEdge, _
    ByVal Attribute As INetworkAttribute, _
    ByVal queryPosition As Double, _
    ByVal cutoffValue As Object, _
    ByRef fromPosition As Double, _
    ByRef toPosition As Double _
)
public void QueryAttributeCutoffRange (
    INetworkEdge Edge,
    INetworkAttribute Attribute,
    double queryPosition,
    object cutoffValue,
    ref double fromPosition,
    ref double toPosition
);

INetworkForwardStar.QueryEdge Method

Performs a network edge element query by element ID and edge direction and populates the given edge element object.

Public Sub QueryEdge ( _
    ByVal EID As Integer, _
    ByVal Direction As esriNetworkEdgeDirection, _
    ByVal Edge As INetworkEdge _
)
public void QueryEdge (
    int EID,
    esriNetworkEdgeDirection Direction,
    INetworkEdge Edge
);

INetworkForwardStar.QueryJunction Method

Performs a network junction element query by element ID and populates the given junction element object.

Public Sub QueryJunction ( _
    ByVal EID As Integer, _
    ByVal Junction As INetworkJunction _
)
public void QueryJunction (
    int EID,
    INetworkJunction Junction
);

INetworkForwardStar.QueryTraversableRange Method

Returns the range of accessible positions from a query position along an edge element, respective to any existing restrictions along the edge.

Public Sub QueryTraversableRange ( _
    ByVal Edge As INetworkEdge, _
    ByVal queryPosition As Double, _
    ByRef fromPosition As Double, _
    ByRef toPosition As Double, _
    ByRef isFromPositionAccessible As Boolean, _
    ByRef isToPositionAccessible As Boolean _
)
public void QueryTraversableRange (
    INetworkEdge Edge,
    double queryPosition,
    ref double fromPosition,
    ref double toPosition,
    ref bool isFromPositionAccessible,
    ref bool isToPositionAccessible
);

INetworkForwardStar.QueryTurn Method

Performs a network turn element query by element ID and populates the given turn element object.

Public Sub QueryTurn ( _
    ByVal EID As Integer, _
    ByVal Turn As INetworkTurn _
)
public void QueryTurn (
    int EID,
    INetworkTurn Turn
);

INetworkForwardStar.RemoveAttributeValueAdjustments Method

Removes all element-specific attribute value adjustments currently applied to the NetworkForwardStar object.

Public Sub RemoveAttributeValueAdjustments ( _
)
public void RemoveAttributeValueAdjustments (
);

INetworkForwardStar.RemoveElementRestrictions Method

Removes all element-specific restrictions currently applied to the NetworkForwardStar object.

Public Sub RemoveElementRestrictions ( _
)
public void RemoveElementRestrictions (
);

INetworkForwardStar.RemoveRestrictionAttributes Method

Removes all restriction network attributes currently applied to the NetworkForwardStar object.

Public Sub RemoveRestrictionAttributes ( _
)
public void RemoveRestrictionAttributes (
);

INetworkForwardStar.RestrictionAttribute Property

Restriction network attribute by index in the NetworkForwardStar object.

Public Function get_RestrictionAttribute ( _
    ByVal Index As Integer _
) As INetworkAttribute
public INetworkAttribute get_RestrictionAttribute (
    int Index
);

INetworkForwardStar.RestrictionAttributeCount Property

Number of restriction network attributes currently applied to the NetworkForwardStar object.

Public ReadOnly Property RestrictionAttributeCount As Integer
public int RestrictionAttributeCount {get;}

Classes that implement INetworkForwardStar

Classes Description

Remarks

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.