Added javadoc to classes.

#story[1097]
main
zwu18 8 years ago
parent 03713d3699
commit 9c902dab46

@ -6,12 +6,17 @@ import mock.model.VMG;
import shared.model.Bearing; import shared.model.Bearing;
/** /**
* Created by David on 2/08/2017. * Command class for tacking and gybing
*/ */
public class TackGybeCommand implements Command { public class TackGybeCommand implements Command {
private MockRace race; private MockRace race;
private MockBoat boat; private MockBoat boat;
/**
* Constructor for class
* @param race mock race
* @param boat mock boat to update
*/
public TackGybeCommand(MockRace race, MockBoat boat) { public TackGybeCommand(MockRace race, MockBoat boat) {
this.race = race; this.race = race;
this.boat = boat; this.boat = boat;
@ -39,6 +44,12 @@ public class TackGybeCommand implements Command {
} }
} }
/**
* Method to calculate smallest angle between 2 angles
* @param degreeA first angle degree
* @param degreeB second angle degree
* @return the calculated smallest angle
*/
public double calcDistance(double degreeA, double degreeB){ public double calcDistance(double degreeA, double degreeB){
double phi = Math.abs(degreeB - degreeA) % 360; double phi = Math.abs(degreeB - degreeA) % 360;
double distance = phi > 180 ? 360 - phi : phi; double distance = phi > 180 ? 360 - phi : phi;

@ -4,12 +4,17 @@ import mock.model.MockBoat;
import mock.model.MockRace; import mock.model.MockRace;
/** /**
* Created by David on 2/08/2017. * Command class for autoVMG
*/ */
public class VMGCommand implements Command { public class VMGCommand implements Command {
private MockRace race; private MockRace race;
private MockBoat boat; private MockBoat boat;
/**
* Constructor for class
* @param race mock race
* @param boat mock boat to update
*/
public VMGCommand(MockRace race, MockBoat boat) { public VMGCommand(MockRace race, MockBoat boat) {
this.race = race; this.race = race;
this.boat = boat; this.boat = boat;

Loading…
Cancel
Save