Generate PG from SFG

Description of issue:

Given a valid SFG, then a PG (presedence graph) should be able to be generated. The PG should describe the order of how operations are done given input and output in a SFG.

Linked Requirements:

( 37, 38 )

Potential Issues:

None

Blockers:

( #12 (closed) )

Issue Requirements:

1. Given a valid SFG, then a new PG should be able to be created.
2. The resulting PG should be correct according to the description of a PG.

Comment:

Please see the course page for more information on what a PG is and what it should represent.

User stories:

1. As a user I want to be able to generate a precedence graph from an SFG.
2. As a developer I want to be able to extract the cyclic precedence of the operations in an SFG from the precedence graph.

added 1 deleted label

changed the description

mentioned in issue #26 (closed)

added 1 deleted label

added 1 deleted label

assigned to @anglo547

changed milestone to %Period 2 Kanban

changed the description

Request user stories review @jacwa448

added 30m of time spent at 2020-04-22

added 1 deleted label and removed 1 deleted label

changed time estimate to 1d 2h

created branch 25-generate-pg-from-sfg to address this issue

Test case that I will be implementing for this issue is to go from pic 1 to pic 2

LGTM

assigned to @jacwa448

added Needs testing label and removed 1 deleted label

Thinking on how the code for this should be implemented and was choosing between having the code in the SFG class or in a new class called Precedence Graph, and decided that having it in a new class would probably be cleaner and more nice since the SFG class already is pretty large in the amount of lines of code.

added 1h of time spent at 2020-04-22

It seems that in a normal SFG such as the material that this test case uses then output ports represent "nodes" and the operations which they travel through to manipulate the value are "edges", this is the reverse of how we normally view "edges" and "nodes" but I don't think that it matters that much since it only changes how they are represented graphically. Perhaps some functionality to name output ports and adding their names to output in some way would be good though.

added Feature development label and removed Needs testing label

unassigned @jacwa448

Add test case for the above example.

added 30m of time spent at 2020-04-22

Added another test case where the second register element is replaced with a Constant operation to test that all operations with no inputs are handled correctly.

Also add working implementation of the PrecedenceGraph constructor that correctly constructs the precedence graph from an SFG.

Will now move the code to the SFG since it was decided that it would better fit.

added 5h of time spent at 2020-04-23

added 1h of time spent at 2020-04-23

Moved code from precedence graph file to sfg file. Removed precedencec graph and schema files. Updated class diagram with new changes.

added 1h 30m of time spent at 2020-04-23

mentioned in merge request !29 (merged)

Added related merge request !29 (merged)

Just realised that currently the dependency of outputs isn't really handled, if an operation with two outputs but they have different dependencies then they will be bundled into the same dependencies anyway.

Added tests that test for different dependencies and code that also solves those test cases correctly.

added 5h of time spent at 2020-04-27

added Needs review label and removed Feature development label

mentioned in issue #27 (closed)

added 1 deleted label and removed Needs review label

closed

removed 1 deleted label

added 1 deleted label