XYZLocationSpan Class

A location span that is defined by a set of coordinates

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 XYZLocationSpan : AbstractLocationSpan, 
	IXYZLocationSpan, ILocationSpan, IEquatable<ILocationSpan>
Inheritance
Object    AbstractLocationSpan    XYZLocationSpan
Implements
ILocationSpan, IXYZLocationSpan, IEquatableILocationSpan

Constructors

XYZLocationSpan Constructor. Creates a XYZLocationSpan with the given id

Properties

Coordinates Coordinates that define the location span
EndChainage End chainage. Unit: [m]
(Overrides AbstractLocationSpanEndChainage)
ID Identification name
(Inherited from AbstractLocationSpan)
StartChainage Start chainage. Unit: [m]
(Overrides AbstractLocationSpanStartChainage)

Methods

Clone Clone the properties of the XYZLocationSpan.
CompareTo Compares the current instance with another object of the same type.
(Inherited from AbstractLocationSpan)
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 AbstractLocationSpan)
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.
(Inherited from AbstractLocationSpan)
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 AbstractLocationSpan)
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)
(Inherited from AbstractLocationSpan)
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.
CreateSubLocationSpan Creates a sub-locationSpan defined within chainage interval. Derived data is automatically adjusted to match locationspan The chainages must lay within the span.

If an existing coordinate is inside but very close to one of the new locationspan end points, that coordinate will not be part of the new span, hence you may not find all points of the existing span in the new span. It uses LOCATION_EQUAL_TOLERANCE on the M value.

Equals(ILocationSpan) Indicates whether the current object is equal to another object of the same type.
Equals(Object)Determines 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)
GetEndLocation Gets the end location of the span. The span can not be edited by editing this location.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetStartLocation Gets the start location of the span. The span can not be edited by editing this location.
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 AbstractLocationSpan)
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.
(Inherited from AbstractLocationSpan)
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. There must be a strict overlap, i.e., the intersection must be larger than LOCATION_EQUAL_TOLERANCE.
(Inherited from AbstractLocationSpan)
OverLaps(ILocationSpan, Double) Decides whether a location span overlaps the current locationSpan. If overlap is less than minOverlap, false is returned.
(Inherited from AbstractLocationSpan)
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 AbstractLocationSpan)
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.


(Inherited from AbstractLocationSpan)
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 AbstractLocationSpan)
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.
(Inherited from AbstractLocationSpan)
ToString Return string representation of XYZLocationSpan
(Overrides ObjectToString)

Fields

_id Unique string ID for this span
(Inherited from AbstractLocationSpan)
_intID Unique integer ID for this span
(Inherited from AbstractLocationSpan)

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