starvationevasion.sim

Class Simulator

java.lang.Object

starvationevasion.sim.Simulator

public class Simulator
extends java.lang.Object

This is the main API point of the Starvation Evasion Simulator. This constructor should be called once at the start of each game by the Server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.io.PrintStream	dbg

Constructor Summary

Constructors

Constructor and Description
Simulator() This constructor should be called once at the start of each game by the Server.

Method Summary

Modifier and Type	Method and Description
void	discard(EnumRegion playerRegion, EnumPolicy card) The Server must call this for each card that is discarded before calling nextTurn().
EnumPolicy[]	drawCards(EnumRegion playerRegion) The server must call this for each playerRegion before the first turn and during each turn's draw phase.
EnumRegion	getRegion(double latitude, double longitude)
java.util.ArrayList<GeographicArea>[]	getRegionBoundaries()
java.util.ArrayList<WorldData>	getWorldData(int yearFrom, int yearThrough) At the start of the game, before dealing cards to players, the Server should call: getWorldData(Constant.FIRST_DATA_YEAR, Constant.FIRST_GAME_YEAR-1);
java.util.List<AbstractEvent>	getWorldEvents() Get a list of special events in the world
static void	main(java.lang.String[] args) This entry point is for testing only.
WorldData	nextTurn(java.util.ArrayList<PolicyCard> cards) The Server should call nextTurn(cards) when it is ready to advance the simulator a turn (Constant.YEARS_PER_TURN years). Before calling nextTurn, the Server must: Verify all policy cards drafted by the clients during the draft phase. Verify that any cards discarded by a player could be discarded. Call discard on each card discarded by a player. End the voting phase and decide the results. Call discard on each card that did not receive enough votes. Call drawCards for each player and send them their new cards.
static void	setLogFile(java.lang.String fileName) Configure the system logger to write to both a log file and the console.

Methods inherited from class java.lang.Object

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

Field Detail

dbg

public static java.io.PrintStream dbg

Constructor Detail

Simulator

public Simulator()

This constructor should be called once at the start of each game by the Server. Initializes the model Generates a random 80 card deck for each player (both human and AI players)

Method Detail

getWorldData

public java.util.ArrayList<WorldData> getWorldData(int yearFrom,
                                                   int yearThrough)

At the start of the game, before dealing cards to players, the Server should call: getWorldData(Constant.FIRST_DATA_YEAR, Constant.FIRST_GAME_YEAR-1);

Returns:

data structure populated with all game state data needed by the client except high resolution data that might be needed by the visualizer.

getRegionBoundaries

public java.util.ArrayList<GeographicArea>[] getRegionBoundaries()

nextTurn

public WorldData nextTurn(java.util.ArrayList<PolicyCard> cards)

The Server should call nextTurn(cards) when it is ready to advance the simulator a turn (Constant.YEARS_PER_TURN years).

Before calling nextTurn, the Server must:

1. Verify all policy cards drafted by the clients during the draft phase.
2. Verify that any cards discarded by a player could be discarded.
3. Call discard on each card discarded by a player.
4. End the voting phase and decide the results.
5. Call discard on each card that did not receive enough votes.
6. Call drawCards for each player and send them their new cards.

Parameters:

cards - List of PolicyCards enacted this turn. Note: cards played but not enacted (did not get required votes) must NOT be in this list. Such cards must be discarded (call discard(EnumRegion playerRegion, PolicyCard card)) before calling this method.

Returns:

data structure populated with all game state data needed by the client except high resolution data that might be needed by the visualizer.

drawCards

public EnumPolicy[] drawCards(EnumRegion playerRegion)

The server must call this for each playerRegion before the first turn and during each turn's draw phase. This method will return the proper number of cards from the top of the given playerRegion's deck taking into account cards played and discarded by that player.

Parameters:

playerRegion - region of player who id given the drawn cards.

Returns:

collection of cards.

discard

public void discard(EnumRegion playerRegion,
                    EnumPolicy card)

The Server must call this for each card that is discarded before calling nextTurn(). There are three different ways a card may be discarded:

1. During the draft phase, a player may use an action to discard up to 3 policy cards and immediately draw that many new cards. Using an action means the player can draft one less policy that turn. What is meant by immediately is that a player who does this and who still has a remaining action, may draft one of the newly drawn cards during that same draft phase.
2. As part of each draft phase, each player may discard a single policy card. Cards discarded this way are not replaced until the draw phase (after the voting phase).
3. A policy that is drafted, bt does not receive the required votes is discarded.

Parameters:

playerRegion - player who owns the discarded card.

card - to be discarded.

setLogFile

public static void setLogFile(java.lang.String fileName)
                       throws java.io.IOException

Configure the system logger to write to both a log file and the console.

Parameters:

fileName - Path to output log file.

Throws:

java.io.IOException

getWorldEvents

public java.util.List<AbstractEvent> getWorldEvents()

Get a list of special events in the world

Returns:

a list of events effecting the current world state

getRegion

public EnumRegion getRegion(double latitude,
                            double longitude)

Parameters:

latitude - Latitude ranges from -90 to 90. North latitude is positive.

longitude - Longitude ranges from -180 to 180. East longitude is positive.

Returns:

The region containing the given latitude and longitude or null if the given location is not within a game region.

main

public static void main(java.lang.String[] args)

This entry point is for testing only.

This test shows how to instantiate the simulator and how to tell it to deal each player a hand of cards.

Parameters:

args - ignored.