diff --git a/java/com.sap.sailing.domain/src/com/sap/sailing/domain/tracking/TrackedRace.java b/java/com.sap.sailing.domain/src/com/sap/sailing/domain/tracking/TrackedRace.java index ccf7e3f9ddb..8760213dcf2 100755 --- a/java/com.sap.sailing.domain/src/com/sap/sailing/domain/tracking/TrackedRace.java +++ b/java/com.sap.sailing.domain/src/com/sap/sailing/domain/tracking/TrackedRace.java @@ -774,11 +774,17 @@ 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 NoWindException + * + * @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; diff --git a/java/com.sap.sailing.server.gateway/webservices/api/v1/raceTargetTimeGetDoc.html b/java/com.sap.sailing.server.gateway/webservices/api/v1/raceTargetTimeGetDoc.html index 6b169ee36b4..bffb325559e 100644 --- a/java/com.sap.sailing.server.gateway/webservices/api/v1/raceTargetTimeGetDoc.html +++ b/java/com.sap.sailing.server.gateway/webservices/api/v1/raceTargetTimeGetDoc.html @@ -12,7 +12,10 @@
Gets the estimated target time of the race
+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. +