[CS2113T-T09-4] PulsePilot by JustinSoh · Pull Request #63 · nus-cs2113-AY2324S2/tp

JustinSoh · 2024-03-10T13:38:02Z

PulsePilot is a desktop app for tracking health-related information, optimised for users via a Command Line Interface (CLI). If one can type fast, you can key in and track health-related information faster than traditional GUI applications installed on your phone or computer.

LuoYu-uwu · 2024-04-04T04:19:26Z

+5. `GymSet` stores the weight and repetitions for a particular set.
+6. `WorkoutList` is a class that stores an array list different `Workout` objects using ArrayList.
+
+![Workout Package Class Diagram](img/workout_class_diagram.png)


Maybe consider including labels and multiplicities for easier understanding.

LuoYu-uwu · 2024-04-04T04:22:35Z

+1. `initialiseBot()` is called, and it prompts the user to enter their name, which is used throughout the bot.
+2. `initialiseScanner()` is used to create the singleton `Scanner` instance to read user input.
+3. When the user enters input, it is passed to `processInput()`, which determines the type of command inputted.
+4. Once the correct input has been determined, it is passed to the relevant handle function. For example, a `workout` command is passed to `handleWorkout()`.


Is it better to include a sequence diagram?

LuoYu-uwu · 2024-04-04T04:30:32Z

+This is the sequence diagram for adding a run:

-## Non-Functional Requirements
+![Run Sequence Diagram](img/run_sequence_diagram.png)


Is the diagram too long? Might affect readability.

LuoYu-uwu · 2024-04-04T04:33:07Z

+
+##### Gym Sequence
+
+![Gym Sequence Diagram](./img/gym_sequence_diagram.jpg)


Is there inconsistency in naming? The first four says <> and has colon before the name, while the last says <> and has no colon, resulting in some confusion

LuoYu-uwu · 2024-04-04T04:42:34Z

+6. `HealthList.predictNextPeriodStartDate()` gets the predicted start date by calling `Period.nextCyclePrediction()`.
+7. `Period.getLastThreeCycleLengths()` is called to find the sum of the latest three cycle lengths before returning to `Period.nextCyclePrediction()` for necessary calculation to obtain the predicted start date.
+8. The `Parser` class calls `Period.printNextCyclePrediction()` with the predicted start date as a parameter. This method prints a string indicating the number of days until the predicted start date of the next period, or how many days late the period is if the current date is after the predicted start date.
+![Sequence Diagram for Add Period](img/period_prediction.png)


Is it better to include the parenthesis and/or parameters behind the function name?

Leong-ZM · 2024-04-04T05:27:41Z

+    - If the time taken is **25 minutes and 20 seconds**: Use `25:20`.
+    - If the time taken is **1 hour, 20 minutes and 30 seconds**: Use `01:20:30`.
+- `[date]` is in `DD-MM-YYYY` format. **THIS IS AN OPTIONAL PARAMETER**.



Maybe show sample output?

Leong-ZM · 2024-04-04T05:35:02Z

+5. `GymSet` stores the weight and repetitions for a particular set.
+6. `WorkoutList` is a class that stores an array list different `Workout` objects using ArrayList.
+
+![Workout Package Class Diagram](img/workout_class_diagram.png)


classes should be represented by text such as {abstract} instead of circled letters in the diagram

Leong-ZM · 2024-04-04T05:39:52Z

+###### [Back to table of contents](#table-of-contents)
+
+### Health Package
+![Class Diagram for Health Package](img/health_package.png)


probably not necessary to show obvious methods such as getWeight()

Leong-ZM · 2024-04-04T05:45:07Z

+
+6. The `Appointment` object is passed to `Output.printAddAppointment()` and a message acknowledging the successful adding is printed to the screen.
+
+![AddAppointment](img/appointment_sequence.png)


parenthesis should be included in function names

TimothyLKM

Overall, very detail diagrams but you can omit some less important methods. Good job!

TimothyLKM · 2024-04-04T05:22:22Z

+The application follows an Object-Oriented Design approach, with separate classes for handling different components of the application, such as user input, output, exercise logging, and health data management.
+
+
+![ArchitectureDiagram](![img.png](img/architecture_diagram.png)


Alignment issue on the Architecture diagram.

TimothyLKM · 2024-04-04T05:27:59Z

+{Include `WorkoutList` description}
+
+###### [Back to table of contents](#table-of-contents)
+
+#### Gym
+
+{Include `Gym` description}
+
+###### [Back to table of contents](#table-of-contents)
+
+##### Gym Station
+
+{Include `GymStation` description}
+
+###### [Back to table of contents](#table-of-contents)
+
+##### Gym Set
+
+{Include `GymSet` description}
+
+###### [Back to table of contents](#table-of-contents)
+
+#### Run
+
+{Include `Run` description}
+


Missing description.

TimothyLKM · 2024-04-04T05:41:26Z

+| 2.0     | runner                | quickly view my most recent run details               | see my latest run                     |
+| 2.0     | gym enthusiast        | quickly view my most recent gym session               | see my latest gym session             | 
+| 2.0     | gym enthusiast        | accurately track my progress and strength gains       | enter varying weights for sets        | 
+| 2.0     | female user           | plan ahead and better manage my health                | p#D85D43ict my next period start date | 


Typo on the "I want to" column

TimothyLKM · 2024-04-04T05:42:41Z

Too many unnecessary commands on this Class diagram.

TimothyLKM · 2024-04-04T05:43:41Z

Remove extra headers at the bottom of all your diagrams

TimothyLKM · 2024-04-04T05:44:25Z

Diagram may be too much and cluttered to read. Do consider omitting some commands.

TimothyLKM · 2024-04-04T05:45:13Z

You could omit some less important methods.

jing-xiang

Overall good DG. Detailed sequence diagrams but some part seems missing and there are some formatting errors so remember to fix those!

jing-xiang · 2024-04-04T07:20:25Z

+
+The application follows an Object-Oriented Design approach, with separate classes for handling different components of the application, such as user input, output, exercise logging, and health data management.
+
+![Architecture Diagram](img/architecture_diagram.png)


formatting error on github pages

jing-xiang · 2024-04-04T07:25:13Z

+
+###### [Back to table of contents](#table-of-contents)
+
+#### Parser


seems incomplete

jing-xiang · 2024-04-04T07:28:31Z

+
+##### Period Sequence
+
+The sequence diagram below illustrates the process of period prediction.


Sequence diagram seems accurate and detailed. Good job.

jing-xiang · 2024-04-04T07:29:34Z

+
+- Station name is `Bench Press`.
+- User has done **2 sets of 3 repetitions**.
+- The first set was done using 100kg, and the second using 200kg.


+1 for 200kg bench press 👍

jing-xiang · 2024-04-04T07:30:53Z

+
+###### [Back to table of contents](#table-of-contents)
+
+### View History


should these be empty?

jing-xiang · 2024-04-04T07:32:13Z

+| 2.0     | runner                | quickly view my most recent run details               | see my latest run                     |
+| 2.0     | gym enthusiast        | quickly view my most recent gym session               | see my latest gym session             | 
+| 2.0     | gym enthusiast        | accurately track my progress and strength gains       | enter varying weights for sets        | 
+| 2.0     | female user           | plan ahead and better manage my health                | p#D85D43ict my next period start date | 


seems like a formatting/typo error on the female user row?

jing-xiang · 2024-04-04T07:34:19Z

+</code>
+
+- `[distance]` is a 2 **decimal place positive number** representing the number of kilometers covered.
+- `[time]` is in `HH:MM:SS` or `MM:SS` format with positive integers, representing the amount of time taken for the run.


sorry if i missed it but maybe clarify whats the type

shawnpong · 2024-04-05T07:20:43Z

+
+#### Workout List
+
+{Include `WorkoutList` description}


Description still empty for all these workouts

shawnpong · 2024-04-05T07:22:16Z

+
+#### Filters
+
+{Include `Filters` description}


These descriptions are also not filled in yet?

shawnpong · 2024-04-05T07:25:08Z

+- `[height]` is a 2 **decimal place positive number** representing the user's height.
+
+- `[weight]`is a 2 **decimal place positive number** representing the user's weight.
+
+- `[date]` is in `DD-MM-YYYY` format (i.e. `19-03-2024`).


height, weight and date all have specific inputs that have been defined "decimal place positive number" which is good practice!

shawnpong · 2024-04-05T07:32:59Z

+1. **Q: How do I set up the development environment for the project?**  
+   A: You can set up the development environment by first cloning the repository to your local system. Then, load the project into your chosen IDE (we recommend IntelliJ IDEA).
+


Might want to specify which version of java to use etc?

cyhjason29 · 2024-04-05T07:16:11Z

+=======
+
+![ArchitectureDiagram](img/architecture_diagram.png)
+>>>>>>> f712869cb298d4ac1f4d6178e7eaeed520cb1919


maybe the image was accidentally repeated when resolving merge conflicts?

cyhjason29 · 2024-04-05T07:22:34Z

+
+###### [Back to table of contents](#table-of-contents)
+
+#### Health List


would class diagrams help to make the following classes clearer?

cyhjason29 · 2024-04-05T07:28:13Z

+This is the sequence diagram for adding a run:
+
+![Run Sequence Diagram](img/run_sequence_diagram.png)
+


should the handleWorkout() arrow be solid instead?
should addRun() be pointing to the top of the activation bar of :WorkoutList instead?

cyhjason29 · 2024-04-05T07:33:17Z

+| 2.0     | gym enthusiast        | accurately track my progress and strength gains       | enter varying weights for sets        | 
+| 2.0     | female user           | plan ahead and better manage my health                | p#D85D43ict my next period start date | 
+| 2.0     | injured user          | remember the appointments I have                      | track my medical appointments         |
+


should the "So that I can" and "I want to" columns be swapped?

write manual testing, add more validation, remove refs in dg

Update

*Prints the latest appointment

showCurrentBmi to showLatestBmi

Reorder the methods order

Reorder methods order

add PPP and Seq Diagram for History and Latest

Dggg

update dg diagrams and clean up warnings

add assertions for run, group edit ug

Update PPP final

update ug table

Update PPP

add page breaks

fix pdf formats

fix ghost pages

finalise DG and UG with breaks

LuoYu-uwu reviewed Apr 4, 2024

View reviewed changes

Leong-ZM reviewed Apr 4, 2024

View reviewed changes

TimothyLKM reviewed Apr 4, 2024

View reviewed changes

jing-xiang reviewed Apr 4, 2024

View reviewed changes

shawnpong reviewed Apr 5, 2024

View reviewed changes

cyhjason29 reviewed Apr 5, 2024

View reviewed changes

rouvinerh and others added 24 commits April 10, 2024 13:16

make history consistent

af938fd

make latest more consistent

cfe2e81

fix output test case

7a2c18f

add validation of read and write permissions

726f010

add manual testing for dg

a020487

Fix error caused by "NA"

b4e0797

remove ref from dg

96d2bfb

Merge pull request #225 from rouvinerh/master

8368ccb

write manual testing, add more validation, remove refs in dg

Update DG for addPeriod and addBmi

26b6a02

Edit

c2e181d

Merge pull request #227 from j013n3/update

65ecdff

Update

Modify showEarliestAppointment to showLatestAppointment

db5cd8b

*Prints the latest appointment

Refactor name of method in Health

a71a18d

showCurrentBmi to showLatestBmi

Refactor HealthList

320f796

Reorder the methods order

Refactor Bmi

10a53b1

Reorder methods order

Add HealthList class diagram to DG

3a2d4c2

Refactor to sort order of methods

25de19e

Update health package design in DG

3af1beb

Reorder sequence of health implementations and commands

badebde

add PPP and Seq Diagram for History and Latest

6a39129

Merge pull request #228 from JustinSoh/master

b455740

add PPP and Seq Diagram for History and Latest

Update authors tag

26b88dd

Reorder the Health sequence

4322bb6

Add PPP

c55b833

rouvinerh and others added 30 commits April 15, 2024 12:57

add gym station back

90c36ea

remove []

c213605

Merge pull request #263 from j013n3/dggg

79c2c2b

Dggg

Merge branch 'master' into master

e4d5528

Update PPP

de45fb5

Update PPP

7132162

Merge branch 'master' of https://github.com/JustinSoh/tp

0ee9a01

Merge pull request #265 from rouvinerh/master

bf54670

update dg diagrams and clean up warnings

add assertions

39e60b5

Merge branch 'master' of https://github.com/rouvinerh/tp

0721ca5

update ug

aa7cced

add horizontal line

0917070

Merge pull request #266 from rouvinerh/master

2082620

add assertions for run, group edit ug

Merge pull request #267 from JustinSoh/master

9c11f47

Update PPP final

update table

c79d89d

remove numbering

b5806be

edit ppp

bba2517

Update PPP

24fcf64

Merge branch 'master' of https://github.com/AY2324S2-CS2113T-T09-4/tp

2e3e086

Merge pull request #268 from rouvinerh/master

b5c4f58

update ug table

Merge pull request #269 from L5-Z/master

60e8385

Update PPP

add page breaks

ba2609d

Merge pull request #271 from rouvinerh/master

b899d95

add page breaks

fix pdf formats

0e480ec

Merge pull request #273 from rouvinerh/master

16aa9f5

fix pdf formats

fix ghost pages

0ed2c37

remove page breaks

04bf21a

Merge pull request #274 from rouvinerh/master

4c548d1

fix ghost pages

remove unneeded page

9104c65

Merge pull request #275 from rouvinerh/master

2572c06

finalise DG and UG with breaks


		##### Gym Sequence

		![Gym Sequence Diagram](./img/gym_sequence_diagram.jpg)


		6. The `Appointment` object is passed to `Output.printAddAppointment()` and a message acknowledging the successful adding is printed to the screen.

		![AddAppointment](img/appointment_sequence.png)

		The application follows an Object-Oriented Design approach, with separate classes for handling different components of the application, such as user input, output, exercise logging, and health data management.


		![ArchitectureDiagram](![img.png](img/architecture_diagram.png)


		The application follows an Object-Oriented Design approach, with separate classes for handling different components of the application, such as user input, output, exercise logging, and health data management.

		![Architecture Diagram](img/architecture_diagram.png)


		###### [Back to table of contents](#table-of-contents)

		#### Parser


		##### Period Sequence

		The sequence diagram below illustrates the process of period prediction.


		###### [Back to table of contents](#table-of-contents)

		### View History

		1. Q: How do I set up the development environment for the project?
		A: You can set up the development environment by first cloning the repository to your local system. Then, load the project into your chosen IDE (we recommend IntelliJ IDEA).


		###### [Back to table of contents](#table-of-contents)

		#### Health List

		This is the sequence diagram for adding a run:

		![Run Sequence Diagram](img/run_sequence_diagram.png)

Conversation

JustinSoh commented Mar 10, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TimothyLKM left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jing-xiang left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants