LocationSpan Class

Class representing a span along a river or a pipe.

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 LocationSpan : ILocationSpan, 
	IEquatable<ILocationSpan>, IExtensibleDataObject
Inheritance
Object    LocationSpan
Derived
Implements
ILocationSpan, IEquatableILocationSpan, IExtensibleDataObject

Constructors

LocationSpan Default constructor
LocationSpan(String, Double, Double) Constructor

Properties

EndChainage End chainage. Unit: [m]
ExtensionData Data from an extended DataContract not recognized here
ID Identification name
StartChainage Start chainage. Unit: [m]

Methods

Clone Produce a deep clone of the object
CompareTo Compares the current instance with another object of the same type.
Contains(ILocation) Decides wheather location is contained inside the location span or on the edge of the span. Location comparisons are case insensitive, and uses the Constants.LOCATION_EQUAL_TOLERANCE, i.e., the location can be tolerance outside the span and still be contained.
Contains(ILocation, Double) Decides wheather location is contained inside the location span or on the edge of the span. Location comparisons are case insensitive, and uses the tolerance, i.e., the location can be tolerance outside the span and still be contained. Negative values for tolerance are allowed ("shortening" the span)
ContainsChainage(Double) Decides wheather a chainage value is contained inside the location span chainage values or on the edge of the span. Comparison uses the Constants.LOCATION_EQUAL_TOLERANCE, i.e., the chainage can be tolerance outside the span and still be contained.
ContainsChainage(Double, Double) Decides wheather a chainage value is contained inside the location span chainage values. Comparison uses the tolerance parameter i.e., the chainage can be tolerance outside the span before it is contained. Negative values for tolerance are allowed ("shortening" the span)
ContainsChainage(Double, Double, Double) Decides wheather a chainage value is contained inside the location span chainage values or on the edge of the span. Comparison uses the Constants.LOCATION_EQUAL_TOLERANCE, i.e., the chainage can be tolerance outside the span and still be contained.
ContainsChainage(Double, Double, Double, Double) Decides wheather a chainage value is contained inside the location span chainage values. Comparison uses the tolerance parameter i.e., the chainage can be tolerance outside the span before it is contained. Negative values for tolerance are allowed ("shortening" the span)
CreateLocation Creates a location at the specified chainage of the span. Derived data is automatically calculated at the location. The chainage must lay within the span, otherwise null is returned
CreateSubLocationSpan Creates a sub-locationSpan defined within chainage interval. Derived data is automatically adjusted to match locationspan The chainages must lay within the span.
Equals(ILocationSpan) Indicates whether the current object is equal to another object of the same type. The LocationSpan chainages must be within LOCATION_EQUAL_TOLERANCE.
Equals(Object) Determines whether the specified Object is equal to the current Object.
(Overrides ObjectEquals(Object))
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetEndLocation Gets the end location of the span.
GetHashCode Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode)
GetStartLocation Gets the start location of the span.
GetTypeGets the Type of the current instance.
(Inherited from Object)
IDEquals Check if the ID equals the others ID, case ignored (culture invariant)
Intersection(ILocationSpan) Returns the intersection of this and other. There must be a strict overlap, i.e., the intersection must be larger than LOCATION_EQUAL_TOLERANCE.
Intersection(ILocationSpan, Double) Returns the intersection of this and other. There must be a strict overlap, i.e., the intersection must be larger than minOverlap. Set to zero if very small overlaps is allowed.
Intersection(Double, Double, Double) Returns the intersection of this and chainages of another locationspan. There must be a strict overlap, i.e., the intersection must be larger than minOverlap. Set to zero if very small overlaps is allowed.
Length Length of the location span.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MidPoint Returns location midway in the location span
OverLaps(ILocationSpan) Decides whether a location span overlaps the current locationSpan. If overlap is less than LOCATION_EQUAL_TOLERANCE, false is returned.
OverLaps(ILocationSpan, Double) Decides whether a location span overlaps the current locationSpan. If overlap is less than minOverlap, false is returned.
OverLaps(Double, Double, Double) Decides whether a location span overlaps the chainages of another locationSpan. If overlap is less than minOverlap, false is returned.
OverLaps(Double, Double, Double, Double, Double) Decides whether a location span overlaps the chainages of another locationSpan. If overlap is less than minOverlap, false is returned.
StrictContains(ILocation) Decides whether location is contained inside the location span. Inside is understood as startChainage > location.Chainage and location.Chainage > endChainage Location comparisons are case insensitive, and uses the Constants.LOCATION_EQUAL_TOLERANCE, i.e., location.Chainage must be tolerance inside the span to evaluate to true.
StrictContains(ILocationSpan) Decides whether a location span is contained inside this location span. This is the case when both the start and end location is contained inside the location span
StrictContainsChainage Decides wheather a chainage value is strictly contained inside the location span chainage values. Comparison uses the Constants.LOCATION_EQUAL_TOLERANCE, i.e., the chainage must be tolerance inside the span before it is contained.
ToString
(Overrides ObjectToString)

Fields

_endChainage End chainage [m]
_startChainage Start chainage [m]

Extension Methods

OverLap Calculate overlap of location span and another locationSpan. If the result is positive, the value is the actual overlap. If the result is negative, there is no overlap, and the value is the negative distance between the two spans.
(Defined by GenericExtensions)
OverLap Calculate overlap of location span and the chainages of another locationSpan. If the result is positive, the value is the actual overlap. If the result is negative, there is no overlap, and the value is the negative distance between the two spans.
(Defined by GenericExtensions)

See Also