Merge pull request #23 from iss2022-BCR/sprint2

Sprint2
iss2022-BCR · Apr 13, 2023 · f3dc7fb · f3dc7fb
2 parents 0b9d904 + 00a6c20
commit f3dc7fb
Show file tree

Hide file tree

Showing 299 changed files with 13,053 additions and 1,644 deletions.
diff --git a/Sprint0/index.html b/Sprint0/index.html
@@ -24,8 +24,7 @@
             </div>
             <a href="resources/userDocs/final_theme.html">Final Theme</a>
             <a href="resources/userDocs/requirement_analysis.html">Requirement<br/>Analysis</a>
-            <a href="resources/userDocs/problem_analysis.html">Problem Analysis</a>
-            <a href="resources/userDocs/project.html">Project</a>
+            <a href="resources/userDocs/legend.html">Legend</a>
             <a href="resources/userDocs/conclusions.html">Conclusions</a>
             <a href="resources/userDocs/team.html">Team</a>
             <p class="separator">&mdash;&mdash;&mdash;&ndash;&ndash;&mdash;&mdash;&mdash;</p>

diff --git a/Sprint0/resources/userDocs/conclusions.html b/Sprint0/resources/userDocs/conclusions.html
@@ -18,8 +18,7 @@
             <a href="../../index.html">Index</a>
             <a href="final_theme.html">Final Theme</a>
             <a href="requirement_analysis.html">Requirement<br/>Analysis</a>
-            <a href="problem_analysis.html">Problem Analysis</a>
-            <a href="project.html">Project</a>
+            <a href="legend.html">Legend</a>
             <a class="selected" href="conclusions.html">Conclusions</a>
             <div class="sidenavSection">
                 <a href="#Summary">Summary</a>

diff --git a/Sprint0/resources/userDocs/final_theme.html b/Sprint0/resources/userDocs/final_theme.html
@@ -33,8 +33,7 @@
                 </div>
             </div>
             <a href="requirement_analysis.html">Requirement<br/>Analysis</a>
-            <a href="problem_analysis.html">Problem Analysis</a>
-            <a href="project.html">Project</a>
+            <a href="legend.html">Legend</a>
             <a href="conclusions.html">Conclusions</a>
             <a href="team.html">Team</a>
             <p class="separator">&mdash;&mdash;&mdash;&ndash;&ndash;&mdash;&mdash;&mdash;</p>

diff --git a/Sprint0/resources/userDocs/legend.html b/Sprint0/resources/userDocs/legend.html
@@ -0,0 +1,90 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+    <head>
+        <title>Sprint0</title>
+        <link rel="stylesheet" type="text/css" href="../../../commons/resources/styles/templateISS.css">
+        <link rel="stylesheet" type="text/css" href="../../../commons/resources/styles/main.css">
+        <link rel="stylesheet" type="text/css" href="../../../commons/resources/styles/navbar.css">
+        <link rel="stylesheet" type="text/css" href="../../../commons/resources/styles/table.css">
+        <link rel="stylesheet" type="text/css" href="../../../commons/resources/styles/code.css">
+        <script type="text/javascript" src="../../../commons/resources/scripts/myScripts.js"></script>
+    </head>
+
+    <body onload="loadNav();">
+        <div id="openButton" class="openButton" onclick="openNav(true)">&#9776; Menu</div>
+        <div id="sidenav" class="sidenav">
+            <a class="closeButton" href="javascript:void(0)" onclick="closeNav(true)">&times;</a>
+            <a id="currentSprint" class="sprint" href="#">&#8211;&#8212; Sprint0 &#8212;&#8211;</a>
+            <a href="../../index.html">Index</a>
+            <a href="final_theme.html">Final Theme</a>
+            <a href="requirement_analysis.html">Requirement<br/>Analysis</a>
+            <a class="selected" href="legend.html">Legend</a>
+            <a href="conclusions.html">Conclusions</a>
+            <a href="team.html">Team</a>
+            <p class="separator">&mdash;&mdash;&mdash;&ndash;&ndash;&mdash;&mdash;&mdash;</p>
+            <a class="sprint" href="../../../Sprint1/index.html">Sprint1</a>
+            <a class="sprint" href="../../../Sprint2/index.html">Sprint2</a>
+            <a class="sprint" href="../../../Sprint3/index.html">Sprint3</a>
+            <bottom-spacer/>
+        </div>
+
+        <div id="main">
+            <h1 align="center">Legend</h1>
+
+            <h2 id="General">General</h2>
+
+            <h3 id="Sections">Sections</h3>
+            The problem analysis will be subdivided in a hierarchy of sections,
+            denoted by colored boxes:
+
+            <ul>
+                <li>
+                    <h1>Part of the current Sprint</h1>
+                    Only one per file, it represents the document title.
+                </li>
+                <li>
+                    <h2>Macro topic</h2>
+                    Groups one or many sub-topics.
+                </li>
+                <li>
+                    <h3>Sub-topic</h3>
+                    Concerns a small topic.
+                </li>
+                <li>
+                    <h4>Miscellaneous, extras or related content</h4>
+                    Contains extra details or additional information.
+                </li>
+                <li>
+                    <div class="remark">Single important parts</div>
+                    Used to remark important parts, independently from the
+                    section/topic location.
+                </li>
+            </ul>
+
+            <h2 id="Problem-Analysis">Problem Analysis</h2>
+            Along the analysis, we'll point out some problems which needs to be
+            analysed, discussed and for wchich one or multiple solution/s
+            has/have to be found.
+            <br/><br/>
+            In general, for each topic or problem, we will have the following blocks:
+            <ul>
+                <li>
+                    <problem>The problem</problem>
+                    This is usually followed by a series of questions.
+                </li>
+                <li>
+                    <consideration>Considerations, possible solutions or alternatives</consideration>
+                    Contains the densest part of the analysis, where our team discusses
+                    and does brainstorming to try to gather and address each possible aspect
+                    of a problem.
+                </li>
+                <li>
+                    <solution>One or more solution described more or less in detail</solution>
+                    Highlights the solution/s that we are going to adopt or try to implement
+                    in the following phases of the sprint.
+                </li>
+            </ul>
+        </div>
+    </body>
+
+</html>
diff --git a/Sprint0/resources/userDocs/problem_analysis.html b/Sprint0/resources/userDocs/problem_analysis.html
diff --git a/Sprint0/resources/userDocs/project.html b/Sprint0/resources/userDocs/project.html
diff --git a/Sprint0/resources/userDocs/requirement_analysis.html b/Sprint0/resources/userDocs/requirement_analysis.html
@@ -44,8 +44,7 @@
                 </div>
                 <a href="#Test-Plans">Test Plans</a>
             </div>
-            <a href="problem_analysis.html">Problem Analysis</a>
-            <a href="project.html">Project</a>
+            <a href="legend.html">Legend</a>
             <a href="conclusions.html">Conclusions</a>
             <a href="team.html">Team</a>
             <p class="separator">&mdash;&mdash;&mdash;&ndash;&ndash;&mdash;&mdash;&mdash;</p>

diff --git a/Sprint0/resources/userDocs/team.html b/Sprint0/resources/userDocs/team.html
@@ -18,8 +18,7 @@
             <a href="../../index.html">Index</a>
             <a href="final_theme.html">Final Theme</a>
             <a href="requirement_analysis.html">Requirement<br/>Analysis</a>
-            <a href="problem_analysis.html">Problem Analysis</a>
-            <a href="project.html">Project</a>
+            <a href="legend.html">Legend</a>
             <a href="conclusions.html">Conclusions</a>
             <a class="selected" href="team.html">Team</a>
             <p class="separator">&mdash;&mdash;&mdash;&ndash;&ndash;&mdash;&mdash;&mdash;</p>

diff --git a/Sprint1/resources/userDocs/problem_analysis.html b/Sprint1/resources/userDocs/problem_analysis.html
@@ -113,10 +113,11 @@ <h3 id="Waste-Service">Waste Service</h3>
             <problem>Service Area Representation</problem>
             <b>Problem</b>: How do we represent the Service Area?
             <br/>
-            <solution>
+            <consideration>
                 <b>Consideration</b>:
-                According to the requirements notes, the robot doesn't have to move optimally but shouldn't even wander too much around the room. 
-                <br/>
+                according to the requirements notes, the robot doesn't have to move optimally but shouldn't even wander too much around the room. 
+            </consideration>
+            <solution>
                 <b>Solution</b>: 
                 <ul>
                     <li>
@@ -220,8 +221,9 @@ <h5 id="Configure-Map-Locations">Configure Map Locations</h5>
             <h3 id="Transport-Trolley-and-DDR-Robot">Transport Trolley and DDR Robot</h3>
             <problem>Robot Concepts</problem>
             <b>Problem</b>: what is the Transport Trolley and what is the DDR Robot?
-            <solution>
-                <b>Considerations</b>: The DDR Robot is the final endpoint of the core-business chain,
+
+            <consideration>
+                <b>Considerations</b>: the DDR Robot is the final endpoint of the core-business chain,
                 the entity that performs the deposit actions and dumps the waste into the containers.
                 Therefore we can think of it as the actual "robot", which might be real or virtual (e.g. for
                 simulation purposes).
@@ -240,7 +242,9 @@ <h3 id="Transport-Trolley-and-DDR-Robot">Transport Trolley and DDR Robot</h3>
                     </tr>
                 </table>
 
-                <br/>
+                <br/>    
+            </consideration>
+            <solution>
                 <b>Solution</b>: we can use the BasicRobot QAK actor, provided by the customer together with unibo.basicRobot22 project,
                 to have both a <ksi>virtual environment</ksi> to simulate the DDR Robot (WEnv/VirtualRobot), and a <ksi>virtual interface</ksi> to communicate with it (BasicRobot).
                 <br/><br/>
@@ -417,18 +421,20 @@ <h3 id="Smart-Device-Waste-Service">Smart Device &harr; Waste Service</h3>
             <problem>Waste Types</problem>
             <b>Problem</b>: how does the smart device know which types of waste can be dumped to the waste service?
             <br/>
-            <b>Possible solution</b>: hard-code the types into the Smart Device.
-            <br/>
-            <b>Considerations</b>:
-            <ol>
-                <li>
-                    <b>Pros</b>: this is the easiest solution to implement, since they can be just implemented as a list or an enumerative.
-                </li>
-                <li>
-                    <b>Cons</b>: not scalable, since it doesn't allow the Waste Service to have different waste containers but
-                    the ones initially specified by the customer in the requirements.
-                </li>
-            </ol>
+            <consideration>
+                <b>Possible solution</b>: hard-code the types into the Smart Device.
+                <br/>
+                <b>Considerations</b>:
+                <ol>
+                    <li>
+                        <b>Pros</b>: this is the easiest solution to implement, since they can be just implemented as a list or an enumerative.
+                    </li>
+                    <li>
+                        <b>Cons</b>: not scalable, since it doesn't allow the Waste Service to have different waste containers but
+                        the ones initially specified by the customer in the requirements.
+                    </li>
+                </ol>
+            </consideration>
             <solution>
                 <b>Better solution</b>: <ksi>ask the Waste Service for the allowed waste types</ksi>, along with the
                 connection message, and update the Smart Device list to be chosen.
@@ -478,32 +484,36 @@ <h3 id="Smart-Device-Waste-Service">Smart Device &harr; Waste Service</h3>
                     </li>
                 </ul>
             </solution>
-            <b>Eventual extra features</b>: having a security layer which allows only trusted devices to send store requests.
-            This way, by knowing that the smart device will always be an original one (produced and deployed by our
-            software house), we know for sure that a certain behaviour will be respected,
-            therefore it won't be possible to send invalid store requests.
-
+            <alternative>
+                <b>Eventual extra features</b>: having a security layer which allows only trusted devices to send store requests.
+                This way, by knowing that the smart device will always be an original one (produced and deployed by our
+                software house), we know for sure that a certain behaviour will be respected,
+                therefore it won't be possible to send invalid store requests.
+            </alternative>
+
             <problem>Replies and Waste Truck Dismiss</problem>
             <b>Problem</b>: when is the reply sent and what message do we send? Do we introduce other messages apart from loadaccepted and loadrejected?
             How do we know immediately if the Waste Service can store the waste of a new request? How can we meet the requirement that
             the waste truck must be sent away as soon as possible?
             <br/>
-            <b>Considerations</b>:
-            <ul>
-                <li>
-                    The Waste Service might receive a new request while it is handling another one.
-                </li>
-                <li>The pickup action takes some time (a defined and known amount).</li>
-                <li>
-                    If the Smart Device sends a request while there is another deposit action
-                    in progress, it must wait it to be completed.
-                </li>
-                <li>
-                    If we're able to know if the load can be deposited as soon as we receive the request,
-                    we could reply instantly, and therefore meet the <em>requirement</em> that the truck driver must
-                    be sent away <i>as soon as possible</i>.
-                </li>
-            </ul>
+            <consideration>
+                <b>Considerations</b>:
+                <ul>
+                    <li>
+                        The Waste Service might receive a new request while it is handling another one.
+                    </li>
+                    <li>The pickup action takes some time (a defined and known amount).</li>
+                    <li>
+                        If the Smart Device sends a request while there is another deposit action
+                        in progress, it must wait it to be completed.
+                    </li>
+                    <li>
+                        If we're able to know if the load can be deposited as soon as we receive the request,
+                        we could reply instantly, and therefore meet the <em>requirement</em> that the truck driver must
+                        be sent away <i>as soon as possible</i>.
+                    </li>
+                </ul>
+            </consideration>
             <solution>
                 <b>Adopted solution</b>:
                 <ul>

diff --git a/Sprint2/Sprint2_ProblemAnalysis/.idea/.name b/Sprint2/Sprint2_ProblemAnalysis/.idea/.name