INetworkForwardStarSetup Interface

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

Members

	Name	Description
	AddCachedAttribute	AddCachedAttribute has been deprecated and should not be called.
	AddRestriction	Adds a restriction network attribute to the NetworkForwardStar object to filter elements returned.
	Backtrack	Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.
	HierarchyAttribute	Network attribute containing the hierarchy values for each network element.
	IsForwardTraversal	Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.
	MaxHierarchyValue	Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.
	NetworkDataset	Network dataset on which the NetworkForwardStar object is querying.
	NonTraversableElements	The collection of network elements of the given type that are set to not traversable.
	RemoveAllCachedAttributes	RemoveAllCachedAttributes has been deprecated and should not be called.
	RemoveRestriction	Removes the given restriction network attribute by index from the NetworkForwardStar object.
	Restriction	Restriction network attribute by index applied to the NetworkForwardStar object.
	RestrictionCount	Number of restriction network attributes applied to the NetworkForwardStar object.
	SetAllTraversable	Sets all network elements of the given element type to be traversable or non-traversable.
	SetTraversable	Sets the given network elements to be traversable or non-traversable.
	Traversable	Indicates if the given network element is travserable by the NetworkForwardStar object.

INetworkForwardStarSetup.AddCachedAttribute Method

AddCachedAttribute has been deprecated and should not be called.

Public Sub AddCachedAttribute ( _
    ByVal Attribute As INetworkAttribute _
)

public void AddCachedAttribute (
    INetworkAttribute Attribute
);

Remarks

This method has been deprecated.

INetworkForwardStarSetup.AddRestriction Method

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

Public Sub AddRestriction ( _
    ByVal Attribute As INetworkAttribute _
)

public void AddRestriction (
    INetworkAttribute Attribute
);

Remarks

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

INetworkForwardStarSetup.Backtrack Property

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

Public Property Backtrack As esriNetworkForwardStarBacktrack

public esriNetworkForwardStarBacktrack Backtrack {get; set;}

Remarks

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

INetworkForwardStarSetup.HierarchyAttribute Property

Network attribute containing the hierarchy values for each network element.

Public Property HierarchyAttribute As INetworkAttribute

public INetworkAttribute HierarchyAttribute {get; set;}

Remarks

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

INetworkForwardStarSetup.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;}

Remarks

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

INetworkForwardStarSetup.MaxHierarchyValue Property

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

Public Property MaxHierarchyValue As Integer

public int MaxHierarchyValue {get; set;}

Remarks

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

INetworkForwardStarSetup.NetworkDataset Property

Network dataset on which the NetworkForwardStar object is querying.

Public ReadOnly Property NetworkDataset As INetworkDataset

public INetworkDataset NetworkDataset {get;}

Remarks

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

INetworkForwardStarSetup.NonTraversableElements Property

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

Public Function get_NonTraversableElements ( _
    ByVal ElementType As esriNetworkElementType, _
    ByVal Direction As esriNetworkEdgeDirection _
) As IEnumNetworkElement

public IEnumNetworkElement get_NonTraversableElements (
    esriNetworkElementType ElementType,
    esriNetworkEdgeDirection Direction
);

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.

INetworkForwardStarSetup.RemoveAllCachedAttributes Method

RemoveAllCachedAttributes has been deprecated and should not be called.

Public Sub RemoveAllCachedAttributes ( _
)

public void RemoveAllCachedAttributes (
);

Remarks

This method has been deprecated.

INetworkForwardStarSetup.RemoveRestriction Method

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

Public Sub RemoveRestriction ( _
    ByVal Index As Integer _
)

public void RemoveRestriction (
    int Index
);

Remarks

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

INetworkForwardStarSetup.Restriction Property

Restriction network attribute by index applied to the NetworkForwardStar object.

Public Function get_Restriction ( _
    ByVal Index As Integer _
) As INetworkAttribute

public INetworkAttribute get_Restriction (
    int Index
);

Remarks

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

INetworkForwardStarSetup.RestrictionCount Property

Number of restriction network attributes applied to the NetworkForwardStar object.

Public ReadOnly Property RestrictionCount As Integer

public int RestrictionCount {get;}

Remarks

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

INetworkForwardStarSetup.SetAllTraversable Method

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

Public Sub SetAllTraversable ( _
    ByVal ElementType As esriNetworkElementType, _
    ByVal Traversable As Boolean _
)

public void SetAllTraversable (
    esriNetworkElementType ElementType,
    bool Traversable
);

Remarks

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

INetworkForwardStarSetup.SetTraversable Method

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

Public Sub SetTraversable ( _
    ByVal Elements As IEnumNetworkElement, _
    ByVal Traversable As Boolean _
)

public void SetTraversable (
    IEnumNetworkElement Elements,
    bool Traversable
);

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.

INetworkForwardStarSetup.Traversable Property

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

Public Function get_Traversable ( _
    ByVal Element As INetworkElement _
) As Boolean

Public Sub set_Traversable ( _
    ByVal Element As INetworkElement, _
    ByVal Traversable As Boolean _
)

public bool get_Traversable (
    INetworkElement Element
);

public void set_Traversable (
    INetworkElement Element,
    bool Traversable
);

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.

Classes that implement INetworkForwardStarSetup

Classes	Description

Remarks