Click or drag to resize

AbstractLocationSpan Class

Abstract class implementing the base functionality for a location span
Inheritance Hierarchy

Namespace:  DHI.Mike1D.Generic
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public abstract class AbstractLocationSpan

The AbstractLocationSpan type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractLocationSpan
Initializes a new instance of the AbstractLocationSpan class
Top
Properties
  NameDescription
Public propertyEndChainage
End chainage. Unit: [m]
Public propertyID
Identification name
Public propertyStartChainage
Start chainage. Unit: [m]
Top
Methods
  NameDescription
Public methodCompareTo
Compares the current instance with another object of the same type.
Public methodContains(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.
Public methodContains(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.
Public methodContainsChainage(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.
Public methodContainsChainage(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)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIDEquals
Check if the ID equals the others ID, case ignored (culture invariant)
Public methodLength
Length of the location span.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOverLaps(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.
Public methodOverLaps(ILocationSpan, Double)
Decides whether a location span overlaps the current locationSpan. If overlap is less than minOverlap, false is returned.
Public methodOverLaps(Double, Double, Double)
Decides whether a location span overlaps the chainages of another locationSpan. If overlap is less than minOverlap, false is returned.
Public methodStrictContains(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.

Public methodStrictContains(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
Public methodStrictContainsChainage
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Protected field_id
Unique string ID for this span
Protected field_intID
Unique integer ID for this span
Top
See Also