Click or drag to resize

LocationSpan Class

Class representing a span along a river or a pipe.
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 class LocationSpan : ILocationSpan, 
	IEquatable<ILocationSpan>, IExtensibleDataObject

The LocationSpan type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyEndChainage
End chainage. Unit: [m]
Public propertyExtensionData
Data from an extended DataContract not recognized here
Public propertyID
Identification name
Public propertyStartChainage
Start chainage. Unit: [m]
Top
Methods
  NameDescription
Public methodClone
Produce a deep clone of the object
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. Negative values for tolerance are allowed ("shortening" the span)
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 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)
Public methodStatic memberContainsChainage(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.
Public methodStatic memberContainsChainage(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)
Public methodCreateLocation
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
Public methodCreateSubLocationSpan
Creates a sub-locationSpan defined within chainage interval. Derived data is automatically adjusted to match locationspan The chainages must lay within the span.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current Object.
(Overrides ObjectEquals(Object).)
Public methodEquals(ILocationSpan)
Indicates whether the current object is equal to another object of the same type. The LocationSpan chainages must be within LOCATION_EQUAL_TOLERANCE.
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 methodGetEndLocation
Gets the end location of the span.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode.)
Public methodGetStartLocation
Gets the start location of the span.
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 methodIntersection(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.
Public methodIntersection(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.
Public methodIntersection(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.
Public methodLength
Length of the location span.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMidPoint
Returns location midway in the location span
Public methodOverLaps(ILocationSpan)
Decides whether a location span overlaps the current locationSpan. If overlap is less than LOCATION_EQUAL_TOLERANCE, false is returned.
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 methodStatic memberOverLaps(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.
Public methodStrictContains(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.
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 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.
Public methodToString
Top
Fields
  NameDescription
Protected field_endChainage
End chainage [m]
Protected field_startChainage
Start chainage [m]
Top
Extension Methods
  NameDescription
Public Extension MethodOverLap(ILocationSpan)Overloaded.
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.)
Public Extension MethodOverLap(Double, Double)Overloaded.
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.)
Top
See Also