DistanceCalculator Class

Class to calculate distances from a location to any point in the network.

Use CalculateDistances(ILocation) to start a calculation, and extract data from Distances.

Definition

Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class DistanceCalculator
Inheritance
Object    DistanceCalculator

Constructors

DistanceCalculator Create object working on provided engineNet

Properties

Distances Distances from location to any other node and grid point in the network

The value double.MaxValue is used when the node/grid point is more than MaxDistance from the location, or if the node/grid-point is not reachable from the location

MaxDistance Maximum distance from search location to calculate distance. Outside this distance, the results in the Distances may be double.MaxValue.
UseSignedDistance Flag specifying whether to calculate signed distances, i.e. distance is positive in down-stream direction and negative in up-stream direction from location

Methods

CalculateDistances(ILocation) Calculate distances from location to any other grid point and node within the network
CalculateDistances(INetworkLocation) Calculate distances from location to any other grid point and node within the network
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also