Merge branch 'develop' into 1124_Mark_Sequence_From_RaceXML

# Conflicts:
#	src/main/java/seng302/gameServer/GameState.java
#	src/main/java/seng302/gameServer/server/simulator/Simulator.java
#	src/main/java/seng302/models/mark/Mark.java
#	src/main/java/seng302/visualiser/map/CanvasMap.java

src/main/java/seng302/gameServer/server/messages/BoatActionMessage.java

@@ -0,0 +1,29 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * Created by kre39 on 12/07/17.
+ */
+public class BoatActionMessage extends Message{
+    private final MessageType MESSAGE_TYPE = MessageType.BOAT_ACTION;
+    private final int MESSAGE_SIZE = 1;
+    private BoatActionType actionType;
+
+    public BoatActionMessage(BoatActionType actionType) {
+        this.actionType = actionType;
+        setHeader(new Header(MessageType.BOAT_ACTION, 0, (short) 1)); // the second variable is the source id
+        allocateBuffer();
+        writeHeaderToBuffer();
+        // Write message fields
+        putInt(actionType.getValue(), 1);
+        writeCRC();
+        rewind();
+
+    }
+
+    @Override
+    public int getSize() {
+        return MESSAGE_SIZE;
+    }
+
+
+}

src/main/java/seng302/gameServer/server/messages/BoatActionType.java

@@ -0,0 +1,38 @@
+package seng302.gameServer.server.messages;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Created by kre39 on 12/07/17.
+ */
+public enum BoatActionType {
+
+    VMG(1),
+    SAILS_IN(2),
+    SAILS_OUT(3),
+    TACK_GYBE(4),
+    UPWIND(5),
+    DOWNWIND(6);
+
+    private final int type;
+    private static final Map<Integer, BoatActionType> intToTypeMap = new HashMap<>();
+
+    static {
+        for (BoatActionType type : BoatActionType.values()) {
+            intToTypeMap.put(type.getValue(), type);
+        }
+    }
+
+    BoatActionType(int type){
+        this.type = type;
+    }
+
+    public static BoatActionType getType(int value) {
+        return intToTypeMap.get(value);
+    }
+
+    public int getValue() {
+        return this.type;
+    }
+}

src/main/java/seng302/gameServer/server/messages/BoatLocationMessage.java

@@ -0,0 +1,153 @@
+package seng302.gameServer.server.messages;
+
+public class BoatLocationMessage extends Message {
+    private final int MESSAGE_SIZE = 56;
+
+    private long messageVersionNumber;
+    private long time;
+    private long sourceId;
+    private long sequenceNum;
+    private DeviceType deviceType;
+    private double latitude;
+    private double longitude;
+    private long altitude;
+    private Double heading;
+    private long pitch;
+    private long roll;
+    private long boatSpeed;
+    private long COG;
+    private long SOG;
+    private long apparentWindSpeed;
+    private long apparentWindAngle;
+    private long trueWindSpeed;
+    private long trueWindDirection;
+    private long trueWindAngle;
+    private long currentDrift;
+    private long currentSet;
+    private long rudderAngle;
+
+    /**
+     * Describes the location, altitude and sensor data from the boat.
+     * @param sourceId ID of the boat
+     * @param sequenceNum Sequence number of the message
+     * @param latitude The boats latitude
+     * @param longitude The boats longitude
+     * @param heading The boats heading
+     * @param boatSpeed The boats speed
+     */
+    public BoatLocationMessage(int sourceId, int sequenceNum, double latitude, double longitude, double heading, long boatSpeed){
+        messageVersionNumber = 1;
+        time = System.currentTimeMillis();
+        this.sourceId = sourceId;
+        this.sequenceNum = sequenceNum;
+        this.deviceType = DeviceType.RACING_YACHT;
+        this.latitude = latitude;
+        this.longitude = longitude;
+        this.altitude = 0;
+        this.heading = heading;
+        this.pitch = 0;
+        this.roll = 0;
+        this.boatSpeed = boatSpeed;
+        this.COG = 2;
+        this.SOG = boatSpeed ;
+        this.apparentWindSpeed = 0;
+        this.apparentWindAngle = 0;
+        this.trueWindSpeed = 0;
+        this.trueWindDirection = 0;
+        this.trueWindAngle = 0;
+        this.currentDrift = 0;
+        this.currentSet = 0;
+        this.rudderAngle = 0;
+
+        setHeader(new Header(MessageType.BOAT_LOCATION, 1, (short) getSize()));
+        allocateBuffer();
+        writeHeaderToBuffer();
+
+        long headingToSend = (long)((heading/360.0) * 65535.0);
+
+        putByte((byte) messageVersionNumber);
+        putInt(time, 6);
+        putInt((int) sourceId, 4);
+        putUnsignedInt((int) sequenceNum, 4);
+        putByte((byte) deviceType.getCode());
+        putInt((int) latLonToBinaryPackedLong(latitude), 4);
+        putInt((int) latLonToBinaryPackedLong(longitude), 4);
+        putInt((int) altitude, 4);
+        putInt(headingToSend, 2);
+        putInt((int) pitch, 2);
+        putInt((int) roll, 2);
+        putInt((int) boatSpeed, 2);
+        putUnsignedInt((int) COG, 2);
+        putUnsignedInt((int) SOG, 2);
+        putUnsignedInt((int) apparentWindSpeed, 2);
+        putInt((int) apparentWindAngle, 2);
+        putUnsignedInt((int) trueWindSpeed, 2);
+        putUnsignedInt((int) trueWindDirection, 2);
+        putInt((int) trueWindAngle, 2);
+        putUnsignedInt((int) currentDrift, 2);
+        putUnsignedInt((int) currentSet, 2);
+        putInt((int) rudderAngle, 2);
+
+        writeCRC();
+        rewind();
+    }
+
+    /**
+     * Convert binary latitude or longitude to floating point number
+     * @param binaryPackedLatLon Binary packed lat OR lon
+     * @return Floating point lat/lon
+     */
+    public static double binaryPackedToLatLon(long binaryPackedLatLon){
+        return (double)binaryPackedLatLon * 180.0 / 2147483648.0;
+    }
+
+    /**
+     * Convert binary packed heading to floating point number
+     * @param binaryPackedHeading Binary packed heading
+     * @return heading as a decimal
+     */
+    public static double binaryPackedHeadingToDouble(long binaryPackedHeading){
+        return (double)binaryPackedHeading * 360.0 / 65536.0;
+    }
+
+    /**
+     * Convert binary packed wind angle to floating point number
+     * @param binaryPackedWindAngle Binary packed wind angle
+     * @return wind angle as a decimal
+     */
+    public static double binaryPackedWindAngleToDouble(long binaryPackedWindAngle){
+        return (double)binaryPackedWindAngle*180.0/32768.0;
+    }
+
+    /**
+     * Convert a latitude or longitude to a binary packed long
+     * @param latLon A floating point latitude/longitude
+     * @return A binary packed lat/lon
+     */
+    public static long latLonToBinaryPackedLong(double latLon){
+        return (long)((536870912 * latLon) / 45);
+    }
+
+    /**
+     * Convert a heading to a binary packed long
+     * @param heading A floating point heading
+     * @return A binary packed heading
+     */
+    public static long headingToBinaryPackedLong(double heading){
+        return (long)((8192*heading)/45);
+    }
+
+    /**
+     * Convert a wind angle to a binary packed long
+     * @param windAngle Floating point wind angle
+     * @return A binary packed wind angle
+     */
+    public static long windAngleToBinaryPackedLong(double windAngle){
+        return (long)((8192*windAngle)/45);
+    }
+
+    @Override
+    public int getSize() {
+        return MESSAGE_SIZE;
+    }
+}

src/main/java/seng302/gameServer/server/messages/BoatStatus.java

@@ -0,0 +1,25 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * The current status of a boat
+ */
+public enum BoatStatus {
+    UNDEFINED(0),
+    PRESTART(1),
+    RACING(2),
+    FINISHED(3),
+    DNS(4),
+    DNF(5),
+    DSQ(6),
+    CS(7);
+
+    private long code;
+
+    BoatStatus(long code) {
+        this.code = code;
+    }
+
+    public long getCode(){
+        return code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/BoatSubMessage.java

@@ -0,0 +1,85 @@
+package seng302.gameServer.server.messages;
+
+import java.nio.ByteBuffer;
+
+/**
+ * The status of each boat, sent within a race status message
+ */
+public class BoatSubMessage{
+    private final int MESSAGE_SIZE = 20;
+
+    private long sourceId;
+    private BoatStatus boatStatus;
+    private long legNumber;
+    private long numberPenaltiesAwarded;
+    private long numberPenaltiesServed;
+    private long estimatedTimeAtNextMark;
+    private long estimatedTimeAtFinish;
+    private ByteBuffer buff = ByteBuffer.allocate(getSize());
+    private int buffPos = 0;
+
+    /**
+     * Boat Sub message from section 4.2 of the AC35 streaming data interface spec
+     * @param sourceId The source ID of the boat
+     * @param boatStatus The boats status
+     * @param legNumber The leg the boat is on (0= prestart, 1=start to first mark etc)
+     * @param numberPenaltiesAwarded The number of penalties awarded to the boat
+     * @param numberPenaltiesServed The number of penalties served to the boat
+     * @param estimatedTimeAtFinish The estimated time (UTC) the boat will finish the race
+     * @param estimatedTimeAtNextMark The estimated time (UTC) the boat will arrive at the next mark
+     */
+    public BoatSubMessage(long sourceId, BoatStatus boatStatus, long legNumber, long numberPenaltiesAwarded, long numberPenaltiesServed,
+                   long estimatedTimeAtFinish, long estimatedTimeAtNextMark){
+        this.sourceId = sourceId;
+        this.boatStatus = boatStatus;
+        this.legNumber = legNumber;
+        this.numberPenaltiesAwarded = numberPenaltiesAwarded;
+        this.numberPenaltiesServed = numberPenaltiesServed;
+        this.estimatedTimeAtFinish = estimatedTimeAtFinish;
+        this.estimatedTimeAtNextMark = estimatedTimeAtNextMark;
+    }
+
+    /**
+     * @return The size of this message in bytes
+     */
+    public int getSize(){
+        return MESSAGE_SIZE;
+    }
+
+    private void putInBuffer(byte[] bytes, long val){
+        byte[] tmp = bytes.clone();
+        Message.reverse(tmp);
+
+        buff.put(tmp);
+        buffPos += tmp.length;
+        buff.position(buffPos);
+    }
+
+    /**
+     * @return a ByteBuffer containing this boat status message
+     */
+    public ByteBuffer getByteBuffer(){
+        // Source ID, 4 bytes
+        putInBuffer(Message.intToByteArray(sourceId, 4), 4);
+
+        // Boat Status, 1 byte
+        putInBuffer(ByteBuffer.allocate(1).put((byte) (boatStatus.getCode() & 0xff)).array(), 1);
+
+        // Leg number, 1 byte
+        putInBuffer(ByteBuffer.allocate(1).put((byte) (legNumber & 0xff)).array(), 1);
+
+        // Number of penalties awarded, 1 byte
+        putInBuffer(ByteBuffer.allocate(1).put((byte) (numberPenaltiesAwarded & 0xff)).array(), 1);
+
+        // Number of penalties served, 1 byte
+        putInBuffer(ByteBuffer.allocate(1).put((byte) (numberPenaltiesServed & 0xff)).array(), 1);
+
+        // Estimated time at next mark, 6 bytes
+        putInBuffer(Message.intToByteArray((int) estimatedTimeAtNextMark, 6),6);
+
+        // Estimated time at finish, 6 bytes
+        putInBuffer(Message.intToByteArray((int) estimatedTimeAtFinish, 6), 6);
+
+        return buff;
+    }
+}

src/main/java/seng302/gameServer/server/messages/ChatterMessage.java

@@ -0,0 +1,38 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * Created by kre39 on 20/07/17.
+ */
+public class ChatterMessage extends Message {
+
+    private final long MESSAGE_VERSION_NUMBER = 1;
+    private final int MESSAGE_SIZE = 3;
+    private int message_type;
+    private int message_size = 21;
+    private String message;
+
+    public ChatterMessage(int message_type, int message_size, String message) {
+        this.message_type = message_type;
+        this.message_size = message_size;
+        this.message = message;
+
+        setHeader(new Header(MessageType.CHATTER_TEXT, 1, (short) getSize()));
+        allocateBuffer();
+        writeHeaderToBuffer();
+
+        putByte((byte) MESSAGE_VERSION_NUMBER);
+        putInt(message_type, 1);
+        putInt(message_size, 1);
+        putBytes(message.getBytes());
+
+        writeCRC();
+        rewind();
+    }
+
+    @Override
+    public int getSize() {
+        return MESSAGE_SIZE + message_size;
+    }
+
+
+}

src/main/java/seng302/gameServer/server/messages/DeviceType.java

@@ -0,0 +1,16 @@
+package seng302.gameServer.server.messages;
+
+public enum DeviceType {
+    UNKNOWN(0),
+    RACING_YACHT(1);
+
+    private long code;
+
+    DeviceType(long code) {
+        this.code = code;
+    }
+
+    public long getCode(){
+        return code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/Header.java

@@ -0,0 +1,80 @@
+package seng302.gameServer.server.messages;
+
+import java.nio.ByteBuffer;
+
+public class Header {
+    // From API spec
+    private final int syncByte1 = 0x47;
+    private final int syncByte2 = 0x83;
+
+    private MessageType messageType;
+    private int timeStamp;
+    private int sourceId;
+    private short messageLength;
+    private static final int MESSAGE_LEN = 15;
+    private ByteBuffer buff;
+    private int buffPos;
+
+    /**
+     * Message Header from section 3.2 of the AC35 Streaming
+     * Data spec
+     * @param messageType The type of the message following this header
+     * @param sourceId The message source (as defined in the spec)
+     * @param messageLength The length of the message following this header
+     */
+    public Header(MessageType messageType, int sourceId, Short messageLength){
+        this.messageType = messageType;
+        this.sourceId = sourceId;
+        this.messageLength = messageLength;
+        timeStamp = (int) (System.currentTimeMillis() / 1000L);
+        buff = ByteBuffer.allocate(MESSAGE_LEN);
+        buffPos = 0;
+    }
+
+    private void putInBuffer(byte[] bytes, long val){
+        byte[] tmp = bytes.clone();
+        Message.reverse(tmp);
+
+        buff.put(tmp);
+        buffPos += tmp.length;
+        buff.position(buffPos);
+    }
+
+    /**
+     * Reset the buffer
+     */
+    public void reset(){
+        buffPos = 0;
+        buff.clear();
+        buff.position(buffPos);
+    }
+
+    /**
+     * @return a ByteBuffer containing the message header
+     */
+    public ByteBuffer getByteBuffer(){
+        reset();
+
+        putInBuffer(ByteBuffer.allocate(1).put((byte)syncByte1).array(), syncByte1);
+
+        putInBuffer(ByteBuffer.allocate(1).put((byte)syncByte2).array(), syncByte2);
+
+        putInBuffer(ByteBuffer.allocate(1).put((byte)messageType.getCode()).array(), messageType.getCode());
+
+        putInBuffer(Message.intToByteArray(timeStamp, 6), timeStamp);
+
+        putInBuffer(Message.intToByteArray(sourceId, 4), sourceId);
+
+        putInBuffer(Message.intToByteArray(messageLength, 2), messageLength);
+
+        return buff;
+    }
+
+    /**
+     * Returns the size of this message
+     * @return the size of the message
+     */
+    public static Integer getSize(){
+        return MESSAGE_LEN;
+    }
+}

src/main/java/seng302/gameServer/server/messages/Heartbeat.java

@@ -0,0 +1,27 @@
+package seng302.gameServer.server.messages;
+
+public class Heartbeat extends Message {
+    private final int MESSAGE_SIZE = 4;
+
+    /**
+     * Heartbeat from the AC35 Streaming data spec
+     * @param seqNo Increment every time a message is sent
+     */
+    public Heartbeat(int seqNo){
+        setHeader(new Header(MessageType.HEARTBEAT, 0x01, (short) getSize()));
+
+        allocateBuffer();
+        writeHeaderToBuffer();
+
+        putUnsignedInt(seqNo, 4);
+
+        writeCRC();
+        rewind();
+    }
+
+    @Override
+    public int getSize() {
+        return MESSAGE_SIZE;
+    }
+
+}

src/main/java/seng302/gameServer/server/messages/MarkRoundingMessage.java

@@ -0,0 +1,57 @@
+package seng302.gameServer.server.messages;
+
+public class MarkRoundingMessage extends Message{
+    private final long MESSAGE_VERSION_NUMBER = 1;
+    private final int MESSAGE_SIZE = 21;
+
+    private long time;
+    private long ackNumber;
+    private long raceId;
+    private long sourceId;
+    private RoundingBoatStatus boatStatus;
+    private RoundingSide roundingSide;
+    private long markId;
+
+
+    /**
+     * This message is sent when a boat passes a mark, start line, or finish line
+     * The purpose of this is to record the time when yachts cross marks
+     * @param ackNumber ackNumber
+     * @param raceId raceId
+     * @param sourceId sourceId
+     * @param roundingBoatStatus roundingBoatStatus
+     * @param roundingSide roundingSide
+     * @param markId markId
+     */
+    public MarkRoundingMessage(int ackNumber, int raceId, int sourceId, RoundingBoatStatus roundingBoatStatus,
+                               RoundingSide roundingSide, int markId){
+        this.time = System.currentTimeMillis() / 1000L;
+        this.ackNumber = ackNumber;
+        this.raceId = raceId;
+        this.sourceId = sourceId;
+        this.boatStatus = roundingBoatStatus;
+        this.roundingSide = roundingSide;
+        this.markId = markId;
+
+        setHeader(new Header(MessageType.MARK_ROUNDING, 1, (short) getSize()));
+        allocateBuffer();
+        writeHeaderToBuffer();
+
+        putByte((byte) MESSAGE_VERSION_NUMBER);
+        putInt((int) time, 6);
+        putInt((int) ackNumber, 2);
+        putInt((int) raceId, 4);
+        putInt((int) sourceId, 4);
+        putByte((byte) boatStatus.getCode());
+        putByte((byte) roundingSide.getCode());
+        putByte((byte) markId);
+
+        writeCRC();
+        rewind();
+    }
+
+    @Override
+    public int getSize() {
+        return MESSAGE_SIZE;
+    }
+}

src/main/java/seng302/gameServer/server/messages/MarkType.java

@@ -0,0 +1,20 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * Types of marks boats can round
+ */
+public enum MarkType {
+    UNKNOWN(0),
+    ROUNDING_MARK(1),
+    GATE(2);
+
+    private long code;
+
+    MarkType(long code) {
+        this.code = code;
+    }
+
+    public long getCode(){
+        return code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/Message.java

@@ -0,0 +1,221 @@
+package seng302.gameServer.server.messages;
+
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
+import java.util.Arrays;
+import java.util.zip.CRC32;
+
+public abstract class Message {
+    private final int CRC_SIZE = 4;
+    private Header header;
+    private ByteBuffer buffer;
+    private int bufferPosition;
+    private CRC32 crc;
+
+    /**
+     * @param header Set the header for this message
+     */
+    void setHeader(Header header){
+        this.header = header;
+    }
+
+    /**
+     * @return the header specified for this message
+     */
+    Header getHeader(){
+        return header;
+    }
+
+    /**
+     * @return the size of the message
+     */
+    public abstract int getSize();
+
+    /**
+     * Allocate byte buffer to correct size
+     */
+    void allocateBuffer(){
+        buffer = ByteBuffer.allocate(Header.getSize() + getSize() + CRC_SIZE);
+        buffer.order(ByteOrder.LITTLE_ENDIAN);
+        bufferPosition = 0;
+        buffer.position(bufferPosition);
+    }
+
+    /**
+     * Write the set header to the byte buffer
+     */
+    void writeHeaderToBuffer(){
+        buffer.put(getHeader().getByteBuffer().array());
+        bufferPosition += Header.getSize();
+        buffer.position(bufferPosition);
+    }
+
+    /**
+     * Move the buffer position by n bytes
+     * @param size Number of bytes to move the buffer by
+     */
+    private void moveBufferPositionBy(int size){
+        bufferPosition += size;
+        buffer.position(bufferPosition);
+    }
+
+    /**
+     * Put an unsigned byte in the buffer
+     */
+    void putUnsignedByte(byte b){
+        buffer.put(ByteBuffer.allocate(1).put((byte) (b & 0xff)).array());
+        moveBufferPositionBy(1);
+    }
+
+    /**
+     * Put an signed byte in the buffer
+     */
+    void putByte(byte b){
+        buffer.put(ByteBuffer.allocate(1).put(b).array());
+        moveBufferPositionBy(1);
+    }
+
+    /**
+     * Place an unsigned integer of the specified length in the buffer
+     * @param val The integer value to add (Note: This must be long due to java not supporting unsigned integers)
+     * @param size The size of the int to be added to the buffer
+     */
+    void putUnsignedInt(long val, int size){
+        if (size <= 1){
+            putUnsignedByte((byte) val);
+
+        }
+        else if (size < 4){
+            // Use short
+            byte[] tmp =  Message.intToByteArray(val, size); //ByteBuffer.allocate(size).putShort((short) (val & 0xffff)).array();
+            reverse(tmp);
+            buffer.put(tmp);
+            moveBufferPositionBy(size);
+        }
+        else{
+            // Use int
+            byte[] tmp = Message.intToByteArray(val, size);
+            reverse(tmp);
+            moveBufferPositionBy(size);
+        }
+    }
+
+    /**
+     * Put a signed int of a specified length in the buffer
+     * @param val The integer value to add
+     * @param size The size of the integer to be added to the buffer
+     */
+    void putInt(long val, int size){
+        if (size < 4){
+            byte[] tmp = Message.intToByteArray(val, size);
+            reverse(tmp);
+            buffer.put(tmp);
+        }
+        else{
+            byte[] tmp = Message.intToByteArray(val, size);
+            reverse(tmp);
+            buffer.put(tmp);
+        }
+        moveBufferPositionBy(size);
+    }
+
+    /**
+     * Write an array of bytes to the buffer
+     * @param bytes to write
+     */
+    void putBytes(byte[] bytes){
+        buffer.put(bytes);
+        moveBufferPositionBy(bytes.length);
+    }
+
+    /**
+     * Write a ByteBuffer of bytes to the buffer
+     * @param bytes to write
+     * @param size number of bytes
+     */
+    void putBytes(ByteBuffer bytes, int size){
+        buffer.put(bytes.array());
+        moveBufferPositionBy(size);
+    }
+
+
+    /**
+     * Calculate the CRC of the buffer and append it to the end of the buffer
+     */
+    void writeCRC(){
+        crc = new CRC32();
+
+        buffer.position(0);
+
+        byte[] data = Arrays.copyOfRange(buffer.array(), 0, buffer.array().length-CRC_SIZE);
+        crc.update(data);
+        buffer.position(bufferPosition);
+
+        putInt((int) crc.getValue(), CRC_SIZE);
+    }
+
+    /**
+     * @return The current buffer as a byte array
+     */
+    public byte[] getBuffer(){
+        return buffer.array();
+    }
+
+    /**
+     * Rewind the buffer to the beginning
+     */
+    void rewind(){
+        buffer.flip();
+    }
+
+    /**
+     * Convert an integer to an array of bytes
+     * @param val The value to add
+     * @param len The width of the integer in the buffer
+     * @return A byte array to be sent
+     */
+    public static byte[] intToByteArray(long val, int len){
+        int index = 0;
+        byte[] data = new byte[len];
+
+        for (int i = 0; i < len; i++){
+            data[len - index - 1] = (byte) (val & 0xFF);
+            val >>>= 8;
+            index++;
+        }
+
+        return data;
+    }
+
+    /**
+     * takes an array of up to 7 bytes in little endian format and
+     * returns a positive long constructed from the input bytes
+     *
+     * @param bytes the bytes to be converted to long
+     * @return a positive long if there is less than 8 bytes -1 otherwise
+     */
+    public static long bytesToLong(byte[] bytes){
+        long partialLong = 0;
+        int index = 0;
+        for (byte b: bytes){
+            if (index > 6){
+                return -1;
+            }
+            partialLong = partialLong | (b & 0xFFL) << (index * 8);
+            index++;
+        }
+        return partialLong;
+    }
+
+    /**
+     * Reverse an array of bytes
+     * @param data The byte[] to reverse
+     */
+    public static void reverse(byte[] data) {
+        for (int left = 0, right = data.length - 1; left < right; left++, right--) {
+            byte temp = (byte) (data[left] & 0xff);
+            data[left]  = (byte) (data[right] & 0xff);
+            data[right] = (byte) (temp & 0xff);
+        }
+    }
+}

src/main/java/seng302/gameServer/server/messages/MessageType.java

@@ -0,0 +1,35 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * Enum containing the types of messages
+ * sent by the server
+ */
+public enum MessageType {
+    HEARTBEAT(1),
+    RACE_STATUS(12),
+    DISPLAY_TEXT_MESSAGE(20),
+    XML_MESSAGE(26),
+    RACE_START_STATUS(27),
+    YACHT_EVENT_CODE(29),
+    YACHT_ACTION_CODE(31),
+    CHATTER_TEXT(36),
+    BOAT_LOCATION(37),
+    MARK_ROUNDING(38),
+    COURSE_WIND(44),
+    AVERAGE_WIND(47),
+    BOAT_ACTION(100);
+
+    private int code;
+
+    MessageType(int code){
+        this.code = code;
+    }
+
+    /**
+     * Get the message code (From the API Spec)
+     * @return the message code
+     */
+    int getCode(){
+        return this.code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/RaceStartNotificationType.java

@@ -0,0 +1,21 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * The types of race start status messages
+ */
+public enum RaceStartNotificationType {
+    SET_RACE_START_TIME(1),
+    RACE_POSTPONED(2),
+    RACE_ABANDONED(3),
+    RACE_TERMINATED(4);
+
+    private final long type;
+
+    RaceStartNotificationType(long type) {
+        this.type = type;
+    }
+
+    long getType(){
+        return type;
+    }
+}

src/main/java/seng302/gameServer/server/messages/RaceStartStatusMessage.java

@@ -0,0 +1,48 @@
+package seng302.gameServer.server.messages;
+
+public class RaceStartStatusMessage extends Message {
+    private final int MESSAGE_SIZE = 20;
+
+    private long version;
+    private long timeStamp;
+    private long ackNumber;
+    private long raceStartTime;
+    private long raceId;
+    private RaceStartNotificationType notificationType;
+
+    /**
+     * Message sent to clients with the expected start time of the race
+     * @param ackNumber  Sequence number of message.
+     * @param raceStartTime Expected race start time
+     * @param raceId Race ID#
+     * @param notificationType Type of this notification
+     */
+    public RaceStartStatusMessage(long ackNumber, long raceStartTime, long raceId, RaceStartNotificationType notificationType){
+        this.version = 1;
+        this.timeStamp = System.currentTimeMillis() / 1000L;
+        this.ackNumber = ackNumber;
+        this.raceStartTime = raceStartTime;
+        this.notificationType = notificationType;
+        this.raceId = raceId;
+
+        setHeader(new Header(MessageType.RACE_START_STATUS, 1, (short) getSize()));
+        allocateBuffer();
+        writeHeaderToBuffer();
+
+        putUnsignedByte((byte) version);
+        putInt((int) timeStamp, 6);
+        putInt((int) ackNumber, 2);
+        putInt((int) raceStartTime, 6);
+        putInt((int) raceId, 4);
+        putUnsignedByte((byte) notificationType.getType());
+
+        writeCRC();
+        rewind();
+    }
+
+    @Override
+    public int getSize() {
+        return MESSAGE_SIZE;
+    }
+
+}

src/main/java/seng302/gameServer/server/messages/RaceStatus.java

@@ -0,0 +1,26 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * The current status of the race
+ */
+public enum RaceStatus {
+    NOTACTIVE(0),
+    WARNING(1), // Between 3:00 and 1:00 before start
+    PREPARATORY(2), // Less than 1:00 before start
+    STARTED(3),
+    ABANDONED(6),
+    POSTPONED(7),
+    TERMINATED(8),
+    RACE_START_TIME_NOT_SET(9),
+    PRESTART(10); // More than 3:00 before start
+
+    private int code;
+
+    RaceStatus(int code){
+        this.code = code;
+    }
+
+    public int getCode(){
+        return this.code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/RaceStatusMessage.java

@@ -0,0 +1,79 @@
+package seng302.gameServer.server.messages;
+
+import java.util.List;
+import java.util.zip.CRC32;
+
+public class RaceStatusMessage extends Message{
+    private final MessageType MESSAGE_TYPE = MessageType.RACE_STATUS;
+    private final int MESSAGE_VERSION = 2; //Always set to 1
+    private final int MESSAGE_BASE_SIZE = 24;
+    private final double windDirFactor = 0x4000 / 90;
+
+
+    private long currentTime;
+    private long raceId;
+    private RaceStatus raceStatus;
+    private long expectedStartTime;
+    private double raceWindDirection;
+    private long windSpeed;
+    private long numBoatsInRace;
+    private RaceType raceType;
+    private List<BoatSubMessage> boats;
+    private CRC32 crc;
+
+    /**
+     * A message containing the current status of the race
+     * @param raceId The ID of the current race
+     * @param raceStatus The status of the race
+     * @param expectedStartTime The expected start time
+     * @param raceWindDirection The wind direction (north, east, south)
+     * @param windSpeed The wind speed in mm/sec
+     * @param numBoatsInRace The number of boats in the race
+     * @param raceType The race type (Match/fleet)
+     * @param sourceId The source of this message
+     * @param boats A list of boat status sub messages
+     */
+    public RaceStatusMessage(long raceId, RaceStatus raceStatus, long expectedStartTime, double raceWindDirection,
+                             long windSpeed, long numBoatsInRace, RaceType raceType, long sourceId, List<BoatSubMessage> boats){
+        currentTime = System.currentTimeMillis();
+        this.raceId = raceId;
+        this.raceStatus = raceStatus;
+        this.expectedStartTime = expectedStartTime;
+        this.raceWindDirection = raceWindDirection * windDirFactor;
+        this.windSpeed = windSpeed;
+        this.numBoatsInRace = numBoatsInRace;
+        this.raceType = raceType;
+        this.boats = boats;
+        crc = new CRC32();
+
+        setHeader(new Header(MESSAGE_TYPE, (int) sourceId, (short) getSize()));
+        allocateBuffer();
+        writeHeaderToBuffer();
+
+        putByte((byte) MESSAGE_VERSION);
+        putInt(currentTime, 6);
+        putInt((int) raceId, 4);
+        putByte((byte) raceStatus.getCode());
+        putInt(expectedStartTime, 6);
+        putInt((int) this.raceWindDirection, 2);
+        putInt((int) windSpeed, 2);
+        putByte((byte) numBoatsInRace);
+        putByte((byte) raceType.getCode());
+
+        for (BoatSubMessage boatSubMessage : boats){
+            putBytes(boatSubMessage.getByteBuffer(), boatSubMessage.getSize());
+        }
+
+        writeCRC();
+        rewind();
+    }
+
+    /**
+     * @return the size of this message in bytes
+     */
+    @Override
+    public int getSize() {
+        return MESSAGE_BASE_SIZE + (20 * ((int) numBoatsInRace));
+    }
+
+}

src/main/java/seng302/gameServer/server/messages/RaceType.java

@@ -0,0 +1,20 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * Enum containing the types of races
+ * sent by the server
+ */
+public enum RaceType {
+    MATCH_RACE(1),
+    FLEET_RACE(2);
+
+    private long code;
+
+    RaceType(long code){
+        this.code = code;
+    }
+
+    public long getCode(){
+        return code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/RoundingBoatStatus.java

@@ -0,0 +1,21 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * The status of a boat rounding a mark
+ */
+public enum RoundingBoatStatus {
+    UNKNOWN(0),
+    RACING(1),
+    DSQ(2),
+    WITHDRAWN(3);
+
+    private long code;
+
+    RoundingBoatStatus(long code) {
+        this.code = code;
+    }
+
+    public long getCode(){
+        return code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/RoundingSide.java

@@ -0,0 +1,20 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * The side the boat rounded the mark
+ */
+public enum RoundingSide {
+    UNKNOWN(0),
+    PORT(1),
+    STARBOARD(2);
+
+    private long code;
+
+    RoundingSide(long code) {
+        this.code = code;
+    }
+
+    public long getCode(){
+        return code;
+    }
+}

src/main/java/seng302/gameServer/server/messages/XMLMessage.java

@@ -0,0 +1,53 @@
+package seng302.gameServer.server.messages;
+
+public class XMLMessage extends Message{
+    private final MessageType MESSAGE_TYPE = MessageType.XML_MESSAGE;
+    private final int MESSAGE_VERSION = 1; //Always set to 1
+    private final int MESSAGE_SIZE = 14;
+
+    // Message fields
+    private long timeStamp;
+    private long ack = 0x00; //Unused
+    private XMLMessageSubType xmlMessageSubType;
+    private long length;
+    private long sequence;
+    private String content;
+
+    /**
+     * XML Message from the AC35 Streaming data spec
+     * @param content The XML content
+     * @param type The XML Message Sub Type
+     * @param sequenceNum sequenceNum
+     */
+    public XMLMessage(String content, XMLMessageSubType type, long sequenceNum){
+        this.content = content;
+        this.xmlMessageSubType = type;
+        timeStamp = System.currentTimeMillis() / 1000L;
+        ack = 0;
+        length = this.content.length();
+        sequence = sequenceNum;
+
+        setHeader(new Header(MESSAGE_TYPE, 0x01, (short) getSize()));
+        allocateBuffer();
+        writeHeaderToBuffer();
+
+        // Write message fields
+        putUnsignedByte((byte) MESSAGE_VERSION);
+        putInt((int) ack, 2);
+        putInt((int) timeStamp, 6);
+        putByte((byte)xmlMessageSubType.getType());
+        putInt((int) sequence, 2);
+        putInt((int) length, 2);
+        putBytes(content.getBytes());
+
+        writeCRC();
+        rewind();
+    }
+
+    /**
+     * @return The length of this message
+     */
+    public int getSize(){
+        return MESSAGE_SIZE + content.length();
+    }
+}

src/main/java/seng302/gameServer/server/messages/XMLMessageSubType.java

@@ -0,0 +1,20 @@
+package seng302.gameServer.server.messages;
+
+/**
+ * Enum containing the types of XML messages
+ */
+public enum XMLMessageSubType {
+    REGATTA(5),
+    RACE(6),
+    BOAT(7);
+
+    private int type;
+
+    XMLMessageSubType(int type){
+        this.type = type;
+    }
+
+    public int getType(){
+        return this.type;
+    }
+}

src/main/java/seng302/gameServer/server/simulator/Boat.java

@@ -0,0 +1,125 @@
+package seng302.gameServer.server.simulator;
+
+import seng302.model.GeoPoint;
+import seng302.utilities.GeoUtility;
+
+public class Boat {
+
+	private int sourceID;
+	private double lat;
+	private double lng;
+	private double speed; // in mm/sec
+	private String boatName, shortName, shorterName;
+	private boolean isFinished;
+	private long estimatedTimeTillFinish;
+
+	private Corner lastPassedCorner, headingCorner;
+
+	public Boat(int sourceID, String boatName) {
+		this.sourceID = sourceID;
+		this.boatName = boatName;
+		this.isFinished = false;
+		estimatedTimeTillFinish = 0;
+	}
+
+	/**
+	 * Moves boat to the heading direction for a given time duration
+	 * @param heading moving direction in degree.
+	 * @param duration moving duration in millisecond.
+	 */
+	public void move(double heading, double duration) {
+		Double distance = speed * duration / 1000000; // convert mm to meter
+		GeoPoint originPos = new GeoPoint(lat, lng);
+		GeoPoint newPos = GeoUtility.getGeoCoordinate(originPos, heading, distance);
+		this.lat = newPos.getLat();
+		this.lng = newPos.getLng();
+	}
+
+	public String toString() {
+		return String.format("Boat (%d): lat: %f, lng: %f", sourceID, lat, lng);
+	}
+
+	public int getSourceID() {
+		return sourceID;
+	}
+
+	public void setSourceID(int sourceID) {
+		this.sourceID = sourceID;
+	}
+
+	public double getLat() {
+		return lat;
+	}
+
+	public void setLat(double lat) {
+		this.lat = lat;
+	}
+
+	public double getLng() {
+		return lng;
+	}
+
+	public void setLng(double lng) {
+		this.lng = lng;
+	}
+
+	public double getSpeed() {
+		return speed;
+	}
+
+	public void setSpeed(double speed) {
+		this.speed = speed;
+	}
+
+	public String getBoatName() {
+		return boatName;
+	}
+
+	public void setBoatName(String boatName) {
+		this.boatName = boatName;
+	}
+
+	public String getShortName() {
+		return shortName;
+	}
+
+	public void setShortName(String shortName) {
+		this.shortName = shortName;
+	}
+
+	public String getShorterName() {
+		return shorterName;
+	}
+
+	public void setShorterName(String shorterName) {
+		this.shorterName = shorterName;
+	}
+
+	public Corner getLastPassedCorner() {
+		return lastPassedCorner;
+	}
+
+	public void setLastPassedCorner(Corner lastPassedCorner) {
+		this.lastPassedCorner = lastPassedCorner;
+	}
+
+	public Corner getHeadingCorner() {
+		return headingCorner;
+	}
+
+	public void setHeadingCorner(Corner headingCorner) {
+		this.headingCorner = headingCorner;
+	}
+
+	public boolean isFinished() {
+		return isFinished;
+	}
+
+	public void setFinished(boolean finished) {
+		isFinished = finished;
+	}
+
+	public long getEstimatedTimeTillFinish(){
+		return (long) (-getSpeed()) + System.currentTimeMillis();
+	}
+}

src/main/java/seng302/gameServer/server/simulator/Corner.java

@@ -0,0 +1,91 @@
+package seng302.gameServer.server.simulator;
+
+import seng302.model.mark.CompoundMark;
+
+public class Corner {
+
+	private int seqID;
+	private CompoundMark compoundMark;
+	//private int CompoundMarkID;
+	private RoundingType roundingType;
+	private int zoneSize; // size of the zone around a mark in boat-lengths.
+
+	// TODO: this shouldn't be used in the future!!!!
+	private double bearingToNextCorner, distanceToNextCorner;
+	private Corner nextCorner;
+
+	public Corner(int seqID, CompoundMark compoundMark, RoundingType roundingType, int zoneSize) {
+		this.seqID = seqID;
+		this.compoundMark = compoundMark;
+		this.roundingType = roundingType;
+		this.zoneSize = zoneSize;
+	}
+
+	/**
+	 * Prints out corner's info and its compound mark, good for testing
+	 * @return a string showing its details
+	 */
+	@Override
+	public String toString() {
+		return String.format("Corner: %d - %s - %d, %s\n",
+				seqID, roundingType.getType(), zoneSize, compoundMark.toString());
+	}
+
+	public int getSeqID() {
+		return seqID;
+	}
+
+	public void setSeqID(int seqID) {
+		this.seqID = seqID;
+	}
+
+	public CompoundMark getCompoundMark() {
+		return compoundMark;
+	}
+
+	public void setCompoundMark(CompoundMark compoundMark) {
+		this.compoundMark = compoundMark;
+	}
+
+	public RoundingType getRoundingType() {
+		return roundingType;
+	}
+
+	public void setRoundingType(RoundingType roundingType) {
+		this.roundingType = roundingType;
+	}
+
+	public int getZoneSize() {
+		return zoneSize;
+	}
+
+	public void setZoneSize(int zoneSize) {
+		this.zoneSize = zoneSize;
+	}
+
+
+	// TODO: next six setters & getters shouldn't be used in the future.
+	public double getBearingToNextCorner() {
+		return bearingToNextCorner;
+	}
+
+	public void setBearingToNextCorner(double bearingToNextCorner) {
+		this.bearingToNextCorner = bearingToNextCorner;
+	}
+
+	public double getDistanceToNextCorner() {
+		return distanceToNextCorner;
+	}
+
+	public void setDistanceToNextCorner(double distanceToNextCorner) {
+		this.distanceToNextCorner = distanceToNextCorner;
+	}
+
+	public Corner getNextCorner() {
+		return nextCorner;
+	}
+
+	public void setNextCorner(Corner nextCorner) {
+		this.nextCorner = nextCorner;
+	}
+}

src/main/java/seng302/gameServer/server/simulator/RoundingType.java

@@ -0,0 +1,43 @@
+package seng302.gameServer.server.simulator;
+
+public enum RoundingType {
+
+	// the mark should be rounded to port (boat's left)
+	PORT("Port"),
+
+	// the mark should be rounded to starboard (boat's right)
+	STARBOARD("Stbd"),
+
+	// the boat within the compound mark with the SeqID of 1 should be rounded
+	// to starboard and the boat within the compound mark with the SeqID of 2
+	// should be rounded to port.
+	SP("SP"),
+
+	// the opposite of SP
+	PS("PS");
+
+	private String type;
+
+	RoundingType(String type) {
+		this.type = type;
+	}
+
+	public String getType() {
+		return this.type;
+	}
+
+	public static RoundingType typeOf(String type) {
+		switch (type) {
+			case "Port":
+				return PORT;
+			case "Stbd":
+				return STARBOARD;
+			case "SP":
+				return SP;
+			case "PS":
+				return PS;
+			default:
+				return null;
+		}
+	}
+}

src/main/java/seng302/gameServer/server/simulator/Simulator.java

@@ -0,0 +1,159 @@
+package seng302.server.simulator;
+
+import seng302.server.simulator.mark.Corner;
+import seng302.server.simulator.mark.Mark;
+import seng302.server.simulator.parsers.RaceParser;
+import seng302.utilities.GeoPoint;
+import seng302.utilities.GeoUtility;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Observable;
+import java.util.Set;
+import java.util.concurrent.ThreadLocalRandom;
+import seng302.model.mark.Mark;
+import seng302.gameServer.server.simulator.parsers.RaceParser;
+import seng302.model.GeoPoint;
+import seng302.utilities.GeoUtility;
+
+public class Simulator extends Observable implements Runnable {
+
+	private List<Corner> course;
+	private List<Boat> boats;
+	private long lapse;
+	private boolean isRaceStarted;
+
+	/**
+	 * Creates a simulator instance with given time lapse.
+	 * @param lapse time duration in millisecond.
+	 */
+	public Simulator(long lapse) {
+		RaceParser rp = new RaceParser("/server_config/race.xml");
+		course = rp.getCourse();
+		boats = rp.getBoats();
+		this.lapse = lapse;
+		isRaceStarted = false;
+
+		setLegs();
+
+		// set start line's coordinate to boats
+		Double startLat = course.get(0).getCompoundMark().getSubMark(1).getLat();
+		Double startLng = course.get(0).getCompoundMark().getSubMark(1).getLng();
+		for (Boat boat : boats) {
+			boat.setLat(startLat);
+			boat.setLng(startLng);
+			boat.setLastPassedCorner(course.get(0));
+			boat.setHeadingCorner(course.get(1));
+			boat.setSpeed(ThreadLocalRandom.current().nextInt(40000, 60000 + 1));
+		}
+	}
+
+	@Override
+	public void run() {
+
+		int numOfFinishedBoats = 0;
+
+		while (numOfFinishedBoats < boats.size()) {
+
+			// if race has started, then boat should start to move.
+			if (isRaceStarted) {
+				for (Boat boat : boats) {
+					numOfFinishedBoats += moveBoat(boat, lapse);
+				}
+			}
+
+			setChanged();
+			notifyObservers(boats);
+
+			try {
+				Thread.sleep(lapse);
+			} catch (InterruptedException e) {
+				System.out.println("[Simulator] interrupted exception ");
+			}
+		}
+	}
+
+	/**
+	 * Moves a boat with given time duration.
+	 * @param boat the boat to be moved
+	 * @param duration the moving duration in milliseconds
+	 * @return 1 if the boat has reached the final line, otherwise return 0
+	 */
+	private int moveBoat(Boat boat, double duration) {
+		if (boat.getHeadingCorner() != null) {
+
+			boat.move(boat.getLastPassedCorner().getBearingToNextCorner(), duration);
+
+			GeoPoint boatPos = new GeoPoint(boat.getLat(), boat.getLng());
+			GeoPoint lastMarkPos = boat.getLastPassedCorner().getCompoundMark().getSubMark(1);
+
+			double distanceFromLastMark = GeoUtility.getDistance(boatPos, lastMarkPos);
+			// if a boat passes its heading mark
+			while (distanceFromLastMark >= boat.getLastPassedCorner().getDistanceToNextCorner()) {
+				double compensateDistance = distanceFromLastMark - boat.getLastPassedCorner().getDistanceToNextCorner();
+				boat.setLastPassedCorner(boat.getHeadingCorner());
+				boat.setHeadingCorner(boat.getLastPassedCorner().getNextCorner());
+
+				// heading corner == null means boat has reached the final mark
+				if (boat.getHeadingCorner() == null) {
+					boat.setFinished(true);
+					return 1;
+				}
+
+				// move compensate distance for the mark just passed
+				GeoPoint pos = GeoUtility.getGeoCoordinate(
+						boat.getLastPassedCorner().getCompoundMark().getSubMark(1),
+						boat.getLastPassedCorner().getBearingToNextCorner(),
+						compensateDistance);
+				boat.setLat(pos.getLat());
+				boat.setLng(pos.getLng());
+				distanceFromLastMark = GeoUtility.getDistance(new GeoPoint(boat.getLat(), boat.getLng()),
+						boat.getLastPassedCorner().getCompoundMark().getSubMark(1));
+			}
+		}
+		return 0;
+	}
+
+	/**
+	 * Link all the corners in the course list so that every corner knows its next
+	 * corner, as well as the distance and bearing to its next corner. However,
+	 * the last corner's heading is null, which means it is the final line.
+	 */
+	private void setLegs() {
+		// get the bearing from one mark to the next heading mark
+		for (int i = 0; i < course.size() - 1; i++) {
+
+			Mark mark1 = course.get(i).getCompoundMark().getSubMark(1);
+			Mark mark2 = course.get(i + 1).getCompoundMark().getSubMark(1);
+			course.get(i).setDistanceToNextCorner(GeoUtility.getDistance(mark1, mark2));
+
+			course.get(i).setNextCorner(course.get(i + 1));
+
+			course.get(i).setBearingToNextCorner(
+					GeoUtility.getBearing(course.get(i).getCompoundMark().getSubMark(1),
+					course.get(i + 1).getCompoundMark().getSubMark(1)));
+		}
+	}
+
+	public List<Boat> getBoats(){
+		return boats;
+	}
+
+	public void setRaceStarted(boolean raceStarted) {
+		isRaceStarted = raceStarted;
+	}
+
+	/**
+	 * @return A list of marks in the race
+	 */
+	public Set<CompoundMark> getMarks(){
+		Set<CompoundMark> marks =  new HashSet<>();
+
+		for (Corner c : course){
+			marks.add(c.getCompoundMark());
+			marks.add(c.getCompoundMark());
+		}
+
+		return marks;
+	}
+}

src/main/java/seng302/gameServer/server/simulator/parsers/BoatsParser.java

@@ -0,0 +1,19 @@
+package seng302.gameServer.server.simulator.parsers;
+
+import org.w3c.dom.Document;
+
+
+/**
+ * Parses the race xml file to get course details
+ * Created by Haoming Yin (hyi25) on 16/3/2017
+ */
+public class BoatsParser extends FileParser {
+
+	private Document doc;
+
+	public BoatsParser(String path) {
+		super(path);
+		this.doc = this.parseFile();
+	}
+
+}

src/main/java/seng302/gameServer/server/simulator/parsers/CourseParser.java

@@ -0,0 +1,117 @@
+package seng302.gameServer.server.simulator.parsers;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import seng302.model.mark.CompoundMark;
+import seng302.gameServer.server.simulator.Corner;
+import seng302.model.mark.Mark;
+import seng302.gameServer.server.simulator.RoundingType;
+
+/**
+ * Parses the race xml file to get course details
+ * Created by Haoming Yin (hyi25) on 16/3/2017
+ */
+public class CourseParser extends FileParser {
+
+	private Document doc;
+	private Map<Integer, CompoundMark> compoundMarksMap;
+
+	public CourseParser(String path) {
+		super(path);
+		this.doc = this.parseFile();
+	}
+
+	// TODO: should handle error / invalid file gracefully
+	protected List<Corner> getCourse() {
+		compoundMarksMap = getCompoundMarks(doc.getDocumentElement());
+		List<Corner> corners = new ArrayList<>();
+		NodeList cMarksSequence = doc.getElementsByTagName("Corner");
+
+		for (int i = 0; i < cMarksSequence.getLength(); i++) {
+			corners.add(getCorner(cMarksSequence.item(i)));
+		}
+		return corners;
+	}
+
+
+	private Corner getCorner(Node node) {
+		if (node.getNodeType() == Node.ELEMENT_NODE) {
+			Element e = (Element) node;
+
+			Integer seqId = Integer.valueOf(e.getAttribute("SeqID"));
+			Integer cMarkId = Integer.valueOf(e.getAttribute("CompoundMarkID"));
+			CompoundMark cMark = compoundMarksMap.get(cMarkId);
+			RoundingType roundingType = RoundingType.typeOf(e.getAttribute("Rounding"));
+			Integer zoneSize = Integer.valueOf(e.getAttribute("ZoneSize"));
+
+			return new Corner(seqId, cMark, roundingType, zoneSize);
+		}
+		return null;
+	}
+
+	private Map<Integer, CompoundMark> getCompoundMarks(Node node) {
+		Map<Integer, CompoundMark> compoundMarksMap = new HashMap<>();
+
+		if (node.getNodeType() == Node.ELEMENT_NODE) {
+			Element element = (Element) node;
+			NodeList cMarks = element.getElementsByTagName("CompoundMark");
+
+			// loop through all compound marks who are the children of course node
+			for (int i = 0; i < cMarks.getLength(); i++) {
+				CompoundMark cMark = getCompoundMark(cMarks.item(i));
+				if (cMark != null)
+					compoundMarksMap.put(cMark.getId(), cMark);
+			}
+
+			return compoundMarksMap;
+		}
+		return null;
+	}
+
+
+	private CompoundMark getCompoundMark(Node node) {
+		if (node.getNodeType() == Node.ELEMENT_NODE) {
+			Element e = (Element) node;
+			Integer markID = Integer.valueOf(e.getAttribute("CompoundMarkID"));
+
+			String name = e.getAttribute("Name");
+			CompoundMark cMark = new CompoundMark(markID, name);
+
+			NodeList marks = e.getElementsByTagName("Mark");
+			for (int i = 0; i < marks.getLength(); i++) {
+				Mark mark = getMark(marks.item(i));
+				if (mark != null)
+					cMark.addSubMarks(mark);
+			}
+			return cMark;
+		}
+		System.out.println("Failed to create compound mark.");
+		return null;
+	}
+
+
+	private Mark getMark(Node node) {
+		if (node.getNodeType() == Node.ELEMENT_NODE) {
+			Element e = (Element) node;
+			Integer seqId = Integer.valueOf(e.getAttribute("SeqID"));
+			String name = e.getAttribute("Name");
+			Double lat = Double.valueOf(e.getAttribute("TargetLat"));
+			Double lng = Double.valueOf(e.getAttribute("TargetLng"));
+			Integer sourceId = Integer.valueOf(e.getAttribute("SourceID"));
+
+			Mark mark = new Mark(name, lat, lng, sourceId);
+			mark.setSeqID(seqId);
+
+			return mark;
+		}
+		System.out.println("Failed to create mark.");
+		return null;
+	}
+
+}

src/main/java/seng302/gameServer/server/simulator/parsers/FileParser.java

@@ -0,0 +1,51 @@
+package seng302.gameServer.server.simulator.parsers;
+
+import java.io.InputStream;
+import java.io.StringReader;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import org.w3c.dom.Document;
+import org.xml.sax.InputSource;
+
+/**
+ * Created by Haoming Yin (hyi25) on 16/3/2017
+ */
+public abstract class FileParser {
+
+    private String filePath;
+
+    public FileParser() {}
+
+    public FileParser(String path) {
+        this.filePath = path;
+    }
+
+    protected Document parseFile() {
+        try {
+            InputStream is = getClass().getResourceAsStream(this.filePath);
+            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+            DocumentBuilder builder = factory.newDocumentBuilder();
+            Document doc = builder.parse(is);
+            // optional, in order to recover info from broken line.
+            doc.getDocumentElement().normalize();
+            return doc;
+        } catch (Exception e) {
+            System.out.println("[FileParser] Exception");
+            return null;
+        }
+    }
+
+    protected Document parseFile(String xmlString) {
+        try {
+            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+            DocumentBuilder builder = factory.newDocumentBuilder();
+            Document doc = builder.parse(new InputSource(new StringReader(xmlString)));
+            // optional, in order to recover info from broken line.
+            doc.getDocumentElement().normalize();
+            return doc;
+        } catch (Exception e) {
+            System.out.println("[FileParser] Exception");
+        }
+        return null;
+    }
+}

src/main/java/seng302/gameServer/server/simulator/parsers/RaceParser.java

@@ -0,0 +1,65 @@
+package seng302.gameServer.server.simulator.parsers;
+
+import java.util.ArrayList;
+import java.util.List;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import seng302.gameServer.server.simulator.Boat;
+import seng302.gameServer.server.simulator.Corner;
+
+/**
+ * Parses the race xml file to get course details
+ * Created by Haoming Yin (hyi25) on 16/3/2017
+ */
+public class RaceParser extends FileParser {
+
+	private Document doc;
+	private String path;
+
+	public RaceParser(String path) {
+		super(path);
+		this.path = path;
+		this.doc = this.parseFile();
+	}
+
+	/**
+	 * Parses race.xml file and returns a list of corner which is the race course.
+	 * @return a list of ordered corner to represent the course.
+	 */
+	public List<Corner> getCourse() {
+		CourseParser cp = new CourseParser(path);
+		return cp.getCourse();
+	}
+
+	/**
+	 * Parses race.xml file and return a list of boats which will compete in the
+	 * race.
+	 * @return a list of boats that are going to compete in the race.
+	 */
+	public List<Boat> getBoats() {
+		NodeList yachts = doc.getDocumentElement().getElementsByTagName("Yacht");
+		List<Boat> boats = new ArrayList<>();
+
+		for (int i = 0; i < yachts.getLength(); i++) {
+			boats.add(getBoat(yachts.item(i)));
+		}
+		return boats;
+	}
+
+	/**
+	 * Parses a single boat from the given node
+	 * @param node a node within a boat tag
+	 * @return a boat instance parsed from the given node
+	 */
+	private Boat getBoat(Node node) {
+		if (node.getNodeType() == Node.ELEMENT_NODE) {
+			Element e = (Element) node;
+
+			Integer sourceId = Integer.valueOf(e.getAttribute("SourceID"));
+			return new Boat(sourceId, "Test Boat");
+		}
+		return null;
+	}
+}