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

Definition

Namespace: DHI.Mike1D.Generic
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 24.0.0.0 (11.1.1.1111)

C#

public interface ILocation : IComparable, 
	ICloneable, IEquatable<ILocation>

Chainage	Chainage. Unit: [m]
ID	Identification name, branch/link id

Clone	Creates a new object that is a copy of the current instance. (Inherited from ICloneable)
CompareTo	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)
Equals	Indicates whether the current object is equal to another object of the same type. (Inherited from IEquatableILocation)
FromString	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.
IDCompareTo	Compare the ID with the others ID.
IDEquals	Check if the ID equals the others ID.
ToString	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.
ToStringInUserUnits	Returns a textual representation of the Location in user units

ChainageAsDiagnosticsValue	Get chainage as DiagnosticsValue (includes unit) (Defined by GenericExtensions)
ChainageEquals	Returns true if the chainage equals, withing LOCATION_EQUAL_TOLERANCE (Defined by GenericExtensions)
ChainageEquals	Returns true if the chainage equals, withing tolerance (Defined by GenericExtensions)
ChainageIsAfter	Returns true if the chainage is after, and more than LOCATION_EQUAL_TOLERANCE after This is consistent with the `ChainageEquals`, so that any chainage will only return true for one of the `ChainageIsBefore, ChainageEquals, ChainageIsAfter` (Defined by GenericExtensions)
ChainageIsAfter	Returns true if the chainage is after, and more than tolerance after This is consistent with the `ChainageEquals`, so that any chainage will only return true for one of the `ChainageIsBefore, ChainageEquals, ChainageIsAfter` (Defined by GenericExtensions)
ChainageIsBefore	Returns true if the chainage is before, and more than LOCATION_EQUAL_TOLERANCE before This is consistent with the `ChainageEquals`, so that any chainage will only return true for one of the `ChainageIsBefore, ChainageEquals, ChainageIsAfter` (Defined by GenericExtensions)
ChainageIsBefore	Returns true if the chainage is before, and more than tolerance before This is consistent with the `ChainageEquals`, so that any chainage will only return true for one of the `ChainageIsBefore, ChainageEquals, ChainageIsAfter` (Defined by GenericExtensions)