CONNECTION_GRAPH Class Reference

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

#include <connection_graph.h>

Public Member Functions
	CONNECTION_GRAPH (SCHEMATIC *aSchematic=nullptr)
	~CONNECTION_GRAPH ()
	CONNECTION_GRAPH (const CONNECTION_GRAPH &)=delete
CONNECTION_GRAPH &	operator= (const CONNECTION_GRAPH &)=delete
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, PROGRESS_REPORTER *aProgressReporter=nullptr)
	Update the connection graph for the given list of sheets.
std::shared_ptr< BUS_ALIAS >	GetBusAlias (const wxString &aName)
	Return a bus alias pointer for the given name if it exists (from cache)
std::vector< const CONNECTION_SUBGRAPH * >	GetBusesNeedingMigration ()
	Determine which subgraphs have more than one conflicting bus label.
int	RunERC ()
	Run electrical rule checks on the connectivity graph.
const NET_MAP &	GetNetMap () const
CONNECTION_SUBGRAPH *	FindSubgraphByName (const wxString &aNetName, const SCH_SHEET_PATH &aPath)
	Return the subgraph for a given net name on a given sheet.
CONNECTION_SUBGRAPH *	FindFirstSubgraphByName (const wxString &aNetName)
	Retrieve a subgraph for the given net name, if one exists.
CONNECTION_SUBGRAPH *	GetSubgraphForItem (SCH_ITEM *aItem) const
const std::vector< CONNECTION_SUBGRAPH * > &	GetAllSubgraphs (const wxString &aNetName) const
wxString	GetResolvedSubgraphName (const CONNECTION_SUBGRAPH *aSubGraph) const
	Return the fully-resolved netname for a given subgraph.
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.
void	Merge (CONNECTION_GRAPH &aGraph)
	Combine the input graph contents into the current graph.
void	RemoveItem (SCH_ITEM *aItem)
void	ExchangeItem (SCH_ITEM *aOldItem, SCH_ITEM *aNewItem)
	Replace all references to #aOldItem with #aNewItem in the graph.
bool	IsMinor () const
	We modify how we handle the connectivity graph for small graphs vs large graphs.

Private Member Functions
void	updateSymbolConnectivity (const SCH_SHEET_PATH &aSheet, SCH_SYMBOL *aSymbol, std::map< VECTOR2I, std::vector< SCH_ITEM * > > &aConnectionMap)
	Update the connectivity of a symbol and its pins.
void	updatePinConnectivity (const SCH_SHEET_PATH &aSheet, SCH_PIN *aPin, SCH_CONNECTION *aConnection)
	Update the connectivity of a pin and its connections.
void	updateGenericItemConnectivity (const SCH_SHEET_PATH &aSheet, SCH_ITEM *aItem, std::map< VECTOR2I, std::vector< SCH_ITEM * > > &aConnectionMap)
	Update the connectivity of items that are not pins or symbols.
void	updateItemConnectivity (const SCH_SHEET_PATH &aSheet, const std::vector< SCH_ITEM * > &aItemList)
	Update the graphical connectivity between items (i.e.
void	buildConnectionGraph (std::function< void(SCH_ITEM *)> *aChangedItemHandler, bool aUnconditional)
	Generate the connection graph (after all item connectivity has been updated).
void	buildItemSubGraphs ()
	Generate individual item subgraphs on a per-sheet basis.
void	resolveAllDrivers ()
	Find all subgraphs in the connection graph and calls ResolveDrivers() in parallel.
void	collectAllDriverValues ()
	Map the driver values for each subgraph.
void	generateGlobalPowerPinSubGraphs ()
	Iterate through the global power pins to collect the global labels as drivers.
void	generateBusAliasMembers ()
	Iterate through labels to create placeholders for bus elements.
void	processSubGraphs ()
	Process all subgraphs to assign netcodes and merge subgraphs based on labels.
int	assignNewNetCode (SCH_CONNECTION &aConnection)
	Helper to assign a new net code to a connection.
int	getOrCreateNetCode (const wxString &aNetName)
void	assignNetCodesToBus (SCH_CONNECTION *aConnection)
	Ensure all members of the bus connection have a valid net code assigned.
void	propagateToNeighbors (CONNECTION_SUBGRAPH *aSubgraph, bool aForce)
	Update all neighbors of a subgraph with this one's connectivity info.
void	removeSubgraphs (std::set< CONNECTION_SUBGRAPH * > &aSubgraphs)
	Remove references to the given subgraphs from all structures in the connection graph.
std::shared_ptr< SCH_CONNECTION >	getDefaultConnection (SCH_ITEM *aItem, CONNECTION_SUBGRAPH *aSubgraph)
	Build a new default connection for the given item based on its properties.
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.
bool	ercCheckBusToNetConflicts (const CONNECTION_SUBGRAPH *aSubgraph)
	Check one subgraph for conflicting connections between net and bus labels.
bool	ercCheckBusToBusConflicts (const CONNECTION_SUBGRAPH *aSubgraph)
	Check one subgraph for conflicting connections between two bus items.
bool	ercCheckBusToBusEntryConflicts (const CONNECTION_SUBGRAPH *aSubgraph)
	Check one subgraph for conflicting bus entry to bus connections.
bool	ercCheckNoConnects (const CONNECTION_SUBGRAPH *aSubgraph)
	Check one subgraph for proper presence or absence of no-connect symbols.
bool	ercCheckFloatingWires (const CONNECTION_SUBGRAPH *aSubgraph)
	Check one subgraph for floating wires.
bool	ercCheckDanglingWireEndpoints (const CONNECTION_SUBGRAPH *aSubgraph)
	Check one subgraph for dangling wire endpoints.
bool	ercCheckLabels (const CONNECTION_SUBGRAPH *aSubgraph)
	Check one subgraph for proper connection of labels.
int	ercCheckDirectiveLabels ()
	Check directive labels should be connected to something.
int	ercCheckHierSheets ()
	Check that a hierarchical sheet has at least one matching label inside the sheet for each port on the parent sheet object.
int	ercCheckSingleGlobalLabel ()
	Check that a global label is instantiated more that once across the schematic hierarchy.
size_t	hasPins (const CONNECTION_SUBGRAPH *aLocSubgraph)
	Get the number of pins in a given subgraph.

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

Private Attributes
SCH_SHEET_LIST	m_sheetList
	All the sheets in the schematic (as long as we don't have partial updates).
std::vector< SCH_ITEM * >	m_items
	All connectable items in the schematic.
std::vector< CONNECTION_SUBGRAPH * >	m_subgraphs
	The owner of all CONNECTION_SUBGRAPH objects.
std::vector< CONNECTION_SUBGRAPH * >	m_driver_subgraphs
	Cache of a subset of m_subgraphs.
std::unordered_map< SCH_SHEET_PATH, std::vector< CONNECTION_SUBGRAPH * > >	m_sheet_to_subgraphs_map
	Cache to lookup subgraphs in m_driver_subgraphs by sheet path.
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.

Friends
void	boost_test_update_symbol_connectivity ()
void	boost_test_update_generic_connectivity ()

Detailed Description

Calculate the connectivity of a schematic and generates netlists.

Definition at line 358 of file connection_graph.h.

Constructor & Destructor Documentation

CONNECTION_GRAPH() [1/2]

CONNECTION_GRAPH::CONNECTION_GRAPH ( SCHEMATIC * aSchematic = nullptr )

inline

Definition at line 361 of file connection_graph.h.

References m_last_bus_code, m_last_net_code, m_last_subgraph_code, and m_schematic.

Referenced by boost_test_update_generic_connectivity, boost_test_update_symbol_connectivity, CONNECTION_GRAPH(), Merge(), operator=(), and SetLastCodes().

~CONNECTION_GRAPH()

CONNECTION_GRAPH::~CONNECTION_GRAPH ( )

inline

Definition at line 368 of file connection_graph.h.

References Reset().

CONNECTION_GRAPH() [2/2]

CONNECTION_GRAPH::CONNECTION_GRAPH ( const CONNECTION_GRAPH & )

delete

References CONNECTION_GRAPH().

Member Function Documentation

assignNetCodesToBus()

void CONNECTION_GRAPH::assignNetCodesToBus ( SCH_CONNECTION * aConnection )

private

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

Parameters

aConnection

is a bus connection.

Definition at line 2641 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 2631 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, bool aUnconditional )

private

Generate 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.

If the unconitional flag is set, all existing net classes will be removed and re-created. Otherwise, we will preserve existing net classes that do not conflict with the new net classes.

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 2197 of file connection_graph.cpp.

References buildItemSubGraphs(), BUS, SCH_CONNECTION::Clone(), collectAllDriverValues(), SCH_ITEM::Connection(), ConnTrace, DanglingProfileMask, generateBusAliasMembers(), generateGlobalPowerPinSubGraphs(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_SCREENS::GetFirst(), GetKiCadThreadPool(), CONNECTION_SUBGRAPH::GetNameForDriver(), SCH_SCREENS::GetNext(), SCH_LABEL_BASE::GetShownText(), CONNECTION_SUBGRAPH::GLOBAL_POWER_PIN, SCH_CONNECTION::IsBus(), SCH_CONNECTION::IsNet(), SCH_SCREEN::Items(), CONNECTION_SUBGRAPH::m_absorbed, CONNECTION_SUBGRAPH::m_absorbed_by, m_bus_alias_cache, CONNECTION_SUBGRAPH::m_code, CONNECTION_SUBGRAPH::m_dirty, CONNECTION_SUBGRAPH::m_driver_connection, m_driver_subgraphs, CONNECTION_SUBGRAPH::m_drivers, m_net_code_to_subgraphs_map, m_net_name_to_subgraphs_map, m_schematic, CONNECTION_SUBGRAPH::m_sheet, m_sheet_to_subgraphs_map, matchBusMember(), SCH_CONNECTION::Name(), name, EE_RTREE::OfType(), path, pin, processSubGraphs(), propagateToNeighbors(), resolveAllDrivers(), SCH_HIER_LABEL_T, SCH_PIN_T, SCH_SHEET_PIN_T, SCH_CONNECTION::SetType(), PROF_TIMER::Show(), and tp.

Referenced by Recalculate().

buildItemSubGraphs()

void CONNECTION_GRAPH::buildItemSubGraphs ( )

private

Generate individual item subgraphs on a per-sheet basis.

Definition at line 1471 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::AddItem(), CONNECTIVITY_CANDIDATE, SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), 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

Map the driver values for each subgraph.

Definition at line 1634 of file connection_graph.cpp.

References BUS, ConnTrace, EDA_ITEM::GetItemDescription(), m_driver_subgraphs, m_global_label_cache, m_local_label_cache, m_net_name_to_subgraphs_map, MM, 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

Check 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 3454 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

Check 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 3519 of file connection_graph.cpp.

References _, SCH_SCREEN::Append(), BUS, SCH_ITEM::Connection(), ERC_ITEM::Create(), ERCE_BUS_ENTRY_CONFLICT, SCH_CONNECTION::FullLocalName(), CONNECTION_SUBGRAPH::GetDriverPriority(), CONNECTION_SUBGRAPH::GetNameForDriver(), SCH_BUS_ENTRY_BASE::GetPosition(), CONNECTION_SUBGRAPH::GLOBAL_POWER_PIN, SCH_SHEET_PATH::LastScreen(), SCH_BUS_WIRE_ENTRY::m_connected_bus_item, CONNECTION_SUBGRAPH::m_driver, CONNECTION_SUBGRAPH::m_driver_connection, CONNECTION_SUBGRAPH::m_drivers, CONNECTION_SUBGRAPH::m_items, CONNECTION_SUBGRAPH::m_sheet, SCH_CONNECTION::Members(), SCH_CONNECTION::Name(), SCH_SHEET_PATH::PathHumanReadable(), SCH_BUS_WIRE_ENTRY_T, SCH_LINE_T, EDA_ITEM::Type(), and UnescapeString().

Referenced by RunERC().

ercCheckBusToNetConflicts()

bool CONNECTION_GRAPH::ercCheckBusToNetConflicts ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Check 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 3394 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().

ercCheckDanglingWireEndpoints()

bool CONNECTION_GRAPH::ercCheckDanglingWireEndpoints ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Check one subgraph for dangling wire endpoints.

Will throw an error for any subgraph that has wires with only one endpoing

Parameters

aSubgraph

is the subgraph to examine.

Returns

true for no errors, false for errors.

Definition at line 3884 of file connection_graph.cpp.

References _, SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_UNCONNECTED_WIRE_ENDPOINT, SCH_BUS_ENTRY_BASE::GetConnectionPoints(), SCH_LINE::GetConnectionPoints(), SCH_ITEM::GetLayer(), SCH_BUS_ENTRY_BASE::IsEndDangling(), SCH_LINE::IsEndDangling(), SCH_LINE::IsGraphicLine(), SCH_BUS_ENTRY_BASE::IsStartDangling(), SCH_LINE::IsStartDangling(), SCH_SHEET_PATH::LastScreen(), LAYER_WIRE, location, CONNECTION_SUBGRAPH::m_items, CONNECTION_SUBGRAPH::m_sheet, SCH_BUS_WIRE_ENTRY_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by RunERC().

ercCheckDirectiveLabels()

int CONNECTION_GRAPH::ercCheckDirectiveLabels ( )

private

Check directive labels should be connected to something.

Returns

the number of errors found.

Definition at line 4200 of file connection_graph.cpp.

References ERC_ITEM::Create(), ERCE_LABEL_NOT_CONNECTED, SCH_LABEL_BASE::IsDangling(), m_sheetList, SCH_DIRECTIVE_LABEL_T, and text.

Referenced by RunERC().

ercCheckFloatingWires()

bool CONNECTION_GRAPH::ercCheckFloatingWires ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Check 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 3952 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

Check 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 4228 of file connection_graph.cpp.

References _, SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_HIERACHICAL_LABEL, ERCE_PIN_NOT_CONNECTED, SCH_SHEET::GetPins(), SCH_SHEET::GetScreen(), SCH_LABEL_BASE::GetShownText(), ERC_SETTINGS::IsTestEnabled(), SCH_SCREEN::Items(), m_schematic, m_sheetList, name, 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

Check 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 3991 of file connection_graph.cpp.

References SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_LABEL_NOT_CONNECTED, ERCE_LABEL_SINGLE_PIN, SCH_TEXT::GetPosition(), GetResolvedSubgraphName(), hasPins(), SCH_CONNECTION::IsBus(), ERC_SETTINGS::IsTestEnabled(), SCH_SHEET_PATH::LastScreen(), CONNECTION_SUBGRAPH::m_bus_parents, CONNECTION_SUBGRAPH::m_driver_connection, CONNECTION_SUBGRAPH::m_hier_parent, 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 3350 of file connection_graph.cpp.

References _, SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_DRIVER_CONFLICT, CONNECTION_SUBGRAPH::GetNameForDriver(), EDA_ITEM::GetPosition(), CONNECTION_SUBGRAPH::GetSheet(), SCH_PIN::IsPower(), SCH_SHEET_PATH::LastScreen(), CONNECTION_SUBGRAPH::m_driver, CONNECTION_SUBGRAPH::m_drivers, CONNECTION_SUBGRAPH::m_multiple_drivers, 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().

ercCheckNoConnects()

bool CONNECTION_GRAPH::ercCheckNoConnects ( const CONNECTION_SUBGRAPH * aSubgraph )

private

Check 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 3623 of file connection_graph.cpp.

References SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_NOCONNECT_CONNECTED, ERCE_NOCONNECT_NOT_CONNECTED, ERCE_PIN_NOT_CONNECTED, CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_ITEM::GetParentSymbol(), SCH_SYMBOL::GetPin(), EDA_ITEM::GetPosition(), SCH_TEXT::GetPosition(), GetResolvedSubgraphName(), SCH_PIN::GetType(), SYMBOL::IsPower(), SCH_PIN::IsStacked(), ERC_SETTINGS::IsTestEnabled(), SCH_SCREEN::Items(), KI_FALLTHROUGH, SCH_SHEET_PATH::LastScreen(), m_global_label_cache, CONNECTION_SUBGRAPH::m_hier_pins, CONNECTION_SUBGRAPH::m_hier_ports, 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, EE_RTREE::Overlapping(), pin, PT_NC, PT_NIC, PT_POWER_IN, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by RunERC().

ercCheckSingleGlobalLabel()

int CONNECTION_GRAPH::ercCheckSingleGlobalLabel ( )

private

Check that a global label is instantiated more that once across the schematic hierarchy.

Definition at line 4150 of file connection_graph.cpp.

References SCH_SCREEN::Append(), ERC_ITEM::Create(), CTX_NETNAME, ERCE_SINGLE_GLOBAL_LABEL, EscapeString(), EDA_ITEM::GetPosition(), SCH_TEXT::GetShownText(), SCH_SHEET_PATH::LastScreen(), m_sheetList, and SCH_GLOBAL_LABEL_T.

Referenced by RunERC().

ExchangeItem()

void CONNECTION_GRAPH::ExchangeItem	(	SCH_ITEM *	aOldItem,
		SCH_ITEM *	aNewItem )

Replace all references to #aOldItem with #aNewItem in the graph.

Definition at line 665 of file connection_graph.cpp.

References exchange, CONNECTION_SUBGRAPH::ExchangeItem(), SCH_SYMBOL::GetPins(), m_item_to_subgraph_map, m_items, m_schematic, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbols().

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 890 of file connection_graph.cpp.

References ConnTrace, GetAllSubgraphs(), CONNECTION_SUBGRAPH::GetNetName(), SCH_SHEET::GetPins(), SCH_SYMBOL::GetPins(), GetSubgraphForItem(), CONNECTION_SUBGRAPH::m_code, m_items, m_schematic, path, pin, removeSubgraphs(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_SHEET_T, and SCH_SYMBOL_T.

Referenced by SCHEMATIC::RecalculateConnections().

FindFirstSubgraphByName()

CONNECTION_SUBGRAPH * CONNECTION_GRAPH::FindFirstSubgraphByName

(

const wxString &

aNetName

)

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

Search 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 3195 of file connection_graph.cpp.

References m_net_name_to_subgraphs_map.

FindSubgraphByName()

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

Return 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 3173 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(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

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 1710 of file connection_graph.cpp.

References assignNewNetCode(), ConnTrace, dummy, CONNECTION_SUBGRAPH::GetNetName(), SCH_SHEET_PATH::GetSheet(), SCH_LABEL_BASE::GetShownText(), 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, NET, 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 1769 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 3222 of file connection_graph.cpp.

References m_net_name_to_subgraphs_map.

Referenced by ExtractAffectedItems(), SCH_EDIT_FRAME::MakeNetNavigatorNode(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

GetBusAlias()

std::shared_ptr< BUS_ALIAS > CONNECTION_GRAPH::GetBusAlias

(

const wxString &

aName

)

Return 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 3090 of file connection_graph.cpp.

References m_bus_alias_cache.

GetBusesNeedingMigration()

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

(

)

Determine 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 3098 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().

getDefaultConnection()

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

private

Build 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 2987 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTION_SUBGRAPH::m_sheet, 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 433 of file connection_graph.h.

References m_net_code_to_subgraphs_map.

Referenced by BOOST_FIXTURE_TEST_CASE().

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 2611 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

Return 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 3147 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

)

const

Definition at line 3209 of file connection_graph.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), and ExtractAffectedItems().

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().

IsMinor()

bool CONNECTION_GRAPH::IsMinor ( ) const

inline

We modify how we handle the connectivity graph for small graphs vs large graphs.

Partially this is to avoid unneeded complexity for small graphs, where the performance of the graph is not a concern. This is considered a temporary solution until the connectivity graph is refactored with an eye toward partial updates

Definition at line 500 of file connection_graph.h.

References ADVANCED_CFG::GetCfg(), m_items, and ADVANCED_CFG::m_MinorSchematicGraphSize.

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 3020 of file connection_graph.cpp.

References BUS, 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

)

Combine the input graph contents into the current graph.

Warning

After merging, the original graph is invalid.

Parameters

aGraph

Input graph reference to add to the current graph.

Definition at line 607 of file connection_graph.cpp.

References CONNECTION_GRAPH(), m_bus_name_to_code_map, CONNECTION_SUBGRAPH::m_driver_connection, 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, SCH_ITEM::SetConnectionGraph(), and SCH_CONNECTION::SetGraph().

Referenced by SCHEMATIC::RecalculateConnections().

operator=()

CONNECTION_GRAPH & CONNECTION_GRAPH::operator= ( const CONNECTION_GRAPH & )

delete

References CONNECTION_GRAPH().

processSubGraphs()

void CONNECTION_GRAPH::processSubGraphs ( )

private

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

Definition at line 1836 of file connection_graph.cpp.

References assignNetCodesToBus(), assignNewNetCode(), BUS, BUS_GROUP, ConnTrace, 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, MM, SCH_CONNECTION::Name(), name, pin, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, SCH_SHEET_PIN_T, schIUScale, SCH_CONNECTION::SetBusCode(), EDA_ITEM::Type(), and SCH_CONNECTION::Type().

Referenced by buildConnectionGraph().

propagateToNeighbors()

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

private

Update 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 2662 of file connection_graph.cpp.

References SCH_CONNECTION::Clone(), ConnTrace, getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), CONNECTION_SUBGRAPH::GetDriverPriority(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTION_SUBGRAPH::GLOBAL_POWER_PIN, CONNECTION_SUBGRAPH::HIER_LABEL, SCH_CONNECTION::IsBus(), SCH_CONNECTION::IsNet(), kv, SCH_CONNECTION::LocalName(), CONNECTION_SUBGRAPH::m_absorbed, CONNECTION_SUBGRAPH::m_absorbed_by, CONNECTION_SUBGRAPH::m_code, CONNECTION_SUBGRAPH::m_dirty, CONNECTION_SUBGRAPH::m_driver, CONNECTION_SUBGRAPH::m_driver_connection, CONNECTION_SUBGRAPH::m_drivers, CONNECTION_SUBGRAPH::m_graph, CONNECTION_SUBGRAPH::m_hier_children, CONNECTION_SUBGRAPH::m_hier_parent, CONNECTION_SUBGRAPH::m_hier_pins, CONNECTION_SUBGRAPH::m_hier_ports, CONNECTION_SUBGRAPH::m_multiple_drivers, CONNECTION_SUBGRAPH::m_sheet, m_sheet_to_subgraphs_map, CONNECTION_SUBGRAPH::m_strong_driver, matchBusMember(), SCH_CONNECTION::Name(), path, SCH_SHEET_PATH::PathHumanReadable(), pin, propagateToNeighbors(), SCH_SHEET_PATH::push_back(), recacheSubgraphName(), SCH_CONNECTION::Sheet(), SCH_SHEET_PATH::size(), and SCH_CONNECTION::Type().

Referenced by buildConnectionGraph(), and propagateToNeighbors().

recacheSubgraphName()

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

private

Definition at line 3073 of file connection_graph.cpp.

References ConnTrace, 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,
		PROGRESS_REPORTER *	aProgressReporter = nullptr )

Update 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 740 of file connection_graph.cpp.

References buildConnectionGraph(), ConnTrace, DanglingProfileMask, APP_MONITOR::TRANSACTION::Finish(), APP_MONITOR::TRANSACTION::FinishSpan(), SCH_SHEET::GetPins(), SCH_SYMBOL::GetPins(), SCH_ITEM::GetUnit(), SCH_SYMBOL::GetUnitSelection(), PROGRESS_REPORTER::KeepRefreshing(), m_items, m_schematic, m_sheetList, pin, Reset(), SCH_SHEET_T, SCH_SYMBOL_T, PROGRESS_REPORTER::SetCurrentProgress(), SCH_ITEM::SetUnit(), PROF_TIMER::Show(), APP_MONITOR::TRANSACTION::Start(), APP_MONITOR::TRANSACTION::StartSpan(), PROF_TIMER::Stop(), and updateItemConnectivity().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), EESCHEMA_HELPERS::LoadSchematic(), SCHEMATIC::RecalculateConnections(), and SCH_SCREENS::UpdateSymbolLinks().

RemoveItem()

void CONNECTION_GRAPH::RemoveItem

(

SCH_ITEM *

aItem

)

Definition at line 1001 of file connection_graph.cpp.

References CONNECTION_SUBGRAPH::m_absorbed_by, m_item_to_subgraph_map, m_items, and CONNECTION_SUBGRAPH::RemoveItem().

Referenced by SCH_COMMIT::Revert(), and SCH_ITEM::~SCH_ITEM().

removeSubgraphs()

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

private

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

Parameters

aSubgraphs

set of unique subgraphs to find/remove.

Definition at line 1019 of file connection_graph.cpp.

References ConnTrace, 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 712 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(), and ~CONNECTION_GRAPH().

resolveAllDrivers()

void CONNECTION_GRAPH::resolveAllDrivers ( )

private

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

Definition at line 1561 of file connection_graph.cpp.

References ConnTrace, GetKiCadThreadPool(), m_driver_subgraphs, m_subgraphs, pin, PT_NC, 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

(

)

Run 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 3235 of file connection_graph.cpp.

References ercCheckBusToBusConflicts(), ercCheckBusToBusEntryConflicts(), ercCheckBusToNetConflicts(), ercCheckDanglingWireEndpoints(), ercCheckDirectiveLabels(), ercCheckFloatingWires(), ercCheckHierSheets(), ercCheckLabels(), ercCheckMultipleDrivers(), ercCheckNoConnects(), ercCheckSingleGlobalLabel(), ERCE_BUS_ENTRY_CONFLICT, ERCE_BUS_TO_BUS_CONFLICT, ERCE_BUS_TO_NET_CONFLICT, ERCE_DRIVER_CONFLICT, ERCE_HIERACHICAL_LABEL, ERCE_LABEL_NOT_CONNECTED, ERCE_LABEL_SINGLE_PIN, ERCE_NOCONNECT_CONNECTED, ERCE_NOCONNECT_NOT_CONNECTED, ERCE_PIN_NOT_CONNECTED, ERCE_SINGLE_GLOBAL_LABEL, ERCE_UNCONNECTED_WIRE_ENDPOINT, ERCE_WIRE_DANGLING, ERC_SETTINGS::IsTestEnabled(), m_schematic, and m_subgraphs.

SetLastCodes()

void CONNECTION_GRAPH::SetLastCodes ( const CONNECTION_GRAPH * aOther )

inline

Definition at line 389 of file connection_graph.h.

References CONNECTION_GRAPH(), m_last_bus_code, m_last_net_code, and m_last_subgraph_code.

Referenced by BOOST_FIXTURE_TEST_CASE(), and SCHEMATIC::RecalculateConnections().

SetSchematic()

void CONNECTION_GRAPH::SetSchematic ( SCHEMATIC * aSchematic )

inline

Definition at line 384 of file connection_graph.h.

References m_schematic.

Referenced by BOOST_AUTO_TEST_CASE().

updateGenericItemConnectivity()

void CONNECTION_GRAPH::updateGenericItemConnectivity ( const SCH_SHEET_PATH & aSheet, SCH_ITEM * aItem, std::map< VECTOR2I, std::vector< SCH_ITEM * > > & aConnectionMap )

private

Update the connectivity of items that are not pins or symbols.

This is called by updateItemConnectivity() for each item in the schematic that is not a symbol or pin.

Definition at line 1256 of file connection_graph.cpp.

References BUS, SCH_ITEM::ClearConnectedItems(), SCH_ITEM::GetConnectionPoints(), SCH_ITEM::GetLayer(), SCH_ITEM::InitializeConnection(), LAYER_BUS, m_items, NET, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_LINE_T, SCH_PIN_T, SCH_CONNECTION::SetType(), EDA_ITEM::Type(), and updatePinConnectivity().

Referenced by boost_test_update_generic_connectivity, and updateItemConnectivity().

updateItemConnectivity()

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

private

Update 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.

Special case for labels that overlap wires While this is an ERC error as there is not an explicit junction, we want to enforce connectivity for all items under the label position.

Definition at line 1297 of file connection_graph.cpp.

References SCH_ITEM::AddConnectionTo(), SCH_SCREEN::GetBus(), SCH_SHEET::GetFileName(), SCH_ITEM::GetLayer(), SCH_SCREEN::Items(), SCH_SHEET_PATH::Last(), 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_items, EE_RTREE::Overlapping(), pin, alg::remove_duplicates(), SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_JUNCTION_T, SCH_SHEET_T, SCH_SYMBOL_T, updateGenericItemConnectivity(), and updateSymbolConnectivity().

Referenced by Recalculate().

updatePinConnectivity()

void CONNECTION_GRAPH::updatePinConnectivity ( const SCH_SHEET_PATH & aSheet, SCH_PIN * aPin, SCH_CONNECTION * aConnection )

private

Update the connectivity of a pin and its connections.

This is called by updateItemConnectivity() for each pin in the schematic.

Definition at line 1240 of file connection_graph.cpp.

References SCH_ITEM::ClearConnectedItems(), SCH_PIN::GetDefaultNetName(), SCH_PIN::IsGlobalPower(), m_global_power_pins, name, NET, SCH_CONNECTION::SetName(), and SCH_CONNECTION::SetType().

Referenced by updateGenericItemConnectivity().

updateSymbolConnectivity()

void CONNECTION_GRAPH::updateSymbolConnectivity ( const SCH_SHEET_PATH & aSheet, SCH_SYMBOL * aSymbol, std::map< VECTOR2I, std::vector< SCH_ITEM * > > & aConnectionMap )

private

Update the connectivity of a symbol and its pins.

This is called by updateItemConnectivity() for each symbol in the schematic.

Definition at line 1179 of file connection_graph.cpp.

References SCH_ITEM::ClearConnectedItems(), SCH_PIN::GetDefaultNetName(), LIB_SYMBOL::GetDuplicatePinNumbersAreJumpers(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetPin(), SCH_SYMBOL::GetPins(), group, SCH_PIN::IsGlobalPower(), LIB_SYMBOL::JumperPinGroups(), m_global_power_pins, m_items, name, NET, and pin.

Referenced by boost_test_update_symbol_connectivity, and updateItemConnectivity().

Friends And Related Symbol Documentation

boost_test_update_generic_connectivity

void boost_test_update_generic_connectivity ( )

friend

Definition at line 139 of file test_update_items_connectivity.cpp.

References LIB_SYMBOL::AddDrawItem(), BOOST_REQUIRE(), BUS, SCH_ITEM::Connection(), CONNECTION_GRAPH(), SCH_BUS_ENTRY_BASE::GetConnectionPoints(), SCH_LINE::GetEndPoint(), LIB_SYMBOL::GetLibId(), SCH_SYMBOL::GetPins(), SCH_LINE::GetStartPoint(), LAYER_BUS, LAYER_WIRE, SCH_BUS_WIRE_ENTRY::m_connected_bus_item, SCH_BUS_BUS_ENTRY::m_connected_bus_items, m_global_power_pins, NET, pin, PT_POWER_IN, SCH_SHEET_PATH::push_back(), SCH_LINE::SetEndPoint(), LIB_SYMBOL::SetGlobalPower(), SCH_PIN::SetName(), SCH_PIN::SetNumber(), SCH_PIN::SetPosition(), SCH_SYMBOL::SetRef(), SCH_SHEET::SetScreen(), SCH_PIN::SetType(), SCH_CONNECTION::Type(), updateGenericItemConnectivity(), and SCH_SYMBOL::UpdatePins().

boost_test_update_symbol_connectivity

void boost_test_update_symbol_connectivity ( )

friend

Definition at line 38 of file test_update_items_connectivity.cpp.

References LIB_SYMBOL::AddDrawItem(), BOOST_CHECK_EQUAL(), SCH_ITEM::ConnectedItems(), SCH_ITEM::Connection(), CONNECTION_GRAPH(), LIB_SYMBOL::GetLibId(), SCH_SYMBOL::GetPins(), LIB_SYMBOL::JumperPinGroups(), m_global_power_pins, m_items, SCH_CONNECTION::Name(), name, pin, PT_INPUT, PT_POWER_IN, SCH_SHEET_PATH::push_back(), LIB_SYMBOL::SetDuplicatePinNumbersAreJumpers(), LIB_SYMBOL::SetGlobalPower(), SCH_SHEET::SetScreen(), SCH_SYMBOL::SetValueFieldText(), SCH_SYMBOL::UpdatePins(), and updateSymbolConnectivity().

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 817 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 821 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

Cache of a subset of m_subgraphs.

Definition at line 810 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 823 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 815 of file connection_graph.h.

Referenced by boost_test_update_generic_connectivity, boost_test_update_symbol_connectivity, generateGlobalPowerPinSubGraphs(), Merge(), Reset(), updatePinConnectivity(), and updateSymbolConnectivity().

m_item_to_subgraph_map

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

private

Definition at line 830 of file connection_graph.h.

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

m_items

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

private

All connectable items in the schematic.

Definition at line 804 of file connection_graph.h.

Referenced by boost_test_update_symbol_connectivity, buildItemSubGraphs(), ExchangeItem(), ExtractAffectedItems(), IsMinor(), Merge(), Recalculate(), RemoveItem(), Reset(), updateGenericItemConnectivity(), updateItemConnectivity(), and updateSymbolConnectivity().

m_last_bus_code

int CONNECTION_GRAPH::m_last_bus_code

private

Definition at line 836 of file connection_graph.h.

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

m_last_net_code

int CONNECTION_GRAPH::m_last_net_code

private

Definition at line 834 of file connection_graph.h.

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

m_last_subgraph_code

int CONNECTION_GRAPH::m_last_subgraph_code

private

Definition at line 838 of file connection_graph.h.

Referenced by buildItemSubGraphs(), CONNECTION_GRAPH(), 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 826 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 832 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 819 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 828 of file connection_graph.h.

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

m_schematic

SCHEMATIC* CONNECTION_GRAPH::m_schematic

private

The schematic this graph represents.

Definition at line 840 of file connection_graph.h.

Referenced by buildConnectionGraph(), buildItemSubGraphs(), CONNECTION_GRAPH(), ercCheckHierSheets(), ercCheckLabels(), ercCheckNoConnects(), ExchangeItem(), ExtractAffectedItems(), Recalculate(), 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

Cache to lookup subgraphs in m_driver_subgraphs by sheet path.

Definition at line 813 of file connection_graph.h.

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

m_sheetList

SCH_SHEET_LIST CONNECTION_GRAPH::m_sheetList

private

All the sheets in the schematic (as long as we don't have partial updates).

Definition at line 801 of file connection_graph.h.

Referenced by ercCheckDirectiveLabels(), ercCheckHierSheets(), ercCheckSingleGlobalLabel(), and Recalculate().

m_subgraphs

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

private

The owner of all CONNECTION_SUBGRAPH objects.

Definition at line 807 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:

• connection_graph.h
• connection_graph.cpp