csc207-uoft / course-project-circus Goto Github PK

Since we want the order system to be extensible (i.e. to handle arbitrary orders), we might want to introduce an "order handler" system that is charge of responding to/handling a specific type (or specific types) of orders.

For example, we might have an order handler for PlaceOrder types, and another handler for MoveOrder types. This separation will allow us to have different handling logic for different orders.

Test as much stuff as we can :)

Complete the callback implementation for the "File/Save As" menu option in the Toolbar class.

Very important for Phase 1 mark!

In real life, the Warehouse would send a robot an order along with a route, and then the robot would move along that path to fulfill the order. Once the Robot fulfilled the order, it would let the Warehouse know that it is available again.

However, since we don't actually have robots and we aren't writing multi threaded code, we need to write a simulator for the robots that moves them every frame along the path. This simulator can then be used in the UI code to display the robots "moving".

Ideally, we should have some sort of abstraction that would allow the "real world" implementation discussed above. This might look like an API that contain some sort of "updateRobotPosition" method, along with some other logic for syncing the robot positions with the Warehouse.

Complete the callback implementation for the "File/Save" menu option in the Toolbar class.

Create a world controller that has a list of robots and dispatches them as items are received in the warehouse.

This requires rebuilding the icon font for the intended icon size.

Interface for implementing route-finding.

Responsibility

• Route route(WarehouseLayout layout, Position source, Position target): takes in environment state (i.e. WarehouseLayout, the source and target positions), and finds a route under a certain set of constraints.

Collaboration

• WarehouseLayout
• Route
• Position

We should confirm that the user wants to erase the tile before actually doing so.

Make sure that the grid shows up and is dynamic (changes when commands run in the program).

Every time step, the warehouse should try to match available Robots to orders that need to be fulfilled. This can be done through a variety of metrics: take the closest robot, take the first robot, etc...

When a Robot is matched, it can compute a route to the destination using a routefinder algorithm. Then, the route can be visualized.

Entity
Class for an item in the warehouse.

Responsibility

• Constructs an item with the given name and description to store in the warehouse
• getName
• getDescription
• setName
• setDescription
• getId
• Overrides: tostring equals hashCode

Collaboration

None

Entity
Class representing a storage unit in the warehouse storing items of any type.
Inherits: StorageUnit

Responsibility

• Create a depot with a given capacity or infinite capacity
• addItem
• removeItem
• getCapacity
• hasInfiniteCapacity
• getSize
• Overrides: getQueryItems

Collaboration

Item

Implement inventory saving and loading.

• When a tile is NOT selected, the inspector window should let you edit warehouse properties (just size for now).
• Otherwise, when a tile IS selected, the inspector window should show the position of the tile as readonly input fields, and should let you edit the properties of the tile.

Entity
Class representing a stateless 2D representation of the layout of a warehouse.

Responsibility

• Construct an empty warehouse layout given width and height
• getTileAt
• isTileCoordinateInRange

Collaboration

None

Implement A* path-finding algorithm (https://en.wikipedia.org/wiki/A*_search_algorithm).

As discussed in the specification documents

Use Case (??)
Class that creates a unit in the warehouse that can store items.
Parent Classes: Receivable, Distributable

Responsibility

• addItem (abstract method)
• removeItem (abstract method)
• Overrides: recieveItem, distributeItem

Collaboration

Item, Query

Entity (??)
Class that creates a storage unit in the warehouse that can store items of a single type.
Inherits: StorageUnit

Responsibility

• Constructs a rack with a given item, a given capacity, or infinite capacity
• getCapacity
• hasInfiniteCapacity
• addItem
• removeItem
• getQueryItems

Collaboration

Item

Complete the callback implementation for the "File/New" menu option in the Toolbar class.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Abstract class for implementing moving agents in the warehouse with arbitrary route-finders.

Responsibility

TODO

Collaboration

• Router
• Route
• Warehouse
• WarehouseLayout

Make sure we implement the correct design principles and we must mention these in our presentation.

We need to implement saving and loading of the Warehouse object. We can probably use JSON to serialize the data.

Resource: https://www.baeldung.com/jackson-object-mapper-tutorial

A Robot (with an arbitrary route-finder algorithm) with an obstacle avoidance strategy. This robot uses a local path planner to sidestep obstacles as it encounters it by trying to wait for it, go around it, or recomputing the route.

Responsibility

TODO

Collaboration

• Robot

I've setup a simple messaging system inside the Warehouse so that whenever an item is added/removed from a storage unit, the warehouse is notified. Now, we need to use this to check:

• when an item is added to a ReceiveDepot. In this case, we need to create a new Order to move that Item to an available Rack.
• when an item is added to a ShipDepot. In this case, we should notify some service that an order has been fulfilled (this won't do anything in the UI but in real life, it would be useful to know when an item has been moved to a shipping depot).

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

These robots are in charge of organizing the warehouse

Currently, the StorageTileAssignmentPolicy constructor takes in a Warehouse, which doesn't really make much sense since we might want to re-use the same policy for different warehouses.

Entity
Class that creates an empty tile in the warehouse.

Responsibility

• Constructs a tile (WarehouseCell) with the given position

Collaboration

None

Complete the callback implementation for the "File/Open" menu option in the Toolbar class.

Use Case
Abstract class for pathfinders that discovers the optimal path for packages.

Responsibility

• Construct a pathfinder
• findPath (differs based on pathfinder used)

Collaboration

Item

Implement Item save and load.

Use Case
Class that computes the cost of two items (distancebetween two items) by implementing abstract class Scorer.
Parent Class: Scorer

Responsibility

• Overrides: computeCost

Collaboration

Item

Implement the move tile tool. Allows for moving a tile from one grid position to another.