Muhammad Khairul Azman - Project Portfolio

Alright, I’m now at the workout screen! What’s next?

As seen in the screenshot above, the Workout Planner screen is similar to the other screens, with the main difference being the list of Exercise cards and Workout Cards. Not too sure about what to work on or need suggestions? Workout Planner begins with prebuilt Exercises and Workouts installed to get you started.

Over on the left, is the list of Exercise Cards. Each card informs you of the name, primary muscle as well as the intensity of the exercise. To get more information of the exercise, you can use the view command which will be covered in section 3.7.3 of the User Guide. Based on the workout intensity, the image on the card will also change accordingly.

Similarly, to find more information on the workout, you can use the view command which is covered in a later section of this User Guide.

Now that you have a sizable amount of Exercises, you realise that you cannot easily find them amongst the sea of cards. To tackle this problem of seamless navigation, we implemented the find command.

Find Exercise works in 3 ways: By name, muscles trained (inclusive of both primary and secondary muscles) and intensity

To use the following command, simply type find in the command box followed by the variant you wish to utilise and the predicate.

The filtered lists will then be shown.

To show every exercise again, simply invoke the list exercise command.

You’ve created all your exercises and added it into your ultimate workout. Now you’re ready to run it! To run the workout, invoke the run workout command with the index of your ultimate workout.

The window above will pop up upon inputting the command. The window can be broken down into 5 major segments which are the Workout Name, Progress Bar, Exercise Name, Set Details and Command Box.

When you have completed a set, you can input done into the command box and it will indicate the set as completed as shown below.

After completing all the sets in all exercises, you will be brought back to the main page where a congratulatory message will greet you!

Now you know all there is to the workout planner! What are you waiting for? Go out there and put your gym membership to use!

 
Workout Management

Every workout comprises of the following information:

The Workout Class also contains the function updateHistory(WorkoutRun run) which adds the WorkoutRun into the WorkoutHistory and updates all the relevant fields accordingly, returning a new Workout instance with updated WorkoutHistory. The class also utilises pushExercise(Exercise exercise, Set<ExerciseDetail> details) function to add new Exercise and return a new Workout with update fields. There is also an option to push an exercise without the details with the overloaded method which instead opts to use the pre-built Set of ExerciseDetails in the Exercise itself.

The Workout Class is represented by the class diagram below.

The Workout Class is managed by the following commands:

 
Exercise Management

In order to run a Workout, users will have to add Exercises into the Workout as an empty workout cannot be ran. Users can use existing exercises or create their own custom exercises. Every exercise contains the following information:

Like Workout, Exercise also has the method updateHistory which returns an updated Exercise with a new ExerciseRun accounted for.

The Exercise class is represented by the following class diagram below.

The Exercise class is managed by the following commands :

All the exercise and workout commands above are parsed in DukeCooksParser, invoking the respective Command Parsers (Add, Delete, Edit etc.). The Exercise/Workout variant of the parser will then be instantiated (i.e AddExerciseCommandParser,DeleteWorkoutCommandParser etc) to create the actual command objects (i.e AddExerciseCommand, DeleteWorkoutCommand etc). These Command Objects will then execute the necessary steps to fulfill their functionality.

 
Running of Workouts

The core functionality of the WorkoutPlanner is to run a Workout and have it automatically tracking your progress by making records in its history. This is done through the Run Workout Command. The following sequence diagrams show what happens when the command is invoked.

As seen in the diagram above, when the command is invoked, the RunWorkoutParser is initialised to parse the argument String to initialise RunWorkoutCommand. The Command object will then run its execute method, which calls upon get method of UniqueWorkoutList to obtain the target Workout. The target workout and message will then be passed back to the Ui through the CommandResult object. The Ui will then boot a new RunWorkoutWindow with the targeted workout.

The user will then run each set of each exercise until the workout is complete. The full loop is demonstrated in the activity diagram in Figure 17.

Upon completion of the workout, the Ui will immediately generate a new UpdateWorkoutCommand containing the Workout that has been ran and a newly instantiated WorkoutRun with the details of the run. UpdateWorkoutCommand will then be executed and the following will occur:

Design Considerations