ZLocation Class

A location with a z-value

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 ZLocation : Location, IZLocation, 
	ILocation, IComparable, ICloneable, IEquatable<ILocation>
Inheritance
Object    Location    ZLocation
Implements
ILocation, IZLocation, ICloneable, IComparable, IEquatableILocation

Constructors

ZLocation(ILocation) Create a ZLocation from an ILocation, setting a default Z value
ZLocation(String, Double) Create a ZLocation

Properties

Chainage Chainage. Unit: [m]
(Inherited from Location)
ExtensionData Data from an extended DataContract not recognized here
(Inherited from Location)
ID Identification name
(Inherited from Location)
Z Gets and sets the z-coordinate

Methods

Clone Returns a deep clone of this object
CompareTo Compares two ILocations. First id is compared, secondly chainage. This can be used to sort the ILocations, first alphabetically, secondly by chainage.
(Inherited from Location)
Equals(ILocation) Indicates whether the current object is equal to another object of the same type. The Location chainage must be within LOCATION_EQUAL_TOLERANCE.
(Inherited from Location)
Equals(Object) Determines whether the specified Object is equal to the current Object.
(Inherited from Location)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FromString(String) 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.
(Inherited from Location)
FromString(String, Boolean) 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. The flag specifies whether or not the hyphens around the ID is wished kept or not.
(Inherited from Location)
GetHashCode Serves as a hash function for a particular type.
(Inherited from Location)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IDCompareTo Compare the ID with the others ID.
(Inherited from Location)
IDEquals(ILocation) Check if the ID equals the others ID
(Inherited from Location)
IDEquals(ILocationSpan) Check if the ID equals the others ID, case ignored (culture invariant)
(Inherited from Location)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToString This method os important when creating a node id from a location. It is important to act in _chainage == Constants.DELETEVALUE since this is how rivers are connected to pipes.
(Inherited from Location)
ToStringInUserUnits Gives the textual representation of the string in user units.
(Inherited from Location)

Fields

_chainage Position along the reach.
(Inherited from Location)
_id Identification name
(Inherited from 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