Skip to content

Commit

Permalink
Update DG
Browse files Browse the repository at this point in the history
  • Loading branch information
yyyaohhh committed Oct 26, 2023
1 parent 9900904 commit 201967e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,14 @@ How the parsing works:
### Model component
**API** : [`Model.java`](https://github.com/AY2324S1-CS2103T-T13-0/tp/blob/master/src/main/java/seedu/address/model/Model.java)

<puml src="diagrams/ModelClassDiagram.puml" width="450" />
<img src="diagrams/ModelClassDiagram.png" width="450" />


The `Model` component,

* stores the module plan data i.e., all `Module` objects (which are contained in a `UniqueModuleList` object).
* stores the module plan of each semester i.e., all `ModulePlanSemester` in one `ModulePlanSemesterList`.
* * stores the module plan data i.e., all `Module` objects (which are contained in a `UniqueModuleList` object).
* each module plan of a semester contains a `Semester` and a `Year` for identification and stores a `UniqueModuleList`.
* stores the currently 'selected' `Module` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList<Module>` that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.
* stores a `UserPref` object that represents the user’s preferences. This is exposed to the outside as a `ReadOnlyUserPref` objects.
* does not depend on any of the other three components (as the `Model` represents data entities of the domain, they should make sense on their own without depending on other components)
Expand Down
Binary file added docs/ModelClassDiagram/Model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/diagrams/ModelClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/main/java/seedu/address/model/moduleplan/ModulePlan.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public class ModulePlan implements ReadOnlyModulePlan {
public ModulePlan() {}

/**
* Creates an AddressBook using the Persons in the {@code toBeCopied}
* Creates an ModulePlan using the Modules in the {@code toBeCopied}
*/
public ModulePlan(ReadOnlyModulePlan toBeCopied) {
this();
Expand All @@ -42,7 +42,7 @@ public ModulePlan(ReadOnlyModulePlan toBeCopied) {


/**
* Resets the existing data of this {@code AddressBook} with {@code newData}.
* Resets the existing data of this {@code ModulePlan} with {@code newData}.
*/
public void resetData(ReadOnlyModulePlan newData) {
requireNonNull(newData);
Expand Down

0 comments on commit 201967e

Please sign in to comment.