Calculates the connectivity of a schematic and generates netlists. More...

#include <connection_graph.h>

Public Member Functions
	CONNECTION_GRAPH (SCHEMATIC *aSchematic=nullptr)

	~CONNECTION_GRAPH ()

void	Reset ()

void	SetSchematic (SCHEMATIC *aSchematic)

void	SetLastCodes (const CONNECTION_GRAPH *aOther)

void	Recalculate (const SCH_SHEET_LIST &aSheetList, bool aUnconditional=false, std::function< void(SCH_ITEM )> aChangedItemHandler=nullptr)
	Updates the connection graph for the given list of sheets. More...

std::shared_ptr< BUS_ALIAS >	GetBusAlias (const wxString &aName)
	Returns a bus alias pointer for the given name if it exists (from cache) More...

std::vector< const CONNECTION_SUBGRAPH * >	GetBusesNeedingMigration ()
	Determines which subgraphs have more than one conflicting bus label. More...

int	RunERC ()
	Runs electrical rule checks on the connectivity graph. More...

const NET_MAP &	GetNetMap () const

CONNECTION_SUBGRAPH *	FindSubgraphByName (const wxString &aNetName, const SCH_SHEET_PATH &aPath)
	Returns the subgraph for a given net name on a given sheet. More...

CONNECTION_SUBGRAPH *	FindFirstSubgraphByName (const wxString &aNetName)
	Retrieves a subgraph for the given net name, if one exists. More...

CONNECTION_SUBGRAPH *	GetSubgraphForItem (SCH_ITEM *aItem)

const std::vector< CONNECTION_SUBGRAPH * >	GetAllSubgraphs (const wxString &aNetName) const

wxString	GetResolvedSubgraphName (const CONNECTION_SUBGRAPH *aSubGraph) const
	Returns the fully-resolved netname for a given subgraph. More...

std::set< std::pair< SCH_SHEET_PATH, SCH_ITEM * > >	ExtractAffectedItems (const std::set< SCH_ITEM * > &aItems)
	For a set of items, this will remove the connected items and their associated data including subgraphs and generated codes from the connection graph. More...

void	Merge (CONNECTION_GRAPH &aGraph)
	Combines the input graph contents into the current graph. More...

Private Member Functions
void	updateItemConnectivity (const SCH_SHEET_PATH &aSheet, const std::vector< SCH_ITEM * > &aItemList)
	Updates the graphical connectivity between items (i.e. More...

void	buildConnectionGraph (std::function< void(SCH_ITEM )> aChangedItemHandler)
	Generates the connection graph (after all item connectivity has been updated) More...

void	buildItemSubGraphs ()
	Generates individual item subgraphs on a per-sheet basis. More...

void	resolveAllDrivers ()
	Finds all subgraphs in the connection graph and calls ResolveDrivers() in parallel. More...

void	collectAllDriverValues ()
	Maps the driver values for each subgraph. More...

void	generateGlobalPowerPinSubGraphs ()
	Iterate through the global power pins to collect the global labels as drivers. More...

void	generateBusAliasMembers ()
	Iterate through labels to create placeholders for bus elements. More...

void	processSubGraphs ()
	Process all subgraphs to assign netcodes and merge subgraphs based on labels. More...

int	assignNewNetCode (SCH_CONNECTION &aConnection)
	Helper to assign a new net code to a connection. More...

int	getOrCreateNetCode (const wxString &aNetName)

void	assignNetCodesToBus (SCH_CONNECTION *aConnection)
	Ensures all members of the bus connection have a valid net code assigned. More...

void	propagateToNeighbors (CONNECTION_SUBGRAPH *aSubgraph, bool aForce)
	Updates all neighbors of a subgraph with this one's connectivity info. More...

void	removeSubgraphs (std::set< CONNECTION_SUBGRAPH * > &aSubgraphs)
	Removes references to the given subgraphs from all structures in the connection graph. More...

std::shared_ptr< SCH_CONNECTION >	getDefaultConnection (SCH_ITEM aItem, CONNECTION_SUBGRAPH aSubgraph)
	Builds a new default connection for the given item based on its properties. More...

void	recacheSubgraphName (CONNECTION_SUBGRAPH *aSubgraph, const wxString &aOldName)

bool	ercCheckMultipleDrivers (const CONNECTION_SUBGRAPH *aSubgraph)
	If the subgraph has multiple drivers of equal priority that are graphically connected, ResolveDrivers() will have stored the second driver for use by this function, which actually creates the markers. More...

bool	ercCheckNetclassConflicts (const std::vector< CONNECTION_SUBGRAPH * > &subgraphs)

bool	ercCheckBusToNetConflicts (const CONNECTION_SUBGRAPH *aSubgraph)
	Checks one subgraph for conflicting connections between net and bus labels. More...

bool	ercCheckBusToBusConflicts (const CONNECTION_SUBGRAPH *aSubgraph)
	Checks one subgraph for conflicting connections between two bus items. More...

bool	ercCheckBusToBusEntryConflicts (const CONNECTION_SUBGRAPH *aSubgraph)
	Checks one subgraph for conflicting bus entry to bus connections. More...

bool	ercCheckNoConnects (const CONNECTION_SUBGRAPH *aSubgraph)
	Checks one subgraph for proper presence or absence of no-connect symbols. More...

bool	ercCheckFloatingWires (const CONNECTION_SUBGRAPH *aSubgraph)
	Checks one subgraph for floating wires. More...

bool	ercCheckLabels (const CONNECTION_SUBGRAPH *aSubgraph)
	Checks one subgraph for proper connection of labels. More...

int	ercCheckHierSheets ()
	Checks that a hierarchical sheet has at least one matching label inside the sheet for each port on the parent sheet object. More...

size_t	hasPins (const CONNECTION_SUBGRAPH *aLocSubgraph)
	Get the number of pins in a given subgraph. More...

Static Private Member Functions
static SCH_CONNECTION *	matchBusMember (SCH_CONNECTION aBusConnection, SCH_CONNECTION aSearch)
	Search for a matching bus member inside a bus connection. More...

Private Attributes
SCH_SHEET_LIST	m_sheetList

std::vector< SCH_ITEM * >	m_items

std::vector< CONNECTION_SUBGRAPH * >	m_subgraphs

std::vector< CONNECTION_SUBGRAPH * >	m_driver_subgraphs

std::unordered_map< SCH_SHEET_PATH, std::vector< CONNECTION_SUBGRAPH * > >	m_sheet_to_subgraphs_map

std::vector< std::pair< SCH_SHEET_PATH, SCH_PIN * > >	m_global_power_pins

std::unordered_map< wxString, std::shared_ptr< BUS_ALIAS > >	m_bus_alias_cache

std::unordered_map< wxString, int >	m_net_name_to_code_map

std::unordered_map< wxString, int >	m_bus_name_to_code_map

std::unordered_map< wxString, std::vector< const CONNECTION_SUBGRAPH * > >	m_global_label_cache

std::map< std::pair< SCH_SHEET_PATH, wxString >, std::vector< const CONNECTION_SUBGRAPH * > >	m_local_label_cache

std::unordered_map< wxString, std::vector< CONNECTION_SUBGRAPH * > >	m_net_name_to_subgraphs_map

std::unordered_map< SCH_ITEM , CONNECTION_SUBGRAPH >	m_item_to_subgraph_map

NET_MAP	m_net_code_to_subgraphs_map

int	m_last_net_code

int	m_last_bus_code

int	m_last_subgraph_code

SCHEMATIC *	m_schematic
	The schematic this graph represents. More...

Detailed Description

Calculates the connectivity of a schematic and generates netlists.

Definition at line 331 of file connection_graph.h.

Constructor & Destructor Documentation

◆ CONNECTION_GRAPH()

CONNECTION_GRAPH::CONNECTION_GRAPH ( SCHEMATIC * aSchematic = nullptr )

inline

Definition at line 334 of file connection_graph.h.

◆ ~CONNECTION_GRAPH()

CONNECTION_GRAPH::~CONNECTION_GRAPH ( )

inline

Definition at line 341 of file connection_graph.h.

References Reset().

Member Function Documentation

◆ assignNetCodesToBus()

void CONNECTION_GRAPH::assignNetCodesToBus ( SCH_CONNECTION * aConnection )

private

Ensures all members of the bus connection have a valid net code assigned.

Parameters

aConnection is a bus connection

Definition at line 2168 of file connection_graph.cpp.

References assignNewNetCode(), and SCH_CONNECTION::Members().

Referenced by processSubGraphs().

◆ assignNewNetCode()

int CONNECTION_GRAPH::assignNewNetCode ( SCH_CONNECTION & aConnection )

private

Helper to assign a new net code to a connection.

Returns: the assigned code

Definition at line 2158 of file connection_graph.cpp.

References getOrCreateNetCode(), SCH_CONNECTION::Name(), and SCH_CONNECTION::SetNetCode().

Referenced by assignNetCodesToBus(), generateBusAliasMembers(), generateGlobalPowerPinSubGraphs(), and processSubGraphs().

◆ buildConnectionGraph()

void CONNECTION_GRAPH::buildConnectionGraph ( std::function< void(SCH_ITEM *)> * aChangedItemHandler )

private

Generates the connection graph (after all item connectivity has been updated)

In the first phase, the algorithm iterates over all items, and then over all items that are connected (graphically) to each item, placing them into CONNECTION_SUBGRAPHs. Items that can potentially drive connectivity (i.e. labels, pins, etc.) are added to the m_drivers vector of the subgraph.

In the second phase, each subgraph is resolved. To resolve a subgraph, the driver is first selected by CONNECTION_SUBGRAPH::ResolveDrivers(), and then the connection for the chosen driver is propagated to all the other items in the subgraph.

TODO(JE): Net codes are non-deterministic. Fortunately, they are also not really used for anything. We should consider removing them entirely and just using net names everywhere.

Definition at line 1776 of file connection_graph.cpp.

◆ buildItemSubGraphs()

void CONNECTION_GRAPH::buildItemSubGraphs ( )

private

Generates individual item subgraphs on a per-sheet basis.

Definition at line 1079 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::AddItem(), CANDIDATE, SCHEMATIC::GetSheets(), m_bus_alias_cache, CONNECTION_SUBGRAPH::m_code, CONNECTION_SUBGRAPH::m_dirty, m_item_to_subgraph_map, m_items, m_last_subgraph_code, CONNECTION_SUBGRAPH::m_no_connect, m_schematic, CONNECTION_SUBGRAPH::m_sheet, m_subgraphs, SCH_NO_CONNECT_T, SCH_CONNECTION::SetSubgraphCode(), and SCH_CONNECTION::SubgraphCode().

Referenced by buildConnectionGraph().

◆ collectAllDriverValues()

void CONNECTION_GRAPH::collectAllDriverValues ( )

private

Maps the driver values for each subgraph.

Definition at line 1241 of file connection_graph.cpp.

References ConnTrace, EDA_ITEM::GetItemDescription(), m_driver_subgraphs, m_global_label_cache, m_local_label_cache, m_net_name_to_subgraphs_map, name, pin, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, schIUScale, and EDA_ITEM::Type().

Referenced by buildConnectionGraph().

◆ ercCheckBusToBusConflicts()

bool CONNECTION_GRAPH::ercCheckBusToBusConflicts ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Checks one subgraph for conflicting connections between two bus items.

For example, a labeled bus wire connected to a hierarchical sheet pin where the labeled bus doesn't contain any of the same bus members as the sheet pin

Parameters

aSubgraph is the subgraph to examine

Returns: true for no errors, false for errors

Definition at line 2988 of file connection_graph.cpp.

References SCH_SCREEN::Append(), SCH_ITEM::Connection(), ERC_ITEM::Create(), ERCE_BUS_TO_BUS_CONFLICT, EDA_ITEM::GetPosition(), SCH_CONNECTION::IsBus(), SCH_SHEET_PATH::LastScreen(), CONNECTION_SUBGRAPH::m_items, CONNECTION_SUBGRAPH::m_sheet, SCH_CONNECTION::Members(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, and EDA_ITEM::Type().

Referenced by RunERC().

◆ ercCheckBusToBusEntryConflicts()

bool CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Checks one subgraph for conflicting bus entry to bus connections.

For example, a wire with label "A0" is connected to a bus labeled "D[8..0]"

Will also check for mistakes related to bus group names, for example: A bus group named "USB{DP DM}" should have bus entry connections like "USB.DP" but someone might accidentally just enter "DP"

Parameters

aSubgraph is the subgraph to examine

Returns: true for no errors, false for errors

Definition at line 3056 of file connection_graph.cpp.

Referenced by RunERC().

◆ ercCheckBusToNetConflicts()

bool CONNECTION_GRAPH::ercCheckBusToNetConflicts ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Checks one subgraph for conflicting connections between net and bus labels.

For example, a net wire connected to a bus port/pin, or vice versa

Parameters

aSubgraph is the subgraph to examine

Returns: true for no errors, false for errors

Definition at line 2931 of file connection_graph.cpp.

References SCH_SCREEN::Append(), SCH_CONNECTION::ConfigureFromLabel(), ERC_ITEM::Create(), CTX_NETNAME, ERCE_BUS_TO_NET_CONFLICT, EscapeString(), SCH_ITEM::GetLayer(), EDA_ITEM::GetPosition(), SCH_CONNECTION::IsBus(), SCH_SHEET_PATH::LastScreen(), LAYER_BUS, CONNECTION_SUBGRAPH::m_items, CONNECTION_SUBGRAPH::m_sheet, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_LINE_T, SCH_SHEET_PIN_T, text, and EDA_ITEM::Type().

Referenced by RunERC().

◆ ercCheckFloatingWires()

bool CONNECTION_GRAPH::ercCheckFloatingWires ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Checks one subgraph for floating wires.

Will throw an error for any subgraph that consists of just wires with no driver

Parameters

aSubgraph is the subgraph to examine

Returns: true for no errors, false for errors

Definition at line 3382 of file connection_graph.cpp.

References SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_WIRE_DANGLING, SCH_ITEM::GetLayer(), SCH_SHEET_PATH::LastScreen(), LAYER_WIRE, CONNECTION_SUBGRAPH::m_driver, CONNECTION_SUBGRAPH::m_items, CONNECTION_SUBGRAPH::m_sheet, SCH_BUS_WIRE_ENTRY_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by RunERC().

◆ ercCheckHierSheets()

int CONNECTION_GRAPH::ercCheckHierSheets ( )

private

Checks that a hierarchical sheet has at least one matching label inside the sheet for each port on the parent sheet object.

Parameters

aSubgraph is the subgraph to examine

Returns: the number of errors found

Definition at line 3565 of file connection_graph.cpp.

References _, SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_HIERACHICAL_LABEL, ERCE_PIN_NOT_CONNECTED, SCHEMATIC::ErcSettings(), SCH_SHEET::GetPins(), SCH_SHEET::GetScreen(), EDA_TEXT::GetText(), ERC_SETTINGS::IsTestEnabled(), SCH_SCREEN::Items(), m_schematic, m_sheetList, pin, SCH_SHEET_PATH::push_back(), SCH_HIER_LABEL_T, SCH_SHEET_T, and UnescapeString().

Referenced by RunERC().

◆ ercCheckLabels()

bool CONNECTION_GRAPH::ercCheckLabels ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Checks one subgraph for proper connection of labels.

Labels should be connected to something

Parameters

aSubgraph	is the subgraph to examine
aCheckGlobalLabels	is true if global labels should be checked for loneliness

Returns: true for no errors, false for errors

Definition at line 3420 of file connection_graph.cpp.

References SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_GLOBLABEL, ERCE_LABEL_NOT_CONNECTED, SCHEMATIC::ErcSettings(), SCH_TEXT::GetPosition(), GetResolvedSubgraphName(), hasPins(), SCH_CONNECTION::IsBus(), ERC_SETTINGS::IsTestEnabled(), SCH_SHEET_PATH::LastScreen(), CONNECTION_SUBGRAPH::m_driver_connection, CONNECTION_SUBGRAPH::m_items, m_net_name_to_subgraphs_map, CONNECTION_SUBGRAPH::m_no_connect, m_schematic, CONNECTION_SUBGRAPH::m_sheet, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, text, and EDA_ITEM::Type().

Referenced by RunERC().

◆ ercCheckMultipleDrivers()

bool CONNECTION_GRAPH::ercCheckMultipleDrivers ( const CONNECTION_SUBGRAPH * aSubgraph )

private

If the subgraph has multiple drivers of equal priority that are graphically connected, ResolveDrivers() will have stored the second driver for use by this function, which actually creates the markers.

Parameters

aSubgraph is the subgraph to examine

Returns: true for no errors, false for errors

Definition at line 2818 of file connection_graph.cpp.

References _, SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_DRIVER_CONFLICT, CONNECTION_SUBGRAPH::GetNameForDriver(), EDA_ITEM::GetPosition(), SCH_PIN::IsGlobalPower(), SCH_SHEET_PATH::LastScreen(), CONNECTION_SUBGRAPH::m_driver, CONNECTION_SUBGRAPH::m_drivers, CONNECTION_SUBGRAPH::m_first_driver, CONNECTION_SUBGRAPH::m_multiple_drivers, CONNECTION_SUBGRAPH::m_second_driver, CONNECTION_SUBGRAPH::m_sheet, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, and EDA_ITEM::Type().

Referenced by RunERC().

◆ ercCheckNetclassConflicts()

bool CONNECTION_GRAPH::ercCheckNetclassConflicts ( const std::vector< CONNECTION_SUBGRAPH * > & subgraphs )

private

Definition at line 2893 of file connection_graph.cpp.

References ERC_ITEM::Create(), ERCE_NETCLASS_CONFLICT, and EDA_ITEM::GetPosition().

Referenced by RunERC().

◆ ercCheckNoConnects()

bool CONNECTION_GRAPH::ercCheckNoConnects ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Checks one subgraph for proper presence or absence of no-connect symbols.

A pin with a no-connect symbol should not have any connections A pin without a no-connect symbol should have at least one connection

Parameters

aSubgraph is the subgraph to examine

Returns: true for no errors, false for errors

Definition at line 3160 of file connection_graph.cpp.

References SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_NOCONNECT_CONNECTED, ERCE_NOCONNECT_NOT_CONNECTED, ERCE_PIN_NOT_CONNECTED, SCHEMATIC::ErcSettings(), CONNECTION_SUBGRAPH::GetDriverPriority(), EDA_ITEM::GetPosition(), GetResolvedSubgraphName(), SCH_PIN::IsStacked(), ERC_SETTINGS::IsTestEnabled(), KI_FALLTHROUGH, SCH_SHEET_PATH::LastScreen(), m_global_label_cache, CONNECTION_SUBGRAPH::m_items, m_local_label_cache, m_net_name_to_subgraphs_map, CONNECTION_SUBGRAPH::m_no_connect, m_schematic, CONNECTION_SUBGRAPH::m_sheet, name, CONNECTION_SUBGRAPH::NONE, pin, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, and EDA_ITEM::Type().

Referenced by RunERC().

◆ ExtractAffectedItems()

std::set< std::pair< SCH_SHEET_PATH, SCH_ITEM * > > CONNECTION_GRAPH::ExtractAffectedItems ( const std::set< SCH_ITEM * > & aItems )

For a set of items, this will remove the connected items and their associated data including subgraphs and generated codes from the connection graph.

Parameters

aItems A vector of items whose presence should be removed from the graph

Returns: The full set of all items associated with the input items that were removed

Definition at line 649 of file connection_graph.cpp.

References alg::delete_matching(), CONNECTION_SUBGRAPH::m_bus_neighbors, CONNECTION_SUBGRAPH::m_bus_parents, m_item_to_subgraph_map, m_items, and removeSubgraphs().

Referenced by SCH_EDIT_FRAME::RecalculateConnections().

◆ FindFirstSubgraphByName()

CONNECTION_SUBGRAPH * CONNECTION_GRAPH::FindFirstSubgraphByName ( const wxString & aNetName )

Retrieves a subgraph for the given net name, if one exists.

Searches every sheet

Parameters

aNetName is the full net name to search for

Returns: the subgraph matching the query, or nullptr if none is found

Definition at line 2672 of file connection_graph.cpp.

References m_net_name_to_subgraphs_map.

Referenced by SCH_EDIT_FRAME::RecalculateConnections().

◆ FindSubgraphByName()

CONNECTION_SUBGRAPH * CONNECTION_GRAPH::FindSubgraphByName	(	const wxString &	aNetName,
		const SCH_SHEET_PATH &	aPath
	)

Returns the subgraph for a given net name on a given sheet.

Parameters

aNetName	is the local net name to look for
aPath	is a sheet path to look on

Returns: the subgraph matching the query, or nullptr if none is found

Definition at line 2651 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::m_absorbed, CONNECTION_SUBGRAPH::m_driver_connection, m_net_name_to_subgraphs_map, CONNECTION_SUBGRAPH::m_sheet, and SCH_CONNECTION::Name().

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), and NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol().

◆ generateBusAliasMembers()

void CONNECTION_GRAPH::generateBusAliasMembers ( )

private

Iterate through labels to create placeholders for bus elements.

Need to figure out why these sgs are not getting connected to their bus parents

Definition at line 1304 of file connection_graph.cpp.

References assignNewNetCode(), ConnTrace, dummy, CONNECTION_SUBGRAPH::GetNetName(), SCH_SHEET_PATH::GetSheet(), EDA_TEXT::GetText(), CONNECTION_SUBGRAPH::m_code, CONNECTION_SUBGRAPH::m_driver_connection, m_driver_subgraphs, CONNECTION_SUBGRAPH::m_is_bus_member, m_last_subgraph_code, m_net_code_to_subgraphs_map, m_net_name_to_subgraphs_map, CONNECTION_SUBGRAPH::m_sheet, CONNECTION_SUBGRAPH::m_strong_driver, m_subgraphs, name, SCH_CONNECTION::SetGraph(), SCH_CONNECTION::SetName(), and SCH_CONNECTION::SetType().

Referenced by buildConnectionGraph().

◆ generateGlobalPowerPinSubGraphs()

void CONNECTION_GRAPH::generateGlobalPowerPinSubGraphs ( )

private

Iterate through the global power pins to collect the global labels as drivers.

Definition at line 1356 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::AddItem(), assignNewNetCode(), CONNECTION_SUBGRAPH::GetNetName(), CONNECTION_SUBGRAPH::m_code, m_driver_subgraphs, m_global_power_pins, m_last_subgraph_code, m_net_code_to_subgraphs_map, CONNECTION_SUBGRAPH::m_sheet, m_subgraphs, pin, CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_CONNECTION::SetName(), SCH_CONNECTION::SetNetCode(), SCH_CONNECTION::SetSubgraphCode(), and SCH_CONNECTION::SubgraphCode().

Referenced by buildConnectionGraph().

◆ GetAllSubgraphs()

const std::vector< CONNECTION_SUBGRAPH * > CONNECTION_GRAPH::GetAllSubgraphs ( const wxString & aNetName ) const

Definition at line 2697 of file connection_graph.cpp.

References m_net_name_to_subgraphs_map.

Referenced by SCH_EDIT_FRAME::MakeNetNavigatorNode().

◆ GetBusAlias()

std::shared_ptr< BUS_ALIAS > CONNECTION_GRAPH::GetBusAlias ( const wxString & aName )

Returns a bus alias pointer for the given name if it exists (from cache)

CONNECTION_GRAPH caches these, they are owned by the SCH_SCREEN that the alias was defined on. The cache is only used to update the graph.

Definition at line 2571 of file connection_graph.cpp.

References m_bus_alias_cache.

Referenced by SCH_CONNECTION::AppendInfoToMsgPanel(), and SCH_CONNECTION::ConfigureFromLabel().

◆ GetBusesNeedingMigration()

std::vector< const CONNECTION_SUBGRAPH * > CONNECTION_GRAPH::GetBusesNeedingMigration ( )

Determines which subgraphs have more than one conflicting bus label.

See also: DIALOG_MIGRATE_BUSES

Returns: a list of subgraphs that need migration

Definition at line 2579 of file connection_graph.cpp.

References SCH_ITEM::Connection(), ConnTrace, SCH_TEXT::GetShownText(), SCH_CONNECTION::IsBus(), SCH_CONNECTION::m_driver, m_subgraphs, and SCH_CONNECTION::Name().

Referenced by DIALOG_MIGRATE_BUSES::loadGraphData().

◆ getDefaultConnection()

std::shared_ptr< SCH_CONNECTION > CONNECTION_GRAPH::getDefaultConnection	(	SCH_ITEM *	aItem,
		CONNECTION_SUBGRAPH *	aSubgraph
	)

private

Builds a new default connection for the given item based on its properties.

Handles strong drivers (power pins and labels) only

Parameters

aItem	is an item that can generate a connection name
aSubgraph	is used to determine the sheet to use and retrieve the cached name

Returns: a connection generated from the item, or nullptr if item is not valid

Definition at line 2462 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTION_SUBGRAPH::m_sheet, pin, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, and EDA_ITEM::Type().

Referenced by processSubGraphs(), and propagateToNeighbors().

◆ GetNetMap()

const NET_MAP & CONNECTION_GRAPH::GetNetMap ( ) const

inline

Definition at line 396 of file connection_graph.h.

References m_net_code_to_subgraphs_map.

Referenced by SCHEMATIC::GetNetClassAssignmentCandidates(), NETLIST_EXPORTER_XML::makeListOfNets(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ getOrCreateNetCode()

int CONNECTION_GRAPH::getOrCreateNetCode ( const wxString & aNetName )

private

Parameters

aNetName string with the netname for coding

Returns: existing netcode (if it exists) or newly created one

Definition at line 2138 of file connection_graph.cpp.

References m_last_net_code, and m_net_name_to_code_map.

Referenced by assignNewNetCode().

◆ GetResolvedSubgraphName()

wxString CONNECTION_GRAPH::GetResolvedSubgraphName ( const CONNECTION_SUBGRAPH * aSubGraph ) const

Returns the fully-resolved netname for a given subgraph.

Parameters

aSubGraph Reference to the subgraph

Returns: Netname string usable with m_net_name_to_subgraphs_map

Definition at line 2626 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::GetNetName(), and m_net_name_to_subgraphs_map.

Referenced by ercCheckLabels(), and ercCheckNoConnects().

◆ GetSubgraphForItem()

CONNECTION_SUBGRAPH * CONNECTION_GRAPH::GetSubgraphForItem ( SCH_ITEM * aItem )

Definition at line 2685 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::m_absorbed, CONNECTION_SUBGRAPH::m_absorbed_by, and m_item_to_subgraph_map.

Referenced by SCH_CONNECTION::GetNetName(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ hasPins()

size_t CONNECTION_GRAPH::hasPins ( const CONNECTION_SUBGRAPH * aLocSubgraph )

private

Get the number of pins in a given subgraph.

Parameters

aLocSubgraph Subgraph to search

Returns: total number of pins in the subgraph

Referenced by ercCheckLabels().

◆ matchBusMember()

SCH_CONNECTION * CONNECTION_GRAPH::matchBusMember	(	SCH_CONNECTION *	aBusConnection,
		SCH_CONNECTION *	aSearch
	)

staticprivate

Search for a matching bus member inside a bus connection.

For bus groups, this returns a bus member that matches aSearch by name. For bus vectors, this returns a bus member that matches by vector index.

Parameters

aBusConnection	is the bus connection to search
aSearch	is the net connection to search for

Returns: a member of aBusConnection that matches aSearch

Definition at line 2501 of file connection_graph.cpp.

References SCH_CONNECTION::IsBus(), SCH_CONNECTION::LocalName(), SCH_CONNECTION::Members(), SCH_CONNECTION::Type(), and SCH_CONNECTION::VectorIndex().

Referenced by buildConnectionGraph(), and propagateToNeighbors().

◆ Merge()

void CONNECTION_GRAPH::Merge ( CONNECTION_GRAPH & aGraph )

Combines the input graph contents into the current graph.

After merging, the original graph is invalid.

Parameters

aGraph Input graph reference to add to the current graph

Definition at line 498 of file connection_graph.cpp.

References m_bus_name_to_code_map, m_driver_subgraphs, m_global_label_cache, m_global_power_pins, CONNECTION_SUBGRAPH::m_graph, m_item_to_subgraph_map, m_items, m_last_bus_code, m_last_net_code, m_last_subgraph_code, m_local_label_cache, m_net_code_to_subgraphs_map, m_net_name_to_code_map, m_net_name_to_subgraphs_map, m_sheet_to_subgraphs_map, m_subgraphs, and SCH_ITEM::SetConnectionGraph().

Referenced by SCH_EDIT_FRAME::RecalculateConnections().

◆ processSubGraphs()

void CONNECTION_GRAPH::processSubGraphs ( )

private

Process all subgraphs to assign netcodes and merge subgraphs based on labels.

Definition at line 1425 of file connection_graph.cpp.

References assignNetCodesToBus(), assignNewNetCode(), ConnTrace, alg::delete_matching(), getDefaultConnection(), SCH_CONNECTION::IsBus(), SCH_CONNECTION::IsNet(), CONNECTION_SUBGRAPH::m_absorbed, m_bus_name_to_code_map, CONNECTION_SUBGRAPH::m_bus_parents, CONNECTION_SUBGRAPH::m_code, CONNECTION_SUBGRAPH::m_driver, CONNECTION_SUBGRAPH::m_driver_connection, m_driver_subgraphs, CONNECTION_SUBGRAPH::m_drivers, m_last_bus_code, CONNECTION_SUBGRAPH::m_multiple_drivers, m_net_name_to_subgraphs_map, m_sheet_to_subgraphs_map, name, SCH_CONNECTION::Name(), pin, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, SCH_SHEET_PIN_T, schIUScale, SCH_CONNECTION::SetBusCode(), and EDA_ITEM::Type().

Referenced by buildConnectionGraph().

◆ propagateToNeighbors()

void CONNECTION_GRAPH::propagateToNeighbors	(	CONNECTION_SUBGRAPH *	aSubgraph,
		bool	aForce
	)

private

Updates all neighbors of a subgraph with this one's connectivity info.

If this subgraph contains hierarchical links, this method will descent the hierarchy and propagate the connectivity across all linked sheets.

Parameters

aSubgraph	is the subgraph being processed
aForce	prevents this routine from skipping subgraphs

Definition at line 2189 of file connection_graph.cpp.

Referenced by buildConnectionGraph(), and propagateToNeighbors().

◆ recacheSubgraphName()

void CONNECTION_GRAPH::recacheSubgraphName	(	CONNECTION_SUBGRAPH *	aSubgraph,
		const wxString &	aOldName
	)

private

Definition at line 2553 of file connection_graph.cpp.

References ConnTrace, alg::delete_matching(), CONNECTION_SUBGRAPH::m_driver_connection, m_net_name_to_subgraphs_map, and SCH_CONNECTION::Name().

Referenced by propagateToNeighbors().

◆ Recalculate()

void CONNECTION_GRAPH::Recalculate	(	const SCH_SHEET_LIST &	aSheetList,
		bool	aUnconditional = `false`,
		std::function< void(SCH_ITEM )>	aChangedItemHandler = `nullptr`
	)

Updates the connection graph for the given list of sheets.

Parameters

aSheetList	is the list of possibly modified sheets
aUnconditional	is true if an unconditional full recalculation should be done
aChangedItemHandler	an optional handler to receive any changed items

Definition at line 578 of file connection_graph.cpp.

References SCH_SYMBOL::GetUnit(), SCH_SYMBOL::GetUnitSelection(), m_items, m_sheetList, Reset(), SCH_SYMBOL_T, and updateItemConnectivity().

Referenced by EESCHEMA_HELPERS::LoadSchematic(), SCH_EDIT_FRAME::RecalculateConnections(), and SCH_SCREENS::UpdateSymbolLinks().

◆ removeSubgraphs()

void CONNECTION_GRAPH::removeSubgraphs ( std::set< CONNECTION_SUBGRAPH * > & aSubgraphs )

private

Removes references to the given subgraphs from all structures in the connection graph.

Parameters

aSubgraphs set of unique subgraphs to find/remove

Definition at line 701 of file connection_graph.cpp.

References m_bus_name_to_code_map, CONNECTION_SUBGRAPH::m_bus_neighbors, CONNECTION_SUBGRAPH::m_bus_parents, m_driver_subgraphs, m_global_label_cache, m_item_to_subgraph_map, m_local_label_cache, m_net_code_to_subgraphs_map, m_net_name_to_code_map, m_net_name_to_subgraphs_map, m_sheet_to_subgraphs_map, and m_subgraphs.

Referenced by ExtractAffectedItems().

◆ Reset()

void CONNECTION_GRAPH::Reset ( )

Only delete subgraphs of which we are the owner

Definition at line 550 of file connection_graph.cpp.

References m_bus_alias_cache, m_bus_name_to_code_map, m_driver_subgraphs, m_global_label_cache, m_global_power_pins, m_item_to_subgraph_map, m_items, m_last_bus_code, m_last_net_code, m_last_subgraph_code, m_local_label_cache, m_net_code_to_subgraphs_map, m_net_name_to_code_map, m_net_name_to_subgraphs_map, m_sheet_to_subgraphs_map, and m_subgraphs.

Referenced by EESCHEMA_HELPERS::LoadSchematic(), SCH_EDIT_FRAME::OpenProjectFiles(), Recalculate(), SCHEMATIC::Reset(), SCHEMATIC::SetRoot(), and ~CONNECTION_GRAPH().

◆ resolveAllDrivers()

void CONNECTION_GRAPH::resolveAllDrivers ( )

private

Finds all subgraphs in the connection graph and calls ResolveDrivers() in parallel.

Definition at line 1169 of file connection_graph.cpp.

References GetKiCadThreadPool(), m_driver_subgraphs, m_subgraphs, pin, SCH_BUS_WIRE_ENTRY_T, SCH_NO_CONNECT_T, SCH_PIN_T, tp, and EDA_ITEM::Type().

Referenced by buildConnectionGraph().

◆ RunERC()

int CONNECTION_GRAPH::RunERC ( )

Runs electrical rule checks on the connectivity graph.

Precondition: graph is up-to-date

Returns: the number of errors found

NOTE:

We could check that labels attached to bus subgraphs follow the proper format (i.e. actually define a bus).

This check doesn't need to be here right now because labels won't actually be connected to bus wires if they aren't in the right format due to their TestDanglingEnds() implementation.

Definition at line 2711 of file connection_graph.cpp.

References ercCheckBusToBusConflicts(), ercCheckBusToBusEntryConflicts(), ercCheckBusToNetConflicts(), ercCheckFloatingWires(), ercCheckHierSheets(), ercCheckLabels(), ercCheckMultipleDrivers(), ercCheckNetclassConflicts(), ercCheckNoConnects(), ERCE_BUS_ENTRY_CONFLICT, ERCE_BUS_TO_BUS_CONFLICT, ERCE_BUS_TO_NET_CONFLICT, ERCE_DRIVER_CONFLICT, ERCE_GLOBLABEL, ERCE_HIERACHICAL_LABEL, ERCE_LABEL_NOT_CONNECTED, ERCE_NETCLASS_CONFLICT, ERCE_NOCONNECT_CONNECTED, ERCE_NOCONNECT_NOT_CONNECTED, ERCE_PIN_NOT_CONNECTED, ERCE_WIRE_DANGLING, SCHEMATIC::ErcSettings(), ERC_SETTINGS::IsTestEnabled(), m_net_name_to_subgraphs_map, m_schematic, and m_subgraphs.

Referenced by DIALOG_ERC::testErc().

◆ SetLastCodes()

void CONNECTION_GRAPH::SetLastCodes ( const CONNECTION_GRAPH * aOther )

inline

Definition at line 353 of file connection_graph.h.

References m_last_bus_code, m_last_net_code, and m_last_subgraph_code.

Referenced by SCH_EDIT_FRAME::RecalculateConnections().

◆ SetSchematic()

void CONNECTION_GRAPH::SetSchematic ( SCHEMATIC * aSchematic )

inline

Definition at line 348 of file connection_graph.h.

References m_schematic.

◆ updateItemConnectivity()

void CONNECTION_GRAPH::updateItemConnectivity	(	const SCH_SHEET_PATH &	aSheet,
		const std::vector< SCH_ITEM * > &	aItemList
	)

private

Updates the graphical connectivity between items (i.e.

where they touch) The items passed in must be on the same sheet.

In the first phase, all items in aItemList have their connections initialized for the given sheet (since they may have connections on more than one sheet, and each needs to be calculated individually). The graphical connection points for the item are added to a map that stores (x, y) -> [list of items].

Any item that is stored in the list of items that have a connection point at a given (x, y) location will eventually be electrically connected. This means that we can't store SCH_SYMBOLs in this map – we must store a structure that links a specific pin on a symbol back to that symbol: a SCH_PIN_CONNECTION. This wrapper class is a convenience for linking a pin and symbol to a specific (x, y) point.

In the second phase, we iterate over each value in the map, which is a vector of items that have overlapping connection points. After some checks to ensure that the items should actually connect, the items are linked together using ConnectedItems().

As a side effect, items are loaded into m_items for BuildConnectionGraph()

Parameters

aSheet	is the path to the sheet of all items in the list
aItemList	is a list of items to consider

Definition at line 855 of file connection_graph.cpp.

References SCH_ITEM::AddConnectionTo(), SCH_SCREEN::GetBus(), GetKiCadThreadPool(), SCH_ITEM::GetLayer(), SCH_SYMBOL::GetPins(), SCH_SHEET_PATH::LastScreen(), LAYER_BUS, LAYER_BUS_JUNCTION, LAYER_JUNCTION, SCH_BUS_WIRE_ENTRY::m_connected_bus_item, SCH_BUS_BUS_ENTRY::m_connected_bus_items, m_global_power_pins, m_items, name, pin, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_JUNCTION_T, SCH_LINE_T, SCH_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_ITEM::SetConnectivityDirty(), SCH_CONNECTION::SetName(), SCH_CONNECTION::SetType(), and tp.

Referenced by Recalculate().

Member Data Documentation

◆ m_bus_alias_cache

std::unordered_map<wxString, std::shared_ptr<BUS_ALIAS> > CONNECTION_GRAPH::m_bus_alias_cache

private

Definition at line 701 of file connection_graph.h.

Referenced by buildConnectionGraph(), buildItemSubGraphs(), GetBusAlias(), and Reset().

◆ m_bus_name_to_code_map

std::unordered_map<wxString, int> CONNECTION_GRAPH::m_bus_name_to_code_map

private

Definition at line 705 of file connection_graph.h.

Referenced by Merge(), processSubGraphs(), removeSubgraphs(), and Reset().

◆ m_driver_subgraphs

std::vector<CONNECTION_SUBGRAPH*> CONNECTION_GRAPH::m_driver_subgraphs

private

Definition at line 694 of file connection_graph.h.

Referenced by buildConnectionGraph(), collectAllDriverValues(), generateBusAliasMembers(), generateGlobalPowerPinSubGraphs(), Merge(), processSubGraphs(), removeSubgraphs(), Reset(), and resolveAllDrivers().

◆ m_global_label_cache

std::unordered_map<wxString, std::vector<const CONNECTION_SUBGRAPH*> > CONNECTION_GRAPH::m_global_label_cache

private

Definition at line 707 of file connection_graph.h.

Referenced by collectAllDriverValues(), ercCheckNoConnects(), Merge(), removeSubgraphs(), and Reset().

◆ m_global_power_pins

std::vector<std::pair<SCH_SHEET_PATH, SCH_PIN*> > CONNECTION_GRAPH::m_global_power_pins

private

Definition at line 699 of file connection_graph.h.

Referenced by generateGlobalPowerPinSubGraphs(), Merge(), Reset(), and updateItemConnectivity().

◆ m_item_to_subgraph_map

std::unordered_map<SCH_ITEM*, CONNECTION_SUBGRAPH*> CONNECTION_GRAPH::m_item_to_subgraph_map

private

Definition at line 714 of file connection_graph.h.

Referenced by buildItemSubGraphs(), ExtractAffectedItems(), GetSubgraphForItem(), Merge(), removeSubgraphs(), and Reset().

◆ m_items

std::vector<SCH_ITEM*> CONNECTION_GRAPH::m_items

private

Definition at line 688 of file connection_graph.h.

Referenced by buildItemSubGraphs(), ExtractAffectedItems(), Merge(), Recalculate(), Reset(), and updateItemConnectivity().

◆ m_last_bus_code

int CONNECTION_GRAPH::m_last_bus_code

private

Definition at line 720 of file connection_graph.h.

Referenced by Merge(), processSubGraphs(), Reset(), and SetLastCodes().

◆ m_last_net_code

int CONNECTION_GRAPH::m_last_net_code

private

Definition at line 718 of file connection_graph.h.

Referenced by getOrCreateNetCode(), Merge(), Reset(), and SetLastCodes().

◆ m_last_subgraph_code

int CONNECTION_GRAPH::m_last_subgraph_code

private

Definition at line 722 of file connection_graph.h.

Referenced by buildItemSubGraphs(), generateBusAliasMembers(), generateGlobalPowerPinSubGraphs(), Merge(), Reset(), and SetLastCodes().

◆ m_local_label_cache

std::map< std::pair<SCH_SHEET_PATH, wxString>, std::vector<const CONNECTION_SUBGRAPH*> > CONNECTION_GRAPH::m_local_label_cache

private

Definition at line 710 of file connection_graph.h.

Referenced by collectAllDriverValues(), ercCheckNoConnects(), Merge(), removeSubgraphs(), and Reset().

◆ m_net_code_to_subgraphs_map

NET_MAP CONNECTION_GRAPH::m_net_code_to_subgraphs_map

private

Definition at line 716 of file connection_graph.h.

Referenced by buildConnectionGraph(), generateBusAliasMembers(), generateGlobalPowerPinSubGraphs(), GetNetMap(), Merge(), removeSubgraphs(), and Reset().

◆ m_net_name_to_code_map

std::unordered_map<wxString, int> CONNECTION_GRAPH::m_net_name_to_code_map

private

Definition at line 703 of file connection_graph.h.

Referenced by getOrCreateNetCode(), Merge(), removeSubgraphs(), and Reset().

◆ m_net_name_to_subgraphs_map

std::unordered_map<wxString, std::vector<CONNECTION_SUBGRAPH*> > CONNECTION_GRAPH::m_net_name_to_subgraphs_map

private

Definition at line 712 of file connection_graph.h.

Referenced by buildConnectionGraph(), collectAllDriverValues(), ercCheckLabels(), ercCheckNoConnects(), FindFirstSubgraphByName(), FindSubgraphByName(), generateBusAliasMembers(), GetAllSubgraphs(), GetResolvedSubgraphName(), Merge(), processSubGraphs(), recacheSubgraphName(), removeSubgraphs(), Reset(), and RunERC().

◆ m_schematic

SCHEMATIC* CONNECTION_GRAPH::m_schematic

private

The schematic this graph represents.

Definition at line 724 of file connection_graph.h.

Referenced by buildConnectionGraph(), buildItemSubGraphs(), ercCheckHierSheets(), ercCheckLabels(), ercCheckNoConnects(), RunERC(), and SetSchematic().

◆ m_sheet_to_subgraphs_map

std::unordered_map<SCH_SHEET_PATH, std::vector<CONNECTION_SUBGRAPH*> > CONNECTION_GRAPH::m_sheet_to_subgraphs_map

private

Definition at line 697 of file connection_graph.h.

Referenced by buildConnectionGraph(), Merge(), processSubGraphs(), propagateToNeighbors(), removeSubgraphs(), and Reset().

◆ m_sheetList

SCH_SHEET_LIST CONNECTION_GRAPH::m_sheetList

private

Definition at line 685 of file connection_graph.h.

Referenced by ercCheckHierSheets(), and Recalculate().

◆ m_subgraphs

std::vector<CONNECTION_SUBGRAPH*> CONNECTION_GRAPH::m_subgraphs

private

Definition at line 691 of file connection_graph.h.

Referenced by buildItemSubGraphs(), generateBusAliasMembers(), generateGlobalPowerPinSubGraphs(), GetBusesNeedingMigration(), Merge(), removeSubgraphs(), Reset(), resolveAllDrivers(), and RunERC().

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CONNECTION_GRAPH()

◆ ~CONNECTION_GRAPH()

Member Function Documentation

◆ assignNetCodesToBus()

◆ assignNewNetCode()

◆ buildConnectionGraph()

◆ buildItemSubGraphs()

◆ collectAllDriverValues()

◆ ercCheckBusToBusConflicts()

◆ ercCheckBusToBusEntryConflicts()

◆ ercCheckBusToNetConflicts()

◆ ercCheckFloatingWires()

◆ ercCheckHierSheets()

◆ ercCheckLabels()

◆ ercCheckMultipleDrivers()

◆ ercCheckNetclassConflicts()

◆ ercCheckNoConnects()

◆ ExtractAffectedItems()

◆ FindFirstSubgraphByName()

◆ FindSubgraphByName()

◆ generateBusAliasMembers()

◆ generateGlobalPowerPinSubGraphs()

◆ GetAllSubgraphs()

◆ GetBusAlias()

◆ GetBusesNeedingMigration()

◆ getDefaultConnection()

◆ GetNetMap()

◆ getOrCreateNetCode()

◆ GetResolvedSubgraphName()

◆ GetSubgraphForItem()

◆ hasPins()

◆ matchBusMember()

◆ Merge()

◆ processSubGraphs()

◆ propagateToNeighbors()

◆ recacheSubgraphName()

◆ Recalculate()

◆ removeSubgraphs()

◆ Reset()

◆ resolveAllDrivers()

◆ RunERC()

◆ SetLastCodes()

◆ SetSchematic()

◆ updateItemConnectivity()

Member Data Documentation

◆ m_bus_alias_cache

◆ m_bus_name_to_code_map

◆ m_driver_subgraphs

◆ m_global_label_cache

◆ m_global_power_pins

◆ m_item_to_subgraph_map

◆ m_items

◆ m_last_bus_code

◆ m_last_net_code

◆ m_last_subgraph_code

◆ m_local_label_cache

◆ m_net_code_to_subgraphs_map

◆ m_net_name_to_code_map

◆ m_net_name_to_subgraphs_map

◆ m_schematic

◆ m_sheet_to_subgraphs_map

◆ m_sheetList

◆ m_subgraphs