Interface INetworkForwardStar

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

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

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("FDE593A2-8E96-40C8-8AB2-6DA6D60AF9B9")]
public interface INetworkForwardStar

Remarks


Properties

BacktrackPolicy

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

esriNetworkForwardStarBacktrack BacktrackPolicy { get; set; }

Property Value

esriNetworkForwardStarBacktrack

HierarchyAttribute

Network attribute containing the hierarchy values for each network element.

INetworkAttribute HierarchyAttribute { get; set; }

Property Value

INetworkAttribute

IsFiltered[INetworkElement]

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

bool IsFiltered[INetworkElement Element] { get; }

Parameters

Element INetworkElement

Property Value

bool

Remarks

This property has been superceded by the IsRestricted property.

IsForwardTraversal

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

bool IsForwardTraversal { get; set; }

Property Value

bool

IsRestricted[INetworkElement]

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

bool IsRestricted[INetworkElement Element] { get; }

Parameters

Element INetworkElement

Property Value

bool

MaxTraversableHierarchyValue

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

int MaxTraversableHierarchyValue { get; set; }

Property Value

int

NetworkDataset

Network dataset on which the NetworkForwardStar object is querying.

INetworkDataset NetworkDataset { get; }

Property Value

INetworkDataset

RestrictionAttribute[int]

Restriction network attribute by index in the NetworkForwardStar object.

INetworkAttribute RestrictionAttribute[int Index] { get; }

Parameters

Index int

Property Value

INetworkAttribute

RestrictionAttributeCount

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

int RestrictionAttributeCount { get; }

Property Value

int

Methods

AddEdgeRestriction(INetworkEdge, double, double)

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

void AddEdgeRestriction(INetworkEdge Edge, double fromPosition, double toPosition)

Parameters

Edge INetworkEdge
fromPosition double
toPosition double

AddJunctionRestriction(INetworkJunction)

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

void AddJunctionRestriction(INetworkJunction Junction)

Parameters

Junction INetworkJunction

AddRestrictionAttribute(INetworkAttribute)

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

void AddRestrictionAttribute(INetworkAttribute Attribute)

Parameters

Attribute INetworkAttribute

AddTurnRestriction(INetworkTurn)

Restricts a turn in the adjacency queries.

void AddTurnRestriction(INetworkTurn Turn)

Parameters

Turn INetworkTurn

AdjustEdgeAttributeValue(INetworkEdge, double, double, INetworkAttribute, esriNetworkAttributeAdjustmentType, object)

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

void AdjustEdgeAttributeValue(INetworkEdge Edge, double fromPosition, double toPosition, INetworkAttribute Attribute, esriNetworkAttributeAdjustmentType adjustmentType, object Value)

Parameters

Edge INetworkEdge
fromPosition double
toPosition double
Attribute INetworkAttribute
adjustmentType esriNetworkAttributeAdjustmentType
Value object

AdjustJunctionAttributeValue(INetworkJunction, INetworkAttribute, esriNetworkAttributeAdjustmentType, object)

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

void AdjustJunctionAttributeValue(INetworkJunction Junction, INetworkAttribute Attribute, esriNetworkAttributeAdjustmentType adjustmentType, object Value)

Parameters

Junction INetworkJunction
Attribute INetworkAttribute
adjustmentType esriNetworkAttributeAdjustmentType
Value object

AdjustTurnAttributeValue(INetworkTurn, INetworkAttribute, esriNetworkAttributeAdjustmentType, object)

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

void AdjustTurnAttributeValue(INetworkTurn Turn, INetworkAttribute Attribute, esriNetworkAttributeAdjustmentType adjustmentType, object Value)

Parameters

Turn INetworkTurn
Attribute INetworkAttribute
adjustmentType esriNetworkAttributeAdjustmentType
Value object

QueryAdjacencies(INetworkJunction, INetworkEdge, INetworkEdge, INetworkForwardStarAdjacencies)

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

void QueryAdjacencies(INetworkJunction atJunction, INetworkEdge fromEdge, INetworkEdge lastExteriorEdge, INetworkForwardStarAdjacencies adjacencies)

Parameters

atJunction INetworkJunction
fromEdge INetworkEdge
lastExteriorEdge INetworkEdge
adjacencies INetworkForwardStarAdjacencies

Remarks


QueryAttributeCutoffRange(INetworkEdge, INetworkAttribute, double, object, out double, out double)

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 QueryAttributeCutoffRange(INetworkEdge Edge, INetworkAttribute Attribute, double queryPosition, object cutoffValue, out double fromPosition, out double toPosition)

Parameters

Edge INetworkEdge
Attribute INetworkAttribute
queryPosition double
cutoffValue object
fromPosition double
toPosition double

QueryEdge(long, esriNetworkEdgeDirection, INetworkEdge)

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

void QueryEdge(long EID, esriNetworkEdgeDirection Direction, INetworkEdge Edge)

Parameters

EID long
Direction esriNetworkEdgeDirection
Edge INetworkEdge

QueryJunction(long, INetworkJunction)

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

void QueryJunction(long EID, INetworkJunction Junction)

Parameters

EID long
Junction INetworkJunction

QueryTraversableRange(INetworkEdge, double, out double, out double, out bool, out bool)

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

void QueryTraversableRange(INetworkEdge Edge, double queryPosition, out double fromPosition, out double toPosition, out bool isFromPositionAccessible, out bool isToPositionAccessible)

Parameters

Edge INetworkEdge
queryPosition double
fromPosition double
toPosition double
isFromPositionAccessible bool
isToPositionAccessible bool

QueryTurn(long, INetworkTurn)

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

void QueryTurn(long EID, INetworkTurn Turn)

Parameters

EID long
Turn INetworkTurn

RemoveAttributeValueAdjustments()

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

void RemoveAttributeValueAdjustments()

RemoveElementRestrictions()

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

void RemoveElementRestrictions()

RemoveRestrictionAttributes()

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

void RemoveRestrictionAttributes()