Skip to content
Snippets Groups Projects

Add documentation for some SFG methods

Merged Oscar Gustafsson requested to merge sfgdoc into master
1 file
+ 17
0
Compare changes
  • Side-by-side
  • Inline
@@ -747,9 +747,18 @@ class SFG(AbstractOperation):
@@ -747,9 +747,18 @@ class SFG(AbstractOperation):
return self._precedence_list
return self._precedence_list
def show_precedence_graph(self) -> None:
def show_precedence_graph(self) -> None:
 
"""
 
Display the output of :func:`precedence_graph` in the system viewer.
 
"""
self.precedence_graph().view()
self.precedence_graph().view()
def precedence_graph(self) -> Digraph:
def precedence_graph(self) -> Digraph:
 
"""
 
Return the SFG in prededence form in Graphviz format.
 
 
This can be rendered in enriched shells.
 
 
"""
p_list = self.get_precedence_list()
p_list = self.get_precedence_list()
pg = Digraph()
pg = Digraph()
pg.attr(rankdir="LR")
pg.attr(rankdir="LR")
@@ -1378,6 +1387,14 @@ class SFG(AbstractOperation):
@@ -1378,6 +1387,14 @@ class SFG(AbstractOperation):
return Schedule(self, scheduling_algorithm="ASAP").schedule_time
return Schedule(self, scheduling_algorithm="ASAP").schedule_time
 
def iteration_period_bound(self) -> int:
 
"""
 
Return the iteration period bound of the SFG.
 
 
If -1, the SFG does not have any loops and therefore no iteration period bound.
 
"""
 
raise NotImplementedError()
 
def edit(self) -> None:
def edit(self) -> None:
"""Edit SFG in GUI."""
"""Edit SFG in GUI."""
from b_asic.GUI.main_window import start_editor
from b_asic.GUI.main_window import start_editor
Loading