com.TeamHEC.LocomotionCommotion.Map

Class MapInstance

java.lang.Object

com.TeamHEC.LocomotionCommotion.Map.MapInstance

public class MapInstance
extends java.lang.Object

Author:

Sam Watkins

Constructor Summary

Constructors

Constructor and Description
MapInstance() Instantiates an empty map instance for the purpose of generating a map file
MapInstance(java.lang.String filepath) Dynamically builds the map from a JSON file.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addConnection(Connection connection) Adds a single connection to the map
void	addMapObj(MapObj obj) Adds an object to the map
boolean	changeNameMapping(MapObj mapObj, java.lang.String newName)
Connection[]	connectionList()
void	generateFaults(Replay replay) Randomly cause faults within stations on the map
java.lang.String	generateJSON()
Junction	getJunctionWithName(java.lang.String name)
Connection	getReverseConnection(Connection connection)
Station	getStationWithName(java.lang.String name)
Junction[]	junctionList()
MapObj[]	mapObjList()
void	removeAllConnections(MapObj startPoint)
void	removeConnection(MapObj startPoint, MapObj endPoint)
void	removeJunction(java.lang.String junction)
void	removeStation(java.lang.String station) Removes station from MapInstance
void	reset() Resets the MapInstance to it's original state, used when you exit to the main menu
Station[]	stationList()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapInstance

public MapInstance()

Instantiates an empty map instance for the purpose of generating a map file

MapInstance

public MapInstance(java.lang.String filepath)

Dynamically builds the map from a JSON file.

Parameters:

filepath - provides the path to the JSON file representing the map

Method Detail

reset

public void reset()

Resets the MapInstance to it's original state, used when you exit to the main menu

getStationWithName

public Station getStationWithName(java.lang.String name)

Returns:

Station object with a given name - null if no station exists.

getJunctionWithName

public Junction getJunctionWithName(java.lang.String name)

Returns:

Junction object with a given name - null if no junction exists.

connectionList

public Connection[] connectionList()

stationList

public Station[] stationList()

Returns:

an array of stations only

junctionList

public Junction[] junctionList()

Returns:

an array of junctions only

mapObjList

public MapObj[] mapObjList()

Returns:

an array of all mapObj

addMapObj

public void addMapObj(MapObj obj)

Adds an object to the map

Parameters:

obj - the MapObj to add to the map

addConnection

public boolean addConnection(Connection connection)

Adds a single connection to the map

Parameters:

connection -

Returns:

removeStation

public void removeStation(java.lang.String station)

Removes station from MapInstance

Parameters:

station - the station to be removed from the map

removeJunction

public void removeJunction(java.lang.String junction)

removeAllConnections

public void removeAllConnections(MapObj startPoint)

removeConnection

public void removeConnection(MapObj startPoint,
                    MapObj endPoint)

generateJSON

public java.lang.String generateJSON()

Returns:

json string for saving to map file

generateFaults

public void generateFaults(Replay replay)

Randomly cause faults within stations on the map

getReverseConnection

public Connection getReverseConnection(Connection connection)

changeNameMapping

public boolean changeNameMapping(MapObj mapObj,
                        java.lang.String newName)