A subgraph is a set of items that are electrically connected on a single sheet. More...

#include <connection_graph.h>

Public Types
enum class	PRIORITY { INVALID = -1 , NONE = 0 , PIN , SHEET_PIN , HIER_LABEL , LOCAL_LABEL , POWER_PIN , GLOBAL }

Public Member Functions
	CONNECTION_SUBGRAPH (CONNECTION_GRAPH *aGraph)

	~CONNECTION_SUBGRAPH ()=default

bool	ResolveDrivers (bool aCheckMultipleDrivers=false)
	Determines which potential driver should drive the subgraph. More...

wxString	GetNetName () const
	Returns the fully-qualified net name for this subgraph (if one exists) More...

std::vector< SCH_ITEM * >	GetBusLabels () const
	Returns all the bus labels attached to this subgraph (if any) More...

const wxString &	GetNameForDriver (SCH_ITEM *aItem) const
	Returns the candidate net name for a driver. More...

const wxString	GetNetclassForDriver (SCH_ITEM *aItem) const

void	Absorb (CONNECTION_SUBGRAPH *aOther)
	Combines another subgraph on the same sheet into this one. More...

void	AddItem (SCH_ITEM *aItem)
	Adds a new item to the subgraph. More...

void	UpdateItemConnections ()
	Updates all items to match the driver connection. More...

const std::vector< SCH_ITEM * > &	GetItems () const
	Provides a read-only reference to the items in the subgraph. More...

PRIORITY	GetDriverPriority ()

const SCH_ITEM *	GetDriver () const

const SCH_CONNECTION *	GetDriverConnection () const

const SCH_ITEM *	GetNoConnect () const

const SCH_SHEET_PATH &	GetSheet () const

Static Public Member Functions
static PRIORITY	GetDriverPriority (SCH_ITEM *aDriver)
	Return the priority (higher is more important) of a candidate driver. More...

Private Member Functions
wxString	driverName (SCH_ITEM *aItem) const

Private Attributes
CONNECTION_GRAPH *	m_graph

bool	m_dirty

bool	m_absorbed
	True if this subgraph has been absorbed into another. No pointers here are safe if so! More...

CONNECTION_SUBGRAPH *	m_absorbed_by
	If this subgraph is absorbed, points to the absorbing (and valid) subgraph. More...

long	m_code

bool	m_multiple_drivers
	True if this subgraph contains more than one driver that should be shorted together in the netlist. More...

bool	m_strong_driver
	True if the driver is "strong": a label or power object. More...

bool	m_local_driver
	True if the driver is a local (i.e. non-global) type. More...

SCH_ITEM *	m_bus_entry
	Bus entry in graph, if any. More...

std::vector< SCH_ITEM * >	m_drivers

std::unordered_map< std::shared_ptr< SCH_CONNECTION >, std::unordered_set< CONNECTION_SUBGRAPH * > >	m_bus_neighbors
	If a subgraph is a bus, this map contains links between the bus members and any local sheet neighbors with the same connection name. More...

std::unordered_map< std::shared_ptr< SCH_CONNECTION >, std::unordered_set< CONNECTION_SUBGRAPH * > >	m_bus_parents
	If this is a net, this vector contains links to any same-sheet buses that contain it. More...

std::vector< SCH_SHEET_PIN * >	m_hier_pins

std::vector< SCH_HIERLABEL * >	m_hier_ports

CONNECTION_SUBGRAPH *	m_hier_parent

std::unordered_map< SCH_ITEM *, wxString >	m_driver_name_cache
	A cache of escaped netnames from schematic items. More...

SCH_ITEM *	m_driver
	Fully-resolved driver for the subgraph (might not exist in this subgraph) More...

SCH_ITEM *	m_first_driver
	Stores the primary driver for the multiple drivers ERC check. More...

SCH_ITEM *	m_second_driver
	Used for multiple drivers ERC message; stores the second possible driver (or nullptr) More...

std::vector< SCH_ITEM * >	m_items
	Contents of the subgraph. More...

SCH_ITEM *	m_no_connect
	No-connect item in graph, if any. More...

SCH_SHEET_PATH	m_sheet
	On which logical sheet is the subgraph contained. More...

SCH_CONNECTION *	m_driver_connection
	Cache for driver connection. More...

Friends
class	CONNECTION_GRAPH

Detailed Description

A subgraph is a set of items that are electrically connected on a single sheet.

For example, a label connected to a wire and so on. A net is composed of one or more subgraphs.

A set of items that appears to be physically connected may actually be more than one subgraph, because some items don't connect electrically.

For example, multiple bus wires can come together at a junction but have different labels on each branch. Each label+wire branch is its own subgraph.

Definition at line 60 of file connection_graph.h.

Member Enumeration Documentation

◆ PRIORITY

enum class CONNECTION_SUBGRAPH::PRIORITY

strong

Enumerator
INVALID
NONE
PIN
SHEET_PIN
HIER_LABEL
LOCAL_LABEL
POWER_PIN
GLOBAL

Definition at line 63 of file connection_graph.h.

 {
 INVALID = -1,
 NONE = 0,
 PIN,
 SHEET_PIN,
 HIER_LABEL,
 LOCAL_LABEL,
 POWER_PIN,
 GLOBAL
 };

Constructor & Destructor Documentation

◆ CONNECTION_SUBGRAPH()

CONNECTION_SUBGRAPH::CONNECTION_SUBGRAPH ( CONNECTION_GRAPH * aGraph )

inlineexplicit

Definition at line 75 of file connection_graph.h.

 :
 m_graph( aGraph ),
 m_dirty( false ),
 m_absorbed( false ),
 m_absorbed_by( nullptr ),
 m_code( -1 ),
 m_multiple_drivers( false ),
 m_strong_driver( false ),
 m_local_driver( false ),
 m_bus_entry( nullptr ),
 m_hier_parent( nullptr ),
 m_driver( nullptr ),
 m_first_driver( nullptr ),
 m_second_driver( nullptr ),
 m_no_connect( nullptr ),
 m_driver_connection( nullptr )
 {}

◆ ~CONNECTION_SUBGRAPH()

CONNECTION_SUBGRAPH::~CONNECTION_SUBGRAPH ( )

default

Member Function Documentation

◆ Absorb()

void CONNECTION_SUBGRAPH::Absorb ( CONNECTION_SUBGRAPH * aOther )

Combines another subgraph on the same sheet into this one.

Definition at line 341 of file connection_graph.cpp.

{
 wxASSERT( m_sheet == aOther->m_sheet );
 
 for( SCH_ITEM* item : aOther->m_items )
 {
 item->Connection( &m_sheet )->SetSubgraphCode( m_code );
 AddItem( item );
 }
 
 m_bus_neighbors.insert( aOther->m_bus_neighbors.begin(), aOther->m_bus_neighbors.end() );
 m_bus_parents.insert( aOther->m_bus_parents.begin(), aOther->m_bus_parents.end() );
 
 m_multiple_drivers |= aOther->m_multiple_drivers;
 
 aOther->m_absorbed = true;
 aOther->m_dirty = false;
 aOther->m_driver = nullptr;
 aOther->m_driver_connection = nullptr;
 aOther->m_absorbed_by = this;
}

References AddItem(), SCH_ITEM::Connection(), m_absorbed, m_absorbed_by, m_bus_neighbors, m_bus_parents, m_code, m_dirty, m_driver, m_driver_connection, m_items, m_multiple_drivers, m_sheet, and SCH_CONNECTION::SetSubgraphCode().

◆ AddItem()

void CONNECTION_SUBGRAPH::AddItem ( SCH_ITEM * aItem )

Adds a new item to the subgraph.

Definition at line 364 of file connection_graph.cpp.

{
 m_items.push_back( aItem );
 
 if( aItem->Connection( &m_sheet )->IsDriver() )
 m_drivers.push_back( aItem );
 
 if( aItem->Type() == SCH_SHEET_PIN_T )
 m_hier_pins.push_back( static_cast<SCH_SHEET_PIN*>( aItem ) );
 else if( aItem->Type() == SCH_HIER_LABEL_T )
 m_hier_ports.push_back( static_cast<SCH_HIERLABEL*>( aItem ) );
}

References SCH_ITEM::Connection(), SCH_CONNECTION::IsDriver(), m_drivers, m_hier_pins, m_hier_ports, m_items, m_sheet, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by Absorb(), CONNECTION_GRAPH::buildItemSubGraphs(), and CONNECTION_GRAPH::generateGlobalPowerPinSubGraphs().

◆ driverName()

wxString CONNECTION_SUBGRAPH::driverName ( SCH_ITEM * aItem ) const

private

Definition at line 278 of file connection_graph.cpp.

{
 switch( aItem->Type() )
 {
 case SCH_PIN_T:
 {
 bool forceNoConnect = m_no_connect != nullptr;
 SCH_PIN* pin = static_cast<SCH_PIN*>( aItem );
 return pin->GetDefaultNetName( m_sheet, forceNoConnect );
 break;
 }
 
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_SHEET_PIN_T:
 {
 return EscapeString( static_cast<SCH_TEXT*>( aItem )->GetShownText(), CTX_NETNAME );
 break;
 }
 
 default:
 wxFAIL_MSG( wxS( "Unhandled item type in GetNameForDriver" ) );
 break;
 }
 
 return wxEmptyString;
}

References CTX_NETNAME, EscapeString(), m_no_connect, m_sheet, pin, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by GetNameForDriver().

◆ GetBusLabels()

std::vector< SCH_ITEM * > CONNECTION_SUBGRAPH::GetBusLabels ( ) const

Returns all the bus labels attached to this subgraph (if any)

Definition at line 249 of file connection_graph.cpp.

{
 std::vector<SCH_ITEM*> labels;
 
 for( SCH_ITEM* item : m_drivers )
 {
 switch( item->Type() )
 {
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 {
 SCH_CONNECTION* label_conn = item->Connection( &m_sheet );
 
 // Only consider bus vectors
 if( label_conn->Type() == CONNECTION_TYPE::BUS )
 labels.push_back( item );
 
 break;
 }
 
 default:
 break;
 }
 }
 
 return labels;
}

References BUS, m_drivers, m_sheet, SCH_GLOBAL_LABEL_T, SCH_LABEL_T, and SCH_CONNECTION::Type().

◆ GetDriver()

const SCH_ITEM * CONNECTION_SUBGRAPH::GetDriver ( ) const

inline

Returns: pointer to the SCH_ITEM whose name sets the subgraph netname. N.B. This item may not be in the subgraph

Definition at line 164 of file connection_graph.h.

 {
 return m_driver;
 }

References m_driver.

Referenced by DIALOG_MIGRATE_BUSES::onItemSelected().

◆ GetDriverConnection()

const SCH_CONNECTION * CONNECTION_SUBGRAPH::GetDriverConnection ( ) const

inline

Returns: SCH_CONNECTION object for m_driver on m_sheet

Definition at line 172 of file connection_graph.h.

 {
 return m_driver_connection;
 }

References m_driver_connection.

Referenced by SCHEMATIC::GetNetClassAssignmentCandidates().

◆ GetDriverPriority() [1/2]

PRIORITY CONNECTION_SUBGRAPH::GetDriverPriority ( )

inline

Definition at line 152 of file connection_graph.h.

 {
 if( m_driver )
 return GetDriverPriority( m_driver );
 else
 return PRIORITY::NONE;
 }

References GetDriverPriority(), m_driver, and NONE.

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), GetDriverPriority(), BACK_ANNOTATE::processNetNameChange(), CONNECTION_GRAPH::propagateToNeighbors(), and ResolveDrivers().

◆ GetDriverPriority() [2/2]

CONNECTION_SUBGRAPH::PRIORITY CONNECTION_SUBGRAPH::GetDriverPriority ( SCH_ITEM * aDriver )

static

Return the priority (higher is more important) of a candidate driver.

0: Invalid driver 1: Symbol pin 2: Hierarchical sheet pin 3: Hierarchical label 4: Local label 5: Power pin 6: Global label

Parameters

aDriver is the item to inspect

Returns: a PRIORITY

Definition at line 405 of file connection_graph.cpp.

{
 if( !aDriver )
 return PRIORITY::NONE;
 
 switch( aDriver->Type() )
 {
 case SCH_SHEET_PIN_T: return PRIORITY::SHEET_PIN;
 case SCH_HIER_LABEL_T: return PRIORITY::HIER_LABEL;
 case SCH_LABEL_T: return PRIORITY::LOCAL_LABEL;
 case SCH_GLOBAL_LABEL_T: return PRIORITY::GLOBAL;
 case SCH_PIN_T:
 {
 SCH_PIN* sch_pin = static_cast<SCH_PIN*>( aDriver );
 
 if( sch_pin->IsGlobalPower() )
 return PRIORITY::POWER_PIN;
 else
 return PRIORITY::PIN;
 }
 
 default: return PRIORITY::NONE;
 }
}

References GLOBAL, HIER_LABEL, SCH_PIN::IsGlobalPower(), LOCAL_LABEL, NONE, PIN, POWER_PIN, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, SCH_SHEET_PIN_T, SHEET_PIN, and EDA_ITEM::Type().

Referenced by CONNECTION_GRAPH::ercCheckNoConnects(), and SCHEMATIC::GetNetClassAssignmentCandidates().

◆ GetItems()

const std::vector< SCH_ITEM * > & CONNECTION_SUBGRAPH::GetItems ( ) const

inline

Provides a read-only reference to the items in the subgraph.

Definition at line 131 of file connection_graph.h.

 {
 return m_items;
 }

References m_items.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ GetNameForDriver()

const wxString & CONNECTION_SUBGRAPH::GetNameForDriver ( SCH_ITEM * aItem ) const

Returns the candidate net name for a driver.

Definition at line 308 of file connection_graph.cpp.

{
 auto [it, success] = m_driver_name_cache.try_emplace( aItem, driverName( aItem ) );
 
 return it->second;
}

References driverName(), and m_driver_name_cache.

Referenced by CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_GRAPH::propagateToNeighbors(), and ResolveDrivers().

◆ GetNetclassForDriver()

const wxString CONNECTION_SUBGRAPH::GetNetclassForDriver ( SCH_ITEM * aItem ) const

Definition at line 316 of file connection_graph.cpp.

{
 wxString netclass;
 
 aItem->RunOnChildren(
 [&]( SCH_ITEM* aChild )
 {
 if( aChild->Type() == SCH_FIELD_T )
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( aChild );
 
 if( field->GetCanonicalName() == wxT( "Netclass" ) )
 {
 netclass = field->GetText();
 return false;
 }
 }
 
 return true;
 } );
 
 return netclass;
}

References SCH_ITEM::RunOnChildren(), SCH_FIELD_T, and EDA_ITEM::Type().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ GetNetName()

wxString CONNECTION_SUBGRAPH::GetNetName ( ) const

Returns the fully-qualified net name for this subgraph (if one exists)

Definition at line 231 of file connection_graph.cpp.

{
 if( !m_driver || m_dirty )
 return "";
 
 if( !m_driver->Connection( &m_sheet ) )
 {
#ifdef CONNECTIVITY_DEBUG
 wxASSERT_MSG( false, wxS( "Tried to get the net name of an item with no connection" ) );
#endif
 
 return "";
 }
 
 return m_driver->Connection( &m_sheet )->Name();
}

References SCH_ITEM::Connection(), m_dirty, m_driver, m_sheet, and SCH_CONNECTION::Name().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::generateGlobalPowerPinSubGraphs(), and CONNECTION_GRAPH::GetResolvedSubgraphName().

◆ GetNoConnect()

const SCH_ITEM * CONNECTION_SUBGRAPH::GetNoConnect ( ) const

inline

Returns: pointer to the item causing a no-connect or nullptr if none

Definition at line 180 of file connection_graph.h.

 {
 return m_no_connect;
 }

References m_no_connect.

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

◆ GetSheet()

const SCH_SHEET_PATH & CONNECTION_SUBGRAPH::GetSheet ( ) const

inline

Definition at line 185 of file connection_graph.h.

 {
 return m_sheet;
 }

References m_sheet.

Referenced by DIALOG_MIGRATE_BUSES::onItemSelected(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), and ERC_TESTER::TestSimilarLabels().

◆ ResolveDrivers()

bool CONNECTION_SUBGRAPH::ResolveDrivers ( bool aCheckMultipleDrivers = false )

Determines which potential driver should drive the subgraph.

If multiple possible drivers exist, picks one according to the priority. If multiple "winners" exist, returns false and sets m_driver to nullptr.

Parameters

aCheckMultipleDrivers controls whether the second driver should be captured for ERC

Returns: true if m_driver was set, or false if a conflict occurred

Definition at line 67 of file connection_graph.cpp.

{
 PRIORITY highest_priority = PRIORITY::INVALID;
 std::vector<SCH_ITEM*> candidates;
 std::vector<SCH_ITEM*> strong_drivers;
 
 m_driver = nullptr;
 
 // Hierarchical labels are lower priority than local labels here,
 // because on the first pass we want local labels to drive subgraphs
 // so that we can identify same-sheet neighbors and link them together.
 // Hierarchical labels will end up overriding the final net name if
 // a higher-level sheet has a different name during the hierarchical
 // pass.
 
 for( SCH_ITEM* item : m_drivers )
 {
 PRIORITY item_priority = GetDriverPriority( item );
 
 if( item_priority == PRIORITY::PIN
 && !static_cast<SCH_PIN*>( item )->GetParentSymbol()->IsInNetlist() )
 continue;
 
 if( item_priority >= PRIORITY::HIER_LABEL )
 strong_drivers.push_back( item );
 
 if( item_priority > highest_priority )
 {
 candidates.clear();
 candidates.push_back( item );
 highest_priority = item_priority;
 }
 else if( !candidates.empty() && ( item_priority == highest_priority ) )
 {
 candidates.push_back( item );
 }
 }
 
 if( highest_priority >= PRIORITY::HIER_LABEL )
 m_strong_driver = true;
 
 // Power pins are 5, global labels are 6
 m_local_driver = ( highest_priority < PRIORITY::POWER_PIN );
 
 if( !candidates.empty() )
 {
 if( candidates.size() > 1 )
 {
 if( highest_priority == PRIORITY::SHEET_PIN )
 {
 // We have multiple options, and they are all hierarchical
 // sheet pins. Let's prefer outputs over inputs.
 
 for( SCH_ITEM* c : candidates )
 {
 SCH_SHEET_PIN* p = static_cast<SCH_SHEET_PIN*>( c );
 
 if( p->GetShape() == LABEL_FLAG_SHAPE::L_OUTPUT )
 {
 m_driver = c;
 break;
 }
 }
 }
 else
 {
 // For all other driver types, sort by quality of name
 std::sort( candidates.begin(), candidates.end(),
 [&]( SCH_ITEM* a, SCH_ITEM* b ) -> bool
 {
 // meet irreflexive requirements of std::sort
 if( a == b )
 return false;
 
 SCH_CONNECTION* ac = a->Connection( &m_sheet );
 SCH_CONNECTION* bc = b->Connection( &m_sheet );
 
 // Ensure we don't pick the subset over the superset
 if( ac->IsBus() && bc->IsBus() )
 return bc->IsSubsetOf( ac );
 
 // Ensure we don't pick a hidden power pin on a regular symbol over
 // one on a power symbol
  if( a->Type() == SCH_PIN_T && b->Type() == SCH_PIN_T )
 {
 SCH_PIN* pa = static_cast<SCH_PIN*>( a );
 SCH_PIN* pb = static_cast<SCH_PIN*>( b );
 
 bool aPower = pa->GetLibPin()->GetParent()->IsPower();
 bool bPower = pb->GetLibPin()->GetParent()->IsPower();
 
 if( aPower && !bPower )
 return true;
 else if( bPower && !aPower )
 return false;
 }
 
 const wxString& a_name = GetNameForDriver( a );
 const wxString& b_name = GetNameForDriver( b );
 bool a_lowQualityName = a_name.Contains( "-Pad" );
 bool b_lowQualityName = b_name.Contains( "-Pad" );
 
 if( a_lowQualityName && !b_lowQualityName )
 return false;
 else if( b_lowQualityName && !a_lowQualityName )
 return true;
 else
 return a_name < b_name;
 } );
 }
 }
 
 if( !m_driver )
 m_driver = candidates[0];
 }
 
 if( strong_drivers.size() > 1 )
 m_multiple_drivers = true;
 
 // Drop weak drivers
 if( m_strong_driver )
 m_drivers = strong_drivers;
 
 // Cache driver connection
 if( m_driver )
 {
 m_driver_connection = m_driver->Connection( &m_sheet );
 m_driver_connection->ConfigureFromLabel( GetNameForDriver( m_driver ) );
 m_driver_connection->SetDriver( m_driver );
 m_driver_connection->ClearDirty();
 }
 else
 {
 m_driver_connection = nullptr;
 }
 
 if( aCheckMultipleDrivers && m_multiple_drivers )
 {
 // First check if all the candidates are actually the same
 bool same = true;
 const wxString& first = GetNameForDriver( candidates[0] );
 SCH_ITEM* second_item = nullptr;
 
 for( unsigned i = 1; i < candidates.size(); i++ )
 {
 if( GetNameForDriver( candidates[i] ) != first )
 {
 second_item = candidates[i];
 same = false;
 break;
 }
 }
 
 if( !same )
 {
 m_first_driver = m_driver;
 m_second_driver = second_item;
 }
 }
 
 return ( m_driver != nullptr );
}

References GetDriverPriority(), GetNameForDriver(), SCH_LABEL_BASE::GetShape(), HIER_LABEL, INVALID, L_OUTPUT, m_driver, m_drivers, m_local_driver, m_strong_driver, PIN, POWER_PIN, and SHEET_PIN.

Referenced by CONNECTION_GRAPH::generateGlobalPowerPinSubGraphs().

◆ UpdateItemConnections()

void CONNECTION_SUBGRAPH::UpdateItemConnections ( )

Updates all items to match the driver connection.

Definition at line 378 of file connection_graph.cpp.

{
 if( !m_driver_connection )
 return;
 
 for( SCH_ITEM* item : m_items )
 {
 SCH_CONNECTION* item_conn = item->GetOrInitConnection( m_sheet, m_graph );
 
 if( !item_conn )
 continue;
 
 if( ( m_driver_connection->IsBus() && item_conn->IsNet() ) ||
 ( m_driver_connection->IsNet() && item_conn->IsBus() ) )
 {
 continue;
 }
 
 if( item != m_driver )
 {
 item_conn->Clone( *m_driver_connection );
 item_conn->ClearDirty();
 }
 }
}

References SCH_CONNECTION::ClearDirty(), SCH_CONNECTION::Clone(), SCH_CONNECTION::IsBus(), SCH_CONNECTION::IsNet(), m_driver, m_driver_connection, m_graph, m_items, and m_sheet.

Friends And Related Function Documentation

◆ CONNECTION_GRAPH

friend class CONNECTION_GRAPH

friend

Definition at line 95 of file connection_graph.h.

Member Data Documentation

◆ m_absorbed

bool CONNECTION_SUBGRAPH::m_absorbed

private

True if this subgraph has been absorbed into another. No pointers here are safe if so!

Definition at line 198 of file connection_graph.h.

Referenced by Absorb(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_GRAPH::GetSubgraphForItem(), CONNECTION_GRAPH::processSubGraphs(), and CONNECTION_GRAPH::propagateToNeighbors().

◆ m_absorbed_by

CONNECTION_SUBGRAPH* CONNECTION_SUBGRAPH::m_absorbed_by

private

If this subgraph is absorbed, points to the absorbing (and valid) subgraph.

Definition at line 201 of file connection_graph.h.

Referenced by Absorb(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::GetSubgraphForItem(), and CONNECTION_GRAPH::propagateToNeighbors().

◆ m_bus_entry

SCH_ITEM* CONNECTION_SUBGRAPH::m_bus_entry

private

Bus entry in graph, if any.

Definition at line 219 of file connection_graph.h.

◆ m_bus_neighbors

std::unordered_map< std::shared_ptr<SCH_CONNECTION>, std::unordered_set<CONNECTION_SUBGRAPH*> > CONNECTION_SUBGRAPH::m_bus_neighbors

private

If a subgraph is a bus, this map contains links between the bus members and any local sheet neighbors with the same connection name.

For example, if this subgraph is a bus D[7..0], and on the same sheet there is a net with label D7, this map will contain an entry for the D7 bus member, and the vector will contain a pointer to the D7 net subgraph.

Definition at line 232 of file connection_graph.h.

Referenced by Absorb().

◆ m_bus_parents

std::unordered_map< std::shared_ptr<SCH_CONNECTION>, std::unordered_set<CONNECTION_SUBGRAPH*> > CONNECTION_SUBGRAPH::m_bus_parents

private

If this is a net, this vector contains links to any same-sheet buses that contain it.

The string key is the name of the connection that forms the link (which isn't necessarily the same as the name of the connection driving this subgraph)

Definition at line 240 of file connection_graph.h.

Referenced by Absorb(), and CONNECTION_GRAPH::processSubGraphs().

◆ m_code

long CONNECTION_SUBGRAPH::m_code

private

Definition at line 203 of file connection_graph.h.

Referenced by Absorb(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::buildItemSubGraphs(), CONNECTION_GRAPH::generateGlobalPowerPinSubGraphs(), CONNECTION_GRAPH::processSubGraphs(), and CONNECTION_GRAPH::propagateToNeighbors().

◆ m_dirty

bool CONNECTION_SUBGRAPH::m_dirty

private

Definition at line 195 of file connection_graph.h.

Referenced by Absorb(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::buildItemSubGraphs(), GetNetName(), and CONNECTION_GRAPH::propagateToNeighbors().

◆ m_driver

SCH_ITEM* CONNECTION_SUBGRAPH::m_driver

private

Fully-resolved driver for the subgraph (might not exist in this subgraph)

Definition at line 255 of file connection_graph.h.

Referenced by Absorb(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), GetDriver(), GetDriverPriority(), GetNetName(), CONNECTION_GRAPH::processSubGraphs(), CONNECTION_GRAPH::propagateToNeighbors(), ResolveDrivers(), and UpdateItemConnections().

◆ m_driver_connection

SCH_CONNECTION* CONNECTION_SUBGRAPH::m_driver_connection

private

Cache for driver connection.

Definition at line 276 of file connection_graph.h.

Referenced by Absorb(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::FindSubgraphByName(), GetDriverConnection(), CONNECTION_GRAPH::processSubGraphs(), CONNECTION_GRAPH::propagateToNeighbors(), CONNECTION_GRAPH::recacheSubgraphName(), and UpdateItemConnections().

◆ m_driver_name_cache

std::unordered_map<SCH_ITEM*, wxString> CONNECTION_SUBGRAPH::m_driver_name_cache

mutableprivate

A cache of escaped netnames from schematic items.

Definition at line 252 of file connection_graph.h.

Referenced by GetNameForDriver().

◆ m_drivers

std::vector<SCH_ITEM*> CONNECTION_SUBGRAPH::m_drivers

private

Definition at line 221 of file connection_graph.h.

Referenced by AddItem(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), GetBusLabels(), CONNECTION_GRAPH::processSubGraphs(), CONNECTION_GRAPH::propagateToNeighbors(), and ResolveDrivers().

◆ m_first_driver

SCH_ITEM* CONNECTION_SUBGRAPH::m_first_driver

private

Stores the primary driver for the multiple drivers ERC check.

This is the chosen driver before subgraphs are absorbed (so m_driver may be different)

Definition at line 261 of file connection_graph.h.

Referenced by CONNECTION_GRAPH::ercCheckMultipleDrivers().

◆ m_graph

CONNECTION_GRAPH* CONNECTION_SUBGRAPH::m_graph

private

Definition at line 193 of file connection_graph.h.

Referenced by UpdateItemConnections().

◆ m_hier_parent

CONNECTION_SUBGRAPH* CONNECTION_SUBGRAPH::m_hier_parent

private

Definition at line 249 of file connection_graph.h.

Referenced by CONNECTION_GRAPH::propagateToNeighbors().

◆ m_hier_pins

std::vector<SCH_SHEET_PIN*> CONNECTION_SUBGRAPH::m_hier_pins

private

Definition at line 243 of file connection_graph.h.

Referenced by AddItem(), and CONNECTION_GRAPH::propagateToNeighbors().

◆ m_hier_ports

std::vector<SCH_HIERLABEL*> CONNECTION_SUBGRAPH::m_hier_ports

private

Definition at line 246 of file connection_graph.h.

Referenced by AddItem(), and CONNECTION_GRAPH::propagateToNeighbors().

◆ m_items

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

private

Contents of the subgraph.

Definition at line 267 of file connection_graph.h.

Referenced by Absorb(), AddItem(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), GetItems(), and UpdateItemConnections().

◆ m_local_driver

bool CONNECTION_SUBGRAPH::m_local_driver

private

True if the driver is a local (i.e. non-global) type.

Definition at line 216 of file connection_graph.h.

Referenced by ResolveDrivers().

◆ m_multiple_drivers

bool CONNECTION_SUBGRAPH::m_multiple_drivers

private

True if this subgraph contains more than one driver that should be shorted together in the netlist.

For example, two labels or two power ports.

Definition at line 210 of file connection_graph.h.

Referenced by Absorb(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::processSubGraphs(), and CONNECTION_GRAPH::propagateToNeighbors().

◆ m_no_connect

SCH_ITEM* CONNECTION_SUBGRAPH::m_no_connect

private

No-connect item in graph, if any.

Definition at line 270 of file connection_graph.h.

Referenced by CONNECTION_GRAPH::buildItemSubGraphs(), driverName(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), and GetNoConnect().

◆ m_second_driver

SCH_ITEM* CONNECTION_SUBGRAPH::m_second_driver

private

Used for multiple drivers ERC message; stores the second possible driver (or nullptr)

Definition at line 264 of file connection_graph.h.

Referenced by CONNECTION_GRAPH::ercCheckMultipleDrivers().

◆ m_sheet

SCH_SHEET_PATH CONNECTION_SUBGRAPH::m_sheet

private

◆ m_strong_driver

bool CONNECTION_SUBGRAPH::m_strong_driver

private

True if the driver is "strong": a label or power object.

Definition at line 213 of file connection_graph.h.

Referenced by CONNECTION_GRAPH::propagateToNeighbors(), and ResolveDrivers().

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ PRIORITY

Constructor & Destructor Documentation

◆ CONNECTION_SUBGRAPH()

◆ ~CONNECTION_SUBGRAPH()

Member Function Documentation

◆ Absorb()

◆ AddItem()

◆ driverName()

◆ GetBusLabels()

◆ GetDriver()

◆ GetDriverConnection()

◆ GetDriverPriority() [1/2]

◆ GetDriverPriority() [2/2]

◆ GetItems()

◆ GetNameForDriver()

◆ GetNetclassForDriver()

◆ GetNetName()

◆ GetNoConnect()

◆ GetSheet()

◆ ResolveDrivers()

◆ UpdateItemConnections()

Friends And Related Function Documentation

◆ CONNECTION_GRAPH

Member Data Documentation

◆ m_absorbed

◆ m_absorbed_by

◆ m_bus_entry

◆ m_bus_neighbors

◆ m_bus_parents

◆ m_code

◆ m_dirty

◆ m_driver

◆ m_driver_connection

◆ m_driver_name_cache

◆ m_drivers

◆ m_first_driver

◆ m_graph

◆ m_hier_parent

◆ m_hier_pins

◆ m_hier_ports

◆ m_items

◆ m_local_driver

◆ m_multiple_drivers

◆ m_no_connect

◆ m_second_driver

◆ m_sheet

◆ m_strong_driver