mirror of
https://github.com/eclipse-sailing-analytics/sailing-analytics.git
synced 2026-10-08 21:30:57 +00:00
enhanced Javadoc and REST API doc for target time estimation
This commit is contained in:
1 parent
560eb61431
commit
a6fa795f1f
2 files changed
+13
-4
No files matched your search
@@ -774,10 +774,16 @@ public interface TrackedRace extends Serializable {
|
||||
boolean isUsingMarkPassingCalculator();
|
||||
|
||||
/**
|
||||
* @param timepoint Used for positions of marks and wind information
|
||||
* Calculates the estimated time it takes a competitor to sail the race, from start to finish.
|
||||
*
|
||||
* @param timepoint
|
||||
* Used for positions of marks and wind information; note that sometimes the marks are not in place yet
|
||||
* when the race starts and that a windward mark may be collected already before the race finishes.
|
||||
*
|
||||
* @return estimated time it takes to complete the race
|
||||
* @throws NotEnoughDataHasBeenAddedException thrown if not enough polar data has been added or polar data service
|
||||
* is not available
|
||||
*
|
||||
* @throws NotEnoughDataHasBeenAddedException
|
||||
* thrown if not enough polar data has been added or polar data service is not available
|
||||
* @throws NoWindException
|
||||
*/
|
||||
Duration getEstimatedTimeToComplete(TimePoint timepoint) throws NotEnoughDataHasBeenAddedException, NoWindException;
|
||||
|
||||
@@ -12,7 +12,10 @@
|
||||
<h2>URL: /api/v1/regattas/{regattaname}/races/{racename}/targettime</h2>
|
||||
|
||||
<b>Description:</b>
|
||||
<p>Gets the estimated target time of the race</p>
|
||||
<p>Gets the estimated time it will take to sail a race. The mark positions and the wind data are
|
||||
taken from the optional timeasmillis parameter which defaults to the current time. Note that sometimes the marks are not in place yet
|
||||
when the race starts and that a windward mark may be collected already before the race finishes.
|
||||
</p>
|
||||
<br/>
|
||||
<table>
|
||||
<tr>
|
||||
|
||||
Reference in new issue
Block a user