diff --git a/src/IllegalNameException.java b/OGP1718-Worms/src/IllegalNameException.java similarity index 100% rename from src/IllegalNameException.java rename to OGP1718-Worms/src/IllegalNameException.java diff --git a/src/Main.java b/OGP1718-Worms/src/Main.java similarity index 100% rename from src/Main.java rename to OGP1718-Worms/src/Main.java diff --git a/src/Tuple.java b/OGP1718-Worms/src/Tuple.java similarity index 100% rename from src/Tuple.java rename to OGP1718-Worms/src/Tuple.java diff --git a/src/Worm.java b/OGP1718-Worms/src/Worm.java similarity index 86% rename from src/Worm.java rename to OGP1718-Worms/src/Worm.java index abf37de..63a7eca 100644 --- a/src/Worm.java +++ b/OGP1718-Worms/src/Worm.java @@ -1,5 +1,14 @@ public class Worm { - +/** + * a class with the specifications of the worm + * + * @invar the location of the worm must be a valid location + * |... + * @invar + * + * @version 1.0 + * @author Arthur Bols and Leen Dereu + */ // region properties //=================================================================================== @@ -9,20 +18,39 @@ public class Worm { private Tuple location; private Tuple oldLocation; - // Orientation + /** + * this variable contains the orientation of the worm + */ private double orientation; - // shape + /** + * this variable contains the radius of the worm + */ private double radius; + + /** + * this variable contains the minimum value of the radius + */ private final double minRadius; - // mass + + /** + * this variable contains the mass of the worm + */ private double mass; - // points + /** + * this variable contains the current action points of the worm + */ private int points; + + /** + * this variable contains the maximum points a worm can have + */ private int maxPoints; - // name + /** + * this variable contains the name of the worm + */ private String name; //=================================================================================== @@ -86,6 +114,13 @@ public class Worm { return this.location; } + /** + * sets the location of the worm to the given location + * + * @param location + * + * @throws IllegalArgumentException + */ private void setLocation(Tuple location) throws IllegalArgumentException { if (location.equals(null)) @@ -101,14 +136,25 @@ public class Worm { //=================================================================================== /** + * set the orientation of the worm to the given orientation + * * @param orientation - * | ... - * + * the new orientation of the worm + * @pre the given orientation must be a valid orientation for any worm + * |isValidOrientation(orientation) + * @post the new orientation of the worm must be equal to the given orientation + * |new.getOrientation() == orientation */ public void setOrientation(double orientation) { this.orientation = orientation; } + + /** + * Return the orientation of the worm + * + */ + @Basic public double getOrientation() { return orientation; } @@ -121,11 +167,20 @@ public class Worm { // region Shape mass/radius //=================================================================================== - + + /** + * @return the radius of the worm + */ + @Basic public double getRadius() { return this.radius; } + /** + * + * @param radius + * @throws IllegalArgumentException + */ public void setRadius(double radius) throws IllegalArgumentException { if (radius < this.minRadius) throw new IllegalArgumentException("Radius is smaller than " + this.minRadius); diff --git a/docs/samenvatting.md b/docs/samenvatting.md index 47581da..fdb5239 100644 --- a/docs/samenvatting.md +++ b/docs/samenvatting.md @@ -36,7 +36,7 @@ ### orientation orientation hoek theta (radialen) - rechts: 0 boven: pi/2 + rechts: th0 boven: pi/2 nominaal 0..2pi