Add diagrams and dg feature for set weak

docs/DeveloperGuide.md

@@ -245,6 +245,26 @@ _{Explain here how the data archiving feature will be implemented}_
 
 
 --------------------------------------------------------------------------------------------------------------------
+### Set Weakness Threshold Feature
+
+This is a new command to designate students as being "weak" or not based on their grades.
+By default, we have set C+ as the threshold, meaning that a student with grade lower than C+ is 
+displayed with a weak marker next to their name. 
+
+The command "set weak [grade]" followed by the grade allows the instructor to set a difference grade as the 
+new threshold. This command resets students' weak markers immediately. 
+
+
+The following activity diagram: 
+![SetWeakSequenceDiagram](images/SetWeakActivityDiagram.png)
+
+The State prior to set weak command
+![SetWeakStateDisgram](images/SetWeak1.png)
+
+The State after set weak command
+![SetWeakStateDiagram](images/SetWeak2.png)
+--------------------------------------------------------------------------------------------------------------------
+
 
 ## **Documentation, logging, testing, configuration, dev-ops**
 

docs/diagrams/SetWeak1.puml

@@ -0,0 +1,30 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+hide circle
+hide methods
+
+skinparam ClassFontColor #000000
+skinparam ClassBorderColor #000000
+skinparam ClassBackgroundColor #FFFFAA
+
+title Before set weak Command
+
+package addressBook <<rectangle>> {
+    class State0 as "<U>p0:Person</u>" {
+            studentId = A2345678S
+            grade = A+
+    }
+    class State1 as "<u>p1:Person</u>" {
+        studentId = A0123456X
+        grade = C
+        weak
+    }
+    class State2 as "<u>p2:Person</u>" {
+        studentId = A1234567H
+        grade = B+
+    }
+}
+
+State1 -[hidden]right-> State2
+@enduml

docs/diagrams/SetWeak2.puml

@@ -0,0 +1,31 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+hide circle
+hide methods
+
+skinparam ClassFontColor #000000
+skinparam ClassBorderColor #000000
+skinparam ClassBackgroundColor #FFFFAA
+
+title After set weak Command (set weak B+)
+
+package addressBook <<rectangle>> {
+    class State0 as "<U>p0:Person</u>" {
+            studentId = A2345678S
+            grade = A+
+    }
+    class State1 as "<u>p1:Person</u>" {
+        studentId = A0123456X
+        grade = C
+        weak
+    }
+    class State2 as "<u>p2:Person</u>" {
+        studentId = A1234567H
+        grade = B+
+        weak
+    }
+}
+
+State1 -[hidden]right-> State2
+@enduml

docs/diagrams/SetWeakActivityDiagram.puml

@@ -0,0 +1,18 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+start
+:User executes set weak command;
+
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+:Parse grade from command;
+if () then ([Grade is valid])
+    :Update thresholdGrade value;
+else ([else])
+    :Display error message;
+endif
+stop
+@enduml