LocationRelative Class

A location that is relative, i.e. the exact chainage is not known.

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 class LocationRelative : ILocation, 
	IComparable, ICloneable, IEquatable<ILocation>
Inheritance
Object    LocationRelative
Implements
ILocation, ICloneable, IComparable, IEquatableILocation

Constructors

LocationRelative Create a new relative location.

Properties

Chainage Chainage. Unit: [m]
ID Identification name
LocationRelativeType Where the location is.

Methods

CloneCreates a new object that is a copy of the current instance.
CompareToCompares 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.
Equals(ILocation) Indicates whether the current object is equal to another object of the same type.
Equals(Object)Determines 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)
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.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IDCompareTo Compare the ID with the others ID.
IDEquals Check if the ID equals the others ID
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
ToStringInUserUnits Returns a textual representation of the Location in user units

Fields

_id ID of location

Extension Methods

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)

See Also