Click or drag to resize

ILocation Interface

A location is a point in the network. A Location is always a part of the network, and identified by a branch/link id and a chainage

Namespace:  DHI.Mike1D.Generic
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public interface ILocation : IComparable, 
	ICloneable, IEquatable<ILocation>

The ILocation type exposes the following members.

Properties
  NameDescription
Public propertyChainage
Chainage. Unit: [m]
Public propertyID
Identification name, branch/link id
Top
Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodCompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from IComparable.)
Public methodEquals
Indicates whether the current object is equal to another object of the same type.
(Inherited from IEquatableILocation.)
Public methodFromString
This method is made to get back from a Location.ToString(). It is therefor very important that any changes in ToString are reflected in this method.
Public methodIDCompareTo
Compare the ID with the others ID.
Public methodIDEquals
Check if the ID equals the others ID.
Public methodToString
This method os important when creating a node id from a location. It is important to return something sensible if _chainge == Constants.DELETEVALUE since this is how rivers are connected to pipes.
Public methodToStringInUserUnits
Returns a textual representation of the Location in user units
Top
Extension Methods
  NameDescription
Public Extension MethodChainageAsDiagnosticsValue
Get chainage as DiagnosticsValue (includes unit)
(Defined by GenericExtensions.)
Public Extension MethodChainageEquals(Double)Overloaded.
Returns true if the chainage equals, withing LOCATION_EQUAL_TOLERANCE
(Defined by GenericExtensions.)
Public Extension MethodChainageEquals(Double, Double)Overloaded.
Returns true if the chainage equals, withing tolerance
(Defined by GenericExtensions.)
Top
See Also