:py:mod:`raesl.excel.sheets`
============================

.. py:module:: raesl.excel.sheets

.. autoapi-nested-parse::

   Excel sheet generation.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   raesl.excel.sheets.add_components_sheet
   raesl.excel.sheets.add_goals_sheet
   raesl.excel.sheets.add_transformations_sheet
   raesl.excel.sheets.add_designs_sheet
   raesl.excel.sheets.add_behaviors_sheet
   raesl.excel.sheets.add_needs_sheet
   raesl.excel.sheets.add_variable_sheet
   raesl.excel.sheets.add_overview_sheet
   raesl.excel.sheets.add_component_active_goals_sheet
   raesl.excel.sheets.add_component_passive_goals_sheet



.. py:function:: add_components_sheet(wb: openpyxl.workbook.Workbook, components: List[ragraph.node.Node]) -> Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

   Add a components overview sheet to an Excel workbook.

   :param wb: Excel workbook to add the components sheet to.
   :param components: List of component nodes.

   :returns: Components worksheet instance.


.. py:function:: add_goals_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) -> Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

   Add a goal requirements sheet to an Excel workbook.

   :param wb: Excel workbook to add the goals sheet to.
   :param graph: Graph to fetch goals from.
   :param components: Component nodes to fetch goals for.

   :returns: Goal requirements worksheet instance.


.. py:function:: add_transformations_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) -> Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

   Add a transformation requirements sheet to an Excel workbook.

   :param wb: Excel workbook to add the transformations sheet to.
   :param graph: Graph to fetch transformation nodes from.
   :param components: Component nodes to fetch transformations for.

   :returns: Transformation requirements worksheet instance.


.. py:function:: add_designs_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) -> Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

   Add a design requirements sheet to an Excel workbook.

   :param wb: Excel workbook to add the design requirements sheet to.
   :param graph: Graph to fetch designrule nodes from.
   :param components: Component nodes to fetch design requirements for.

   :returns: Design requirements worksheet instance.


.. py:function:: add_behaviors_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) -> Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

   Add a behavior requirements sheet to an Excel workbook.

   :param wb: Excel workbook to add the behavior requirements sheet to.
   :param graph: Graph to fetch behavior nodes from.
   :param components: Component nodes to fetch behavior requirements for.

   :returns: Behavior requirements worksheet instance.


.. py:function:: add_needs_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) -> Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

   Add a needs sheet to an Excel workbook.

   :param wb: Excel workbook to add the needs sheet to.
   :param graph: Graph to fetch need nodes from.
   :param components: Component nodes to fetch needs for.

   :returns: Needs worksheet instance.


.. py:function:: add_variable_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) -> Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

   Add a variable sheet to an Excel workbook.

   :param wb: Excel workbook to add the needs sheet to.
   :param graph: Graph to fetch need nodes from.
   :param components: Component nodes to fetch needs for.

   :returns: Needs worksheet instance.


.. py:function:: add_overview_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node], goals: List[ragraph.node.Node], transformations: List[ragraph.node.Node], designs: List[ragraph.node.Node], behaviors: List[ragraph.node.Node], needs: List[ragraph.node.Node]) -> openpyxl.worksheet.worksheet.Worksheet

   Add an overview sheet to an Excel workbook.

   :param wb: Excel workbook to add the needs sheet to.
   :param components: Component nodes.
   :param goals: Goal requirement nodes.
   :param transformations: Transformation requirement nodes.
   :param designs: Design requirement nodes.
   :param behaviors: Behavior requirement nodes.
   :param needs: Need nodes.

   :returns: Overview worksheet instance.


.. py:function:: add_component_active_goals_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, component: ragraph.node.Node, flow_labels: Optional[List[str]] = None)


.. py:function:: add_component_passive_goals_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, component: ragraph.node.Node, flow_labels: Optional[List[str]] = None)