AbstractLocationSpan Class

Abstract class implementing the base functionality for a location span

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 abstract class AbstractLocationSpan
Inheritance
Object    AbstractLocationSpan
Derived

Constructors

AbstractLocationSpanInitializes a new instance of the AbstractLocationSpan class

Properties

EndChainage End chainage. Unit: [m]
ID Identification name
StartChainage Start chainage. Unit: [m]

Methods

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. tolerance may be negative.
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 whether a chainage value is contained inside the location span chainage values or on the edge of the span. Comparison uses the tolerance, i.e., the chainage can be tolerance outside the span and still be contained. Negative values for tolerance are allowed ("shortening" the span)
EqualsDetermines 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)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IDEquals Check if the ID equals the others ID, case ignored (culture invariant)
Length Length of the location span.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OverLaps(ILocationSpan) Decides whether a location span overlaps the current locationSpan. There must be a strict overlap, i.e., the intersection must be larger than LOCATION_EQUAL_TOLERANCE.
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.
StrictContains(ILocation)

Decides whether location is contained inside the location span. Inside is understood as startChainage > location.Chainage and location.Chainage > endLocation

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 whether 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.
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

_id Unique string ID for this span
_intID Unique integer ID for this span

See Also