IXYZLocationSpan Interface |
A location span that is defined by a set of coordinates
Namespace: DHI.Mike1D.Generic
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IXYZLocationSpan type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Coordinates |
Coordinates of the location
|
| EndChainage |
End chainage value of location span (highest chainage number).
Unit: [m]
(Inherited from ILocationSpan.) |
| ID |
Identification name
(Inherited from ILocationSpan.) |
| StartChainage |
Start chainage value of location span (lowest chainage number).
Unit: [m]
(Inherited from ILocationSpan.) |
Methods| Name | Description | |
|---|---|---|
 | Clone |
Clone the base properties of the ILocationSpan.
(Inherited from ILocationSpan.) |
| 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 ILocationSpan.) |
| 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 ILocationSpan.) |
| 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 ILocationSpan.) |
| ContainsChainage(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 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 ILocationSpan.) |
| 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.
|
| Equals | Indicates whether the current object is equal to another object of the same type. (Inherited from IEquatableILocationSpan.) |
| GetEndLocation |
Gets the end location of the span. The span can not be edited by editing
this location.
|
| GetStartLocation |
Gets the start location of the span. The span can not be edited by editing
this location.
|
| 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 ILocationSpan.) |
| 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 ILocationSpan.) |
| OverLaps(ILocationSpan, Double) |
Decides whether a location span overlaps the current locationSpan. If overlap is less than
minOverlap, false is returned.
(Inherited from ILocationSpan.) |
| 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 ILocationSpan.) |
| 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. |
| 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 strictly contained inside the location span
(Inherited from ILocationSpan.) |
| 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 ILocationSpan.) |
Extension Methods| Name | Description | |
|---|---|---|
 | OverLap(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.) |
| OverLap(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.) |
See Also