Interface INetworkForwardStarSetup

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

Provides access to members that specify the configuration for this NetworkForwardStar object.

[Guid("D68A2A0C-F2B9-47AF-8AE6-811513349546")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface INetworkForwardStarSetup

Remarks


Properties

Backtrack

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

esriNetworkForwardStarBacktrack Backtrack { get; set; }

Property Value

esriNetworkForwardStarBacktrack

Remarks

This property has been superceded by theBacktrackPolicy property on theINetworkForwardStar interface. Please refer to that interface for usage instructions.

HierarchyAttribute

Network attribute containing the hierarchy values for each network element.

INetworkAttribute HierarchyAttribute { get; set; }

Property Value

INetworkAttribute

Remarks

This property has been superceded by the HierarchyAttribute property on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

IsForwardTraversal

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

bool IsForwardTraversal { get; set; }

Property Value

bool

Remarks

This property has been superceded by the IsForwardTraversal property on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

MaxHierarchyValue

Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.

int MaxHierarchyValue { get; set; }

Property Value

int

Remarks

This property has been superceded by the MaxTraversableHierarchyValue property on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

NetworkDataset

Network dataset on which the NetworkForwardStar object is querying.

INetworkDataset NetworkDataset { get; }

Property Value

INetworkDataset

Remarks

This property has been superceded by the NetworkDataset property on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

NonTraversableElements[esriNetworkElementType, esriNetworkEdgeDirection]

The collection of network elements of the given type that are set to not traversable.

IEnumNetworkElement NonTraversableElements[esriNetworkElementType ElementType, esriNetworkEdgeDirection Direction] { get; }

Parameters

ElementType esriNetworkElementType
Direction esriNetworkEdgeDirection

Property Value

IEnumNetworkElement

Remarks

The NonTraversable property returns an IEnumNetworkElement object containing all network elements that have their Traversable value set to False.

The IEnumNetworkElement enumeration object returned is recycling.  For enumerations with more than one network element returned, this means that the network element object returned by the first call to Next is expected to be reused in subsequent calls to Next.

Restriction[int]

Restriction network attribute by index applied to the NetworkForwardStar object.

INetworkAttribute Restriction[int Index] { get; }

Parameters

Index int

Property Value

INetworkAttribute

Remarks

This property has been superceded by the RestrictionAttribute property on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

RestrictionCount

Number of restriction network attributes applied to the NetworkForwardStar object.

int RestrictionCount { get; }

Property Value

int

Remarks

This property has been superceded by the RestrictionAttributeCount property on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

Traversable[INetworkElement]

Indicates if the given network element is travserable by the NetworkForwardStar object.

bool Traversable[INetworkElement Element] { get; set; }

Parameters

Element INetworkElement

Property Value

bool

Remarks

The Traversable property specifies whether the given network element can be returned by this INetworkForwardStar object. This is useful when restricting specific network elements from being returned by the forward star.  If the Traversable value is True, the given network element will be returned by the forward star.

Methods

AddCachedAttribute(INetworkAttribute)

AddCachedAttribute has been deprecated and should not be called.

void AddCachedAttribute(INetworkAttribute Attribute)

Parameters

Attribute INetworkAttribute

Remarks

This method has been deprecated.

AddRestriction(INetworkAttribute)

Adds a restriction network attribute to the NetworkForwardStar object to filter elements returned.

void AddRestriction(INetworkAttribute Attribute)

Parameters

Attribute INetworkAttribute

Remarks

This method has been superceded by theAddRestrictionAttribute method on theINetworkForwardStar interface. Please refer to that interface for usage instructions.

RemoveAllCachedAttributes()

RemoveAllCachedAttributes has been deprecated and should not be called.

void RemoveAllCachedAttributes()

Remarks

This method has been deprecated.

RemoveRestriction(int)

Removes the given restriction network attribute by index from the NetworkForwardStar object.

void RemoveRestriction(int Index)

Parameters

Index int

Remarks

This property has been superceded by the RemoveRestrictionAttributes method on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

SetAllTraversable(esriNetworkElementType, bool)

Sets all network elements of the given element type to be traversable or non-traversable.

void SetAllTraversable(esriNetworkElementType ElementType, bool Traversable)

Parameters

ElementType esriNetworkElementType
Traversable bool

Remarks

This property has been superceded by the RemoveElementRestrictions property on the INetworkForwardStar interface. Please refer to that interface for usage instructions.

SetTraversable(IEnumNetworkElement, bool)

Sets the given network elements to be traversable or non-traversable.

void SetTraversable(IEnumNetworkElement Elements, bool Traversable)

Parameters

Elements IEnumNetworkElement
Traversable bool

Remarks

The SetTraversable method with a Traversable parameter value of True sets all network elements in the given enumeration as Traversable.

The SetTraversable method with a Traversable parameter value of False sets all network elements in the given enumeration as not Traversable.