Location Class

Class describing a location in a network. ,'s are not allowed in the ID.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.GenericLocation
DHI.Mike1D.GenericZLocation

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

Syntax

C++

Copy

public class Location : ILocation, IComparable, 
	ICloneable, IEquatable<ILocation>, IExtensibleDataObject

Public Class Location
	Implements ILocation, IComparable, ICloneable, IEquatable(Of ILocation), 
	IExtensibleDataObject

public ref class Location : ILocation, 
	IComparable, ICloneable, IEquatable<ILocation^>, IExtensibleDataObject

The Location type exposes the following members.

Constructors

	Name	Description
	Location	Constructor
	Location(String, Double)	Constructor

Top

Properties

	Name	Description
	Chainage	Chainage. Unit: [m]
	ExtensionData	Data from an extended DataContract not recognized here
	ID	Identification name

Top

Methods

	Name	Description
	CalculateRatio	Calculate the ratio of the inter Location position in between the start (sc) and end (ec) locations, such that Copy v = (1-ratio)v_sc + ratiov_ec If inter is not in between sc and ec, ratio can be negative or larger than one.
	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.
	CreateSpanAroundLocation	Create a LocationSpan around the given location, that goes startDist up and endDist down from the chainage of the location. Span will go from location.Chainage-startDist to location.Chainage+endDist.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Overrides ObjectEquals(Object).)
	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.
	Finalize	Allows 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.
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IDCompareTo	Compare the ID with the others ID.
	IDEquals(ILocation)	Check if the ID equals the others ID
	IDEquals(ILocationSpan)	Check if the ID equals the others ID, case ignored (culture invariant)
	MemberwiseClone	Creates 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. (Overrides ObjectToString.)
	ToStringInUserUnits	Gives the textual representation of the string in user units.

Top

Fields

	Name	Description
	_chainage	Position along the reach.
	_id	Identification name

Top

Extension Methods

	Name	Description
	ChainageAsDiagnosticsValue	Get chainage as DiagnosticsValue (includes unit) (Defined by GenericExtensions.)
	ChainageEquals(Double)	Overloaded. Returns true if the chainage equals, withing LOCATION_EQUAL_TOLERANCE (Defined by GenericExtensions.)
	ChainageEquals(Double, Double)	Overloaded. Returns true if the chainage equals, withing tolerance (Defined by GenericExtensions.)

Top

Reference

DHI.Mike1D.Generic Namespace