Class TLcyShapeObservationResult
- All Implemented Interfaces:
ILcdBounded
Domain object representing the result of a visibility calculation between a set of observers and an observed shape.
During the visibility calculations, certain settings are used for each observer and observee.
These settings are derived from the ILcyVisibilityCalculationPropertiesProvider
which is created in the add-on.
- Since:
- 2019.1
-
Method Summary
Modifier and TypeMethodDescriptionReturns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.Returns the result of the observation.Returns the object under observationReturns the altitude mode indicating how to interpret the Z-values of the observee shape.Returns a shape based on the shape that was created by theTLcyShapeVisibilityAddOn.createObserveeShapeProvider()
function for this observee, and which is used in the visibility calculations.Returns the list of observers
-
Method Details
-
getObservers
Returns the list of observers- Returns:
- the list of observers
-
getObservee
Returns the object under observation- Returns:
- the object under observation
-
getObserveeShape
Returns a shape based on the shape that was created by the
TLcyShapeVisibilityAddOn.createObserveeShapeProvider()
function for this observee, and which is used in the visibility calculations.The returned shape:
- is defined in the model reference of the model containing the observee.
- has Z-values that should be interpreted using
getObserveeCoverageAltitudeMode()
.
The returned shape should not be modified.
- Returns:
- the shape used in the visibility calculations for this observee
- Since:
- 2020.1
-
getObserveeCoverageAltitudeMode
Returns the altitude mode indicating how to interpret the Z-values of the observee shape. This altitude mode is determined by the
TLcyShapeVisibilityAddOn.createObserveeShapeProvider()
function.- Returns:
- the altitude mode for the observee shape.
- Since:
- 2020.1
- See Also:
-
getObservationResult
Returns the result of the observation.
As the calculations happen on a background thread, these results might not be available immediately. Each time a result gets updated, the model containing the result will fire a model change event.
- Returns:
- the result of the observation, or
null
when no results are available (yet). This can be because the result is still being calculated, or because errors happened during the calculation.
-
getBounds
Description copied from interface:ILcdBounded
Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an
undefined
bounds. You can create undefined bounds using the default constructors ofTLcdLonLatBounds
orTLcdXYBounds
.- Specified by:
getBounds
in interfaceILcdBounded
- Returns:
- the
ILcdBounds
by which the geometry of thisILcdBounded
object is bounded.
-