###Team 31 ####Team Information
- Team Name: Team 31
- Team E-Mail: usc-csci201-fall2013-team31-l@mymaillists.usc.edu
- Team Mentor: Sarah Whang sarahwha@usc.edu
####Resources
####Team Members
| No. | Name (First (Nickname) Last) | USC Email | GitHub Username | Role |
|---|---|---|---|---|
| 1 | Evan Coutre | evcoutre@usc.edu | @evcoutre | Team Leader |
| 2 | William Hunter McNichols | wmcnicho@usc.edu | @wmcnicho | |
| 3 | Meruyert Aitbayeva | aitbayev@usc.edu | @aibtbayev | |
| 4 | Brice Roland | broland@usc.edu | @broland | |
| 5 | Nikhil Bedi | nbedi@usc.edu | @nikhilbedi |
####Team Meetings
| Meeting | Time | Location |
|---|---|---|
| Lab | Wed. 10:00am | SAL 109 |
| Weekly Meeting 1 | Tues. 05:00pm to 10:00pm | GFS 112 |
| Weekly Meeting 2 | Thur. 05:00pm to 10:30pm | SAL 125 |
| General meetings | Tues./Thur. 05:00pm to 10:30pm | WPH B34 |
Immediately upon entering Gotham City (and running our program using the SimCityRun file to run it on Eclipse) you will hear the Batman soundtrack, which will immediately immerse yourself into the darkness, chaos, and unpredictability that is Gotham City.
####For V1 NOTE: For V1 we did not use any code that was given out publicly via professors or CPs and designed and built everything from scratch on our own.
As you can see in our GUI we have 4 different types of buildings: Market (top right), Bank (top middle), Restaurant (top left and sides), Homes (bottom row).
When you click on a building, the screen zooms in and gets replaced with the GUI and animation of that building. There is a small black box on the top left of each zoomed in building view that can be clicked to return to the city view.
To run a simulation of our city use the add Person button on the top right of the frame.
To simplify testing we have our buildings populated with Robots instead of PersonAgents. Robots are functionally the same as PersonAgents but their schedulers only run through job-related commands.
Our character that moves around is batman. We underlayed fillRect behind the batman characters to distinguish the roles and customers from the robots.
When a person is added you can set the amount of money they have using a slider on the pop up menu. The minimum amount of money a person can start with is $250 and the maximum is $1000.
There is only 1 Home that can be occupied (it is the middle home on the GUI). If a person is added after that home is occupied he will live in the "batcave" which is in the bottom left of the screen.
#####Home: Currently there is one Home is Gotham city. The first person that is created in the city belongs to that home. When the personAgent enters the home he turns into a residentRole. The person will go home if it is hungry and doesnt have enough money to eat at a restaurant or if it has groceries from the market and needs to put them in the fridge. ######HomeResident Role: There are three main things the resident can do once it is in the home. When it enters the home the first thing that it does is check its mailbox. The resident checks his mailbox for rentBills to see if he has to pay his landlord if he doesnt own his home. If he has a rentBill then he will go pay the bill (go to bank). The next thing the resident will do is check if his groceryBag is not empty. If the grocerBag is not empty then the resident will go to the fridge to put the groceries in the fridge and replenish the fridge foods. If the resident ever gets hungry, which is determined by the city clock then the resident will check the fridge to see if has food. If the fridge is out of food the resident will go to the market to pick up groceries and a restaurant to fulfill its hunger. If the fridge is not empty then the resident will choose a food, cook it, plate it, take it to the table, eat it, and clear it from the table. When the resident is not doing anything then the resident will go to the couch.
######Landlord Role: The landlord has a list of home owned. When the cityclock timer hits 12 or noon then the clock timer will send a message to for the landlord to send the rentbills out. The landlord will then send the rentbills to the mailbox of all of the residents of the homes the landlord owns.
There is only one Home in our city and only one new person can live there. If more than one person in our city is created, the others are spawned in a temporary location that we call the batcave. Obviously this will be changed for V2.
- Everything to do with the Home and resident and landlord was designed and implemented by Evan.
#####Bank: If the person's money is low, or high, or he needs to pay a bill he will go the the bank. In the bank there is a greeter and a teller. ######BankGreeterRole: The GreeterRole greets the customers and manages the customers and tellers. When customers come in the gretter puts them in a waiting line in fron of the bank counter. The greeter notifies a teller if they are needed when a customer comes into the bank and sends the customer to the teller. ######BankCustomerRole: The customer has a list of transaction types and tells the teller which transaction they want to make. These transaction include: deposit, withdrawal, opening account, closing account, need a loan, paying rent bill, leaving. When the bank customer comes in to make a withdrawal and the customer does not have a bank account, the teller will open a bank account for that customer ######BankTellerRole: The TellerRole gets messaged if a customer needs a transaction. The teller handles each transaction and every transaction that the bank customer needs. The teller checks a BankDatabase to get the info for the customer they are handling. For example if the customer wants to take out a loan, the teller will check the database to see if they have enough money in their account to be eligible for a loan.
- Everything to do with the Bank was designed and implemented by Brice.
#####Market: There is a cashier and worker in a market. Marker accepts two types of orders. First one customer orders, the second is restaurant orders. Customers walks to market, stay in a line, by telling market cashier that he needs food, when cashier asks him what he needs he walks to the cashier, passes his orders pays, and moves to get his items. While customer is paying worker walks to bring food to the customer. When customer gets his food he leaves the market. Restaurant cooks "call" market and give order, cashier interacts with restaurant cashier, and worker sends food to cook.
######CashierRole: greets customers, accepts orders from customers and retsaurant cooks, Accepts payments, gives change. Also, cashier makes worker bring or send food depending on order.
######MarketWorkerRole: Brings or sends food to restaurant or customer after cashier tells to do so. For now, worker "sends" food without trucks, food magically appears in restaurants.
#####Market: There is a cashier and worker in a market. Marker accepts two types of orders. First one customer orders, the second is restaurant orders. Customers walks to market, stay in a line, by telling market cashier that he needs food, when cashier asks him what he needs he walks to the cashier, passes his orders pays, and moves to get his items. While customer is paying worker walks to bring food to the customer. When customer gets his food he leaves the market. Restaurant cooks "call" market and give order, cashier interacts with restaurant cashier, and worker sends food to cook.
######CashierRole: greets customers, accepts orders from customers and retsaurant cooks, Accepts payments, gives change. Also, cashier makes worker bring or send food depending on order.
######MarketWorkerRole: Brings or sends food to restaurant or customer after cashier tells to do so. For now, worker "sends" food without trucks, food magically appears in restaurants.
- Everything to do with the Bank was designed and implemented by Mika.
#####Restaurants: Every one of our team member's restaurants are implemented into the city. We made this one of our biggest goals to complete by V1. Although including all team member's restaurants into the city was a difficult task, we thought if done successfully it would set us apart from other teams. None of our restaurants include the producer-consumer revolving stand. We knew that this would not be important to the main functionality of the city and we wanted to focus on getting our city running before focusing on smaller details like this. This is something we decided early on was not vital to our V1 and could be easily implemented in V2.
- Mika's restaurant: location=left bottom
- Nikhil's restaurant: location=top left
- Evan's restaurant: location=right top
- William's restaurant: location=right bottom
- Brice's restaurant: location=left top
Mika's restaurant is the only restaurant that can successfully order from the market when the cook runs out of inventory. The other restaurants have enough inventoy so it is not necessary. We do not animate this transaction.
#####PersonAgent: The personAgent has a couple different types of states: MarketState (to tell when the person has or is getting groceries), EatingState (keeps track of where to eat), HungerState (keeps track of level of hunger), MoneyState (keeps track of what level of money the person has), TransportationState (to determine whether to walk, drive, or take the bus. this is not used yet), JobState (for work. not used yet), RentState(for paying bills).
#####GUI: Hunter (William) created all of the GUI elements from scratch and spend a large amount helping others with integration and Git.
The super sexy looking main screen elements were created by Brice while the skeleton for implementing them was created by Hunter.
######SimCityRun: This class creates a frame containing all of the JPanels and runs the program.
######SimCityPanel: This is the Panel that contains all things related to animation including all of the Screen classes that will be discussed below. Every 10ms the program will update the current display and the positions of all the agent gui elements. This class also checks where the mouse is clicked and updates the Screen accordingly.
######Screen: The Screen class is the crucial class to the Gui implementation. A Screen is populated with Gui elements and backgroundImages. These elements with then be displayed only when that particular screen is activated. There are multiple classes that inherit from Screen:
- MainScreen (The "city-level" screen) (expand the resizable window when in this restaurant to see kitchen)
- BankAnimationPanel (Interior bank screen)
- HomeAnimationPanel (Interior home screen)
- MarketAnimationPanel (Interior market screen)
- The individual restaurant animation panels
######ScreenFactory: The ScreenFactory class was inspired by the RoleFactory discussed in class. It allows for access to each of the Screens of the simulation if given a String.
######InfoPanel: There is an information panel at the bottom of the window that contains information specific to the PersonAgent selected in the side pane. Right now only name, location, and current money is listed. In future versions this panel will allow for a user to override the scheduler of the person and cause him to perform certain actions.
######PersonSelectionPane: This side pane is much similar to the ones in our restaurant simulation. When a new person is added to the simulation he is added to this panel. If you click on the button associated with the personAgent, its information will be displayed on the infoPanel. There were plans for the personSelectionPane to only display persons that are currently on the screen and also to highlight the person when they are selected. These ideas will be implemented in later versions.
######NewPersonWindow: When the Add Person button is pressed, a new window is opened that allows the user to customize the aspects of a given personAgent. Upon pressing done this person will be added to the simulation. Only one newPerson window can be open at a time. These design decisions inspired my idea and implementation of the Robot class.
######RoleGui All visual represenations of PersonAgents are displayed via using a RoleGui class that contains information about spriting, background color, and movement.
#####Core Data
######PersonAgent: Nikhil laid this agent foundation early on for people to start understanding what sorts of data their roles would be using. It is a long file with tough logic that involves how and when people would eat (used with four different hunger levels), whether they choose to go to the restaurant or eat at home, if they should be getting groceries, and if they should be going to the bank to withdraw or deposit. This file also contained classes he created, like the Job class, which contains when a certain role will need to go on and off work, and where its corresponding building is. Also, Nikhil created RentBills, as the person needs to allow multiple roles to handle bills. He intuitively used multiple different states early on, before the professors noted this would be a good idea.
######Role: Nikhil also created the base Role class. This once again, laid a foundation for others to branch off and do their work while maintaining a loosely coupled environment. Nikhil made this an easy transition from agents, so it was understandable, and also allowed our restaurant agents to make the easy transition. Hunter, our GUI man, handled how RoleGui was dealt.
######CityClock timer: Nikhil had fun with this one. Initially, this one of the design issues we thought we were gonna have, but Nikhil made this an entirely static class with static variables. This allowed this class to start its time in the main function and constantly update time. Also, because it was static, it was easy to add personagents to its vector and message every person when an "hour" passed by.
######Building Nikhil initiated the Building and Location class. Locations were small and a part of Building, and the Building came in handy to make our code general when it came to displaying them and using them as containers. Hunter later expanded this class to make use of it in GUI components.
######Implementing Restaurants: Nikhil, having the design foundations for several other components, also laid out the general restaurant design and implementation for our group as others continued to finish their buildings or as Hunter continued to work on GUI. He created the base Restaurant class which everyone extended and overrided necessary functions. It was created in such a way where our restaurant code would only have to be changed to roles and the customer would have to be renamed. every other file stayed the same. For example, there are multiple HostRole.java files because Nikhil made it pertinent to what a certain instance wanted to access in a certain restaurant. He also generated an animation panel that could be the same for every one of our restaurants.
######RoleFactory: Nikhil designed and implemented this class and it greatly came in handy. It was messy to try and juggle so many roles, but strings were easy to understand. Again, a static class by Nikhil comes in handy.
We weren't able to find out the perfect "hour length" for our program to run realistically. By that we mean, the program may run in a loop (e.g. the person keeps going to the restaurant and to the home repeatedly because every four hours he gets hungry and each hour could be 5 seconds but in 20 seconds he will need to go to the restaurant to eat again) due to short hour lengths. We kept it short for faster testing (and also for faster grading) since watching a program simulate for 5-15 minutes (representative of a full day) can take a toll on productivity.
#####Weird things. +Why there is a gettingStarted.pdf from dropbox? Nobody knows.
#####For V2
We are really excited about the many feature creeps that have come up as we have been building our city that we not necessarily have been able to implement because the infrastructure was not complete but time permitting we plan to implement in our second version (i.e. easter eggs).
We set up a lot of code to prepare for V2 even though it was not implemented in V1. Although we have robots in now, all of the jobs are set up for roles so we can easily transition to sending people to work to populate the business and have them running in V2.
Welcome to the new and improved Gotham City!
###Added Features
####Transportation Batman has more options than simply walking! We added roads, sidewalks, and intersections into our city. We implemented a grid system to allow for this. People only travel on sidwalks when walking and can cross intersections. We have a bus system where one bus circles around the city stopping at bus stops and dropping people off. People go onto the bus if the bus is at its location. Busses wait for pedestrians to cross the road. The bus checks the next location and sees if it is occupied. We have cars that work the same way.
####GUI Upgrades Info Tab: Tells you the data of the current building you are looking at. It tells you the inventory at each building. You can change the amount of inventory in the buildings by adjusting the inventory spinners. Buildings Tab: For each building in the city the building tab lets you know if the building is open or closed and allows you to manually adjust if it is open or closed using the Lock toggle button. People Tab: displays the name of every person in our city. You can add a new person using the add person button.If you click on the name of a person it displays information about them like name, location, and amount of money they have. Debug Tab: This is our log filter mechanism to display our messages in each building
Time Bar: At the top of our city we have a bar that shows you what time it is in the city (in military time) and what day of week it is. The bar starts yellow to indicate the beginning of the day and turns dark when it is nightime.
####Jobs We replaced the robots who worked in our buildings into real people. When people are created and if they have a job they have a place to work and a shift. A person can either have an early shift or a late shift. The hours of the shift depend on how long the building is open for. People go to work when their shift starts and leaves when their shift ends. The person with the new shift takes over the messages and responsibilites of the worker they are replacing.
####Buildings #####Market Every restaurant can now order from a market. When a restaurant needs more inventory they will message the market who then sends a delivery truck to the respective restaurant. If a restaurant becomes closed while the truck is delivering. The truck turns around and returns to the market and then redelivers when the restaurant opens again. #####Apartments Apartment buildings house 6 different people
#####Banks a single person has their particular bank of choice. They will only go to their respective personal bank when needed.
#####Running Scenarios We included a File drop down menu on the top left of our gui. This contains a list of XML files to load people into the city so you can run and test certain scenarios.
- To run scenario A, use this XML:
- To run scenario B, use this XML:
- To run scenario J, use this XML: