ZLocationSpan Class

Location span. Identified by two points: Start chainage [m] and end chainage [m]

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 ZLocationSpan : LocationSpan
Inheritance
Object    LocationSpan    ZLocationSpan

Constructors

ZLocationSpan Constructor

Properties

EndChainage End chainage. Unit: [m]
(Inherited from LocationSpan)
EndZ Z value at end of location span [m]
ExtensionData Data from an extended DataContract not recognized here
(Inherited from LocationSpan)
ID Identification name
(Inherited from LocationSpan)
StartChainage Start chainage. Unit: [m]
(Inherited from LocationSpan)
StartZ Z value at start of location span [m]

Methods

Clone Produce a deep clone of the object
(Overrides LocationSpanClone)
CompareTo Compares the current instance with another object of the same type.
(Inherited from LocationSpan)
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.
(Inherited from LocationSpan)
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)
(Inherited from LocationSpan)
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.
(Inherited from LocationSpan)
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)
(Inherited from LocationSpan)
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
(Overrides LocationSpanCreateLocation(Double))
CreateSubLocationSpan Creates a sub-locationSpan defined within chainage interval. Derived data is automatically adjusted to match locationspan The chainages must lay within the span.
(Overrides LocationSpanCreateSubLocationSpan(Double, Double))
CreateZLocationSpan Create a ZLocationSpan from an ILocationSpan. Z values will be zero
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.
(Inherited from LocationSpan)
Equals(Object) Determines whether the specified Object is equal to the current Object.
(Inherited from LocationSpan)
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.
(Overrides LocationSpanGetEndLocation)
GetHashCode Serves as a hash function for a particular type.
(Inherited from LocationSpan)
GetStartLocation Gets the start location of the span.
(Overrides LocationSpanGetStartLocation)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IDEquals Check if the ID equals the others ID, case ignored (culture invariant)
(Inherited from LocationSpan)
interpolateZAt Interpolate Z value at given chainage. It is not tested whether the chainage is inside span, use Contains
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.
(Inherited from LocationSpan)
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.
(Inherited from LocationSpan)
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.
(Inherited from LocationSpan)
Length Length of the location span.
(Inherited from LocationSpan)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MidPoint Returns location midway in the location span
(Overrides LocationSpanMidPoint)
OverLaps(ILocationSpan) Decides whether a location span overlaps the current locationSpan. If overlap is less than LOCATION_EQUAL_TOLERANCE, false is returned.
(Inherited from LocationSpan)
OverLaps(ILocationSpan, Double) Decides whether a location span overlaps the current locationSpan. If overlap is less than minOverlap, false is returned.
(Inherited from LocationSpan)
OverLaps(Double, Double, Double) Decides whether a location span overlaps the chainages of another locationSpan. If overlap is less than minOverlap, false is returned.
(Inherited from LocationSpan)
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.
(Inherited from LocationSpan)
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
(Inherited from LocationSpan)
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.
(Inherited from LocationSpan)
ToString
(Inherited from LocationSpan)
ZMidPoint Returns location midway in the location span

Fields

_endChainage End chainage [m]
(Inherited from LocationSpan)
_startChainage Start chainage [m]
(Inherited from LocationSpan)

See Also