This project implements a simulated elevator control system designed for efficiency and scalability. The system consists of three main components: a Scheduler, an ElevatorNode, and a FloorSubsystem. These components work together to manage and respond to elevator requests from various floors, simulating the operation of a real-world elevator system in a multi-story building.
- Hamza Alsarakbi - project & team lead
- Mahad Mohamed Yonis - software developer
- Nabeel Azard - software developer
- Zarif Khan - software developer
- Arun Karki - software developer
- Clone or download the project to your local machine.
- Open a terminal or command prompt and navigate to the project's root directory.
- Compile the Java files with the command:
javac *.java. - Run the SchedulerLauncher, ElevatorSubsystemLauncher, and FloorSubsystemLauncher in any order.
- Click start on the Elevator window.
- Click start on the Floor window.
- (Optional) Run the "tests" package.
- Unit tests are provided for each subsystem. They can be run to ensure each part of the system functions as expected.
- Compile and run the test files separately, for example:
javac g5.elevator.FloorSubsystemTest.java && java g5.elevator.FloorSubsystemTest. - To test the system as a whole, modify the input data in the
FloorSubsystemto simulate different scenarios and observe how the system handles various elevator requests.
Mahad Mohamed Yonis: Co-author of README file. Author of all methods in FloorSubsystemTest, SchedulerSubsystemTest, ElevatorNodeTest classes. Author of methods doorOpen(), doorClose(), peopleLoad(), peopleUnload() methods in the ElevatorNode class.
Nabeel Azard: Co-author of README file. Author of UML class diagram for the program. Co-author of all methods in the FloorSubsystem, Schedulersystem classes. Co-author of traverseOneFloor(), setDirection(), traverseToElevatorCall(), differenceBetweenDestinationAndCurrentFloor(), and run() methods in the ElevatorNode class.
Zarif Khan: Co-author of README file. Author of Sequence diagram for the program, Co-author of all methods in the FloorSubsystem, Schedulersystem classes. Co-author of traverseOneFloor(), setDirection(), traverseToElevatorCall(), setElevatorCallFloor(), differenceBetweenDestinationAndCurrentFloor(), and run() methods in the ElevatorNode class.
Hamza Alsarakbi: Co-author of README file. Co-author of all methods in the FloorSubsystem, Schedulersystem classes. Co-author of traverseOneFloor(), setDirection(), setElevatorCallFloor(), run() methods in the ElevatorNode class.
Arun Karki: Co-author of README file. Co-author of all methods in the FloorSubsystem, Schedulersystem classes. Co-author of traverseOneFloor(), setDirection(), setElevatorCallFloor(), run() methods in the ElevatorNode class.
Hamza Alsarakbi: State diagrams, Elevator States, Class diagram
Mahad Mohamed Yonis: ElevatorNode tests, Documentation, State diagram assistance
Nabeel Azard: Elevator state tests, Documentation, State diagram assitance
Arun Karki: Minor bug fixes, State diagram assistance
Zarif Khan: Scheduler States, Scheduler State test, Updated Class/State diagrams
Hamza Alsarakbi: Worked on Scheduler Communication: Floor Registration, Elevator Events, Floor Pickup Request. Worked on ElevatorNode communication: Initialize sockets on unspecified ports, Events List, Pickup Requests, implemented getPickupIndex() in ElevatorNode. Designed and implemented a UI for the system. Documentation: Scheduler Sequence Diagram, Elevator State Diagram, Elevator Comm State Diagram
Mahad Mohamed Yonis:
Worked on ElevatorNode communication: Implemented run() method in ElevatorProcessingAddPickupCommState.
Documentation: Elevator Sequence Diagram
Implemented Unit Tests
Nabeel Azard:
Worked on Scheduler Communication: Initialize sockets, Elevator Registration.
Worked on ElevatorNode communication: implemetnted run() method in ElevatorIdleCommState, register() method in ElevatorNode, and sendEvent() method in ElevatorNode.
Documentation: README file, Scheduler State Diagram
Arun Karki: Implemented FloorNode communication: Initialize sockets on unspecified ports, Floor Registration, Floor Pickup Request, Elevator Events. Documentation: Class Diagram
Zarif Khan: Implemented FloorNode communication: Initialize sockets on unspecified ports, Floor Registration, Floor Pickup Request, Elevator Events. Documentation: Floor Sequence Diagram
Hamza Alsarakbi:
Finalized: System Design Planning, Completed UI elements of the project, finalized ElevatorNode, Final Project Report documentation, Project Class Diagram
Mahad Mohamed Yonis:
Finalized: FloorNodeTest, ElevatorNode Test, SchedulerControllerTest, InstructionTest, StateTests refinements
Arun Karki:
Finalized: FloorNode, ElevatorNode, README file, ElevatorSubsystem Sequence Diagram. SchedulerSubsystem Sequence Diagram, FloorSubsystem Sequence Diagram, Project Class Diagram
Nabeel Azard:
Finalized: ElevatorNode, SchedulerSystem, README file, Final Project Report Documentation, System Design Planning
Zarif Khan:
Finalized: FloorNode, ElevatorNode, README file, ElevatorSubsystem Sequence Diagram. SchedulerSubsystem Sequence Diagram, FloorSubsystem Sequence Diagram, Project Class Diagram
Copyright (c) 2023 [Nabeel Azard, Mahad Mohamed Yonis, Hamza Alsarakbi, Zarif Khan, Arun Karki]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.