feedtwin.pid.document.Diagram Class Reference

Public Member Functions
PidNode|None	node (self, str node_id)
list[PidNode]	of_type (self, *str types)
list[str]	pages (self)
Diagram	on_page (self, str page)

Static Public Attributes
tuple	nodes [PidNode, ...]
tuple	edges [PidEdge, ...]
str	name = ""

Detailed Description

A whole drawing.

Definition at line 121 of file document.py.

Member Function Documentation

node()

PidNode | None feedtwin.pid.document.Diagram.node	(		self,
		str	node_id )

Definition at line 128 of file document.py.

References nodes.

of_type()

list[PidNode] feedtwin.pid.document.Diagram.of_type	(		self,
		*str	types )

Definition at line 131 of file document.py.

References nodes.

on_page()

Diagram feedtwin.pid.document.Diagram.on_page	(		self,
		str	page )

The drawing restricted to one page, with dangling edges dropped.

Definition at line 140 of file document.py.

References edges, and nodes.

pages()

list[str] feedtwin.pid.document.Diagram.pages

(

self

)

Page names; a node with none is on "Main", as pid-designer reads it.

Definition at line 136 of file document.py.

References nodes.

Member Data Documentation

edges

tuple feedtwin.pid.document.Diagram.edges [PidEdge, ...]

static

Definition at line 125 of file document.py.

Referenced by on_page().

name

str feedtwin.pid.document.Diagram.name = ""

static

Definition at line 126 of file document.py.

Referenced by csv_to_eng.core.EngineMetadata.header_line().

nodes

tuple feedtwin.pid.document.Diagram.nodes [PidNode, ...]

static

Definition at line 124 of file document.py.

Referenced by feedtwin.solve.network.Network._peel(), feedtwin.solve.network.Network.add_branch(), feedtwin.solve.network.Network.add_node(), feedtwin.session.network_trace.NetworkTrace.append(), engine.stability_hifi.acoustics.mesh.MeridionalMesh.axis_nodes(), feedtwin.solve.network.Network.conditions(), feedtwin.solve.network.Network.dead_ends(), feedtwin.solve.network.Network.fixed_nodes(), feedtwin.solve.network.Network.free_nodes(), engine.stability_hifi.acoustics.mesh.MeridionalMesh.locate_point(), engine.stability_hifi.acoustics.mesh.MeridionalMesh.n_nodes(), node(), engine.stability_hifi.acoustics.mesh.MeridionalMesh.nodes_at_x(), of_type(), on_page(), pages(), feedtwin.session.network_trace.NetworkTrace.record(), and feedtwin.session.burn.BurnTrace.recorder().

---

The documentation for this class was generated from the following file:

• lib/feedtwin/feedtwin/pid/document.py