raesl.doc.sections

Module Contents

Functions

node_decomp_level(depth, comps[, h, rich, rich_opts])	Yield a decomposition level intro section.
global_needs_and_designs([h])	Yield a global need and design specification intro section.
get_node_table(→ List)	Returns a Markdown grid table.
comp_node_goal_reqs(→ LineGen)	Yield a goal-requirement section for a component
comp_node_goal_cons(→ LineGen)	Yield a goal-constraint section for a component
comp_node_transformation_reqs(→ LineGen)	Yield a transformation requirements section for a component.
comp_node_transformation_cons(→ LineGen)	Yield a transformation constraints section for a component.
comp_node_behavior_reqs(→ LineGen)	Yield a behavior requirement section for a component node.
comp_node_behavior_cons(→ LineGen)	Yield a behavior constraint section for a component node.
comp_node_design_reqs(→ LineGen)	Yield a design requirements section for a component node.
global_design_reqs(→ LineGen)	Yield a global design requirements section.
comp_node_design_cons(→ LineGen)	Yield a design constraint section for a component node.
global_design_cons(→ LineGen)	Yield a global design constraint section.
comp_node_needs(→ LineGen)	Yield a need section for a component node.
global_needs(→ LineGen)	Yield a global need section.
relation_node_table(→ List)
comp_node_relations(→ LineGen)	Yield a relation section for a component.
comp_node_props(→ LineGen)	Yield a properties section for a component node
comp_node_subcomps(node[, h])	Yield a subcomponents sections for a component.
var_node_table(→ LineGen)	Yield a variable table section.
get_var_table_row_elements(→ str)	Yield elements of a row in a var table.

Attributes

LineGen
TABLE_SINGLE
TABLE_LEFT_DOUBLE

raesl.doc.sections.LineGen

raesl.doc.sections.TABLE_SINGLE = '+------------------------------------------------------------------------------------------------+'

raesl.doc.sections.TABLE_LEFT_DOUBLE = '+:===============================================================================================+'

raesl.doc.sections.node_decomp_level(depth: int, comps: List[ragraph.node.Node], h: int = 1, rich: str = None, rich_opts: dict = {})

Yield a decomposition level intro section.

raesl.doc.sections.global_needs_and_designs(h: int = 1)

Yield a global need and design specification intro section.

raesl.doc.sections.get_node_table(node: ragraph.node.Node, graph: ragraph.graph.Graph | None = None, sub_nodes: List[str] | None = None) → List

Returns a Markdown grid table.

raesl.doc.sections.comp_node_goal_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a goal-requirement section for a component

raesl.doc.sections.comp_node_goal_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a goal-constraint section for a component

raesl.doc.sections.comp_node_transformation_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a transformation requirements section for a component.

raesl.doc.sections.comp_node_transformation_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a transformation constraints section for a component.

raesl.doc.sections.comp_node_behavior_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a behavior requirement section for a component node.

raesl.doc.sections.comp_node_behavior_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a behavior constraint section for a component node.

raesl.doc.sections.comp_node_design_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a design requirements section for a component node.

raesl.doc.sections.global_design_reqs(g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a global design requirements section.

raesl.doc.sections.comp_node_design_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a design constraint section for a component node.

raesl.doc.sections.global_design_cons(g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a global design constraint section.

raesl.doc.sections.comp_node_needs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a need section for a component node.

raesl.doc.sections.global_needs(g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a global need section.

raesl.doc.sections.relation_node_table(r: ragraph.node.Node, g: ragraph.graph.Graph) → List

raesl.doc.sections.comp_node_relations(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) → LineGen

Yield a relation section for a component.

raesl.doc.sections.comp_node_props(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int) → LineGen

Yield a properties section for a component node

raesl.doc.sections.comp_node_subcomps(node: ragraph.node.Node, h: int = 1)

Yield a subcomponents sections for a component.

raesl.doc.sections.var_node_table(g: ragraph.graph.Graph, h: int = 1, reference_list: bool = False) → LineGen

Yield a variable table section.

raesl.doc.sections.get_var_table_row_elements(g: ragraph.graph.Graph, v: ragraph.node.Node) → str

Yield elements of a row in a var table.