KiCad PCB EDA Suite
SCH_CONNECTION Class Reference

Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net). More...

#include <sch_connection.h>

Public Member Functions

 SCH_CONNECTION (SCH_ITEM *aParent=nullptr, SCH_SHEET_PATH aPath=SCH_SHEET_PATH())
 Buses can be defined in multiple ways. More...
 
 SCH_CONNECTION (CONNECTION_GRAPH *aGraph)
 
 ~SCH_CONNECTION ()
 
bool operator== (const SCH_CONNECTION &aOther) const
 Note: the equality operator for SCH_CONNECTION only tests the net properties, not the ownership / sheet location! More...
 
bool operator!= (const SCH_CONNECTION &aOther) const
 
void SetGraph (CONNECTION_GRAPH *aGraph)
 
void ConfigureFromLabel (const wxString &aLabel)
 Configures the connection given a label. More...
 
void Reset ()
 Clears connectivity information. More...
 
void Clone (SCH_CONNECTION &aOther)
 Copies connectivity information (but not parent) from another connection. More...
 
SCH_ITEMParent () const
 
SCH_ITEMDriver () const
 
SCH_SHEET_PATH Sheet () const
 
void SetDriver (SCH_ITEM *aItem)
 
void SetSheet (SCH_SHEET_PATH aSheet)
 
bool IsDriver () const
 Checks if the SCH_ITEM this connection is attached to can drive connections Drivers can be labels, sheet pins, or component pins. More...
 
bool IsBus () const
 
bool IsNet () const
 
bool IsDirty () const
 
void SetDirty ()
 
void ClearDirty ()
 
const wxString & Name (bool aIgnoreSheet=false) const
 
const wxString & RawName () const
 
wxString LocalName () const
 
wxString FullLocalName () const
 
void SetName (const wxString &aName)
 
wxString Prefix () const
 
wxString BusPrefix () const
 
wxString Suffix () const
 
void SetPrefix (const wxString &aPrefix)
 
void SetSuffix (const wxString &aSuffix)
 
CONNECTION_TYPE Type () const
 
void SetType (CONNECTION_TYPE aType)
 
int NetCode () const
 
void SetNetCode (int aCode)
 
int BusCode () const
 
void SetBusCode (int aCode)
 
int SubgraphCode () const
 
void SetSubgraphCode (int aCode)
 
long VectorStart () const
 
long VectorEnd () const
 
long VectorIndex () const
 
wxString VectorPrefix () const
 
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members ()
 
const std::vector< std::shared_ptr< SCH_CONNECTION > > & Members () const
 
const std::vector< std::shared_ptr< SCH_CONNECTION > > AllMembers () const
 
bool IsSubsetOf (SCH_CONNECTION *aOther) const
 Returns true if this connection is contained within aOther (but not the same as aOther) More...
 
bool IsMemberOfBus (SCH_CONNECTION *aOther) const
 Returns true if this connection is a member of bus connection aOther. More...
 
void AppendInfoToMsgPanel (MSG_PANEL_ITEMS &aList) const
 Adds information about the connection object to aList. More...
 

Static Public Member Functions

static wxString PrintBusForUI (const wxString &aString)
 
static bool IsBusLabel (const wxString &aLabel)
 Test if aLabel has a bus notation. More...
 
static bool MightBeBusLabel (const wxString &aLabel)
 Test if aLabel looks like a bus notation. More...
 

Private Member Functions

void recacheName ()
 

Private Attributes

bool m_dirty
 
SCH_SHEET_PATH m_sheet
 The hierarchical sheet this connection is on. More...
 
SCH_ITEMm_parent
 The SCH_ITEM this connection is owned by. More...
 
SCH_ITEMm_driver
 The SCH_ITEM that drives this connection's net. More...
 
CONNECTION_TYPE m_type
 
wxString m_name
 Name of the connection. More...
 
wxString m_cached_name
 Full name, including prefix and suffix. More...
 
wxString m_cached_name_with_path
 Full name including sheet path (if not global) More...
 
wxString m_local_name
 For bus members, we want to keep track of the "local" name of a member, that is, the name it takes on from its parent bus name. More...
 
wxString m_prefix
 Prefix if connection is member of a labeled bus group (or "" if not) More...
 
wxString m_bus_prefix
 Optional prefix of a bux group (always empty for nets and vector buses) More...
 
wxString m_suffix
 Name suffix (used only for disambiguation) More...
 
int m_net_code
 
int m_bus_code
 
int m_subgraph_code
 Groups directly-connected items. More...
 
long m_vector_index
 Index of bus vector member nets. More...
 
long m_vector_start
 Highest member of a vector bus. More...
 
long m_vector_end
 Lowest member of a vector bus. More...
 
wxString m_vector_prefix
 
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
 For bus connections, store a list of member connections. More...
 
CONNECTION_GRAPHm_graph
 Pointer to the connection graph for the schematic this connection exists on. More...
 

Detailed Description

Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

These are generated when netlisting, or when editing operations that can change the netlist are performed.

In hierarchical schematics, a single SCH_ITEM object can refer to multiple distinct parts of a design (in the case of a sub-sheet that is instanced more than once in a higher level sheet). Because of this, a single item may contain more than one SCH_CONNECTION – each is specific to a sheet.

Components contain connections for each of their pins (and for each sheet they exist on) but don't use their own connection object.

Definition at line 61 of file sch_connection.h.

Constructor & Destructor Documentation

◆ SCH_CONNECTION() [1/2]

SCH_CONNECTION::SCH_CONNECTION ( SCH_ITEM aParent = nullptr,
SCH_SHEET_PATH  aPath = SCH_SHEET_PATH() 
)

Buses can be defined in multiple ways.

A bus vector consists of a prefix and a numeric range of suffixes:

BUS_NAME[M..N]

For example, the bus A[3..0] will contain nets A3, A2, A1, and A0. The BUS_NAME is required. M and N must be integers but do not need to be in any particular order – A[0..3] produces the same result.

Like net names, bus names cannot contain whitespace.

A bus group is just a grouping of signals, separated by spaces, some of which may be bus vectors. Bus groups can have names, but do not need to.

MEMORY{A[15..0] D[7..0] RW CE OE}

In named bus groups, the net names are expanded as <BUS_NAME>.<NET_NAME> In the above example, the nets would be named like MEMORY.A15, MEMORY.D0, etc.

{USB_DP USB_DN}

In the above example, the bus is unnamed and so the underlying net names are just USB_DP and USB_DN.

Definition at line 61 of file sch_connection.cpp.

61  :
62  m_sheet( aPath ),
63  m_parent( aParent ),
64  m_graph( nullptr )
65 {
66  Reset();
67 }
void Reset()
Clears connectivity information.
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.
SCH_ITEM * m_parent
The SCH_ITEM this connection is owned by.

References Reset().

◆ SCH_CONNECTION() [2/2]

SCH_CONNECTION::SCH_CONNECTION ( CONNECTION_GRAPH aGraph)

Definition at line 70 of file sch_connection.cpp.

70  :
72  m_parent( nullptr ),
73  m_graph( aGraph )
74 {
75  Reset();
76 }
void Reset()
Clears connectivity information.
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.
SCH_SHEET_PATH.
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.
SCH_ITEM * m_parent
The SCH_ITEM this connection is owned by.

References Reset().

◆ ~SCH_CONNECTION()

SCH_CONNECTION::~SCH_CONNECTION ( )
inline

Definition at line 68 of file sch_connection.h.

69  {}

Member Function Documentation

◆ AllMembers()

const std::vector< std::shared_ptr< SCH_CONNECTION > > SCH_CONNECTION::AllMembers ( ) const

Definition at line 420 of file sch_connection.cpp.

421 {
422  std::vector< std::shared_ptr< SCH_CONNECTION > > ret( m_members );
423 
424  for( const auto& member : m_members )
425  if( member->IsBus() )
426  ret.insert( ret.end(), member->Members().begin(), member->Members().end() );
427 
428  return ret;
429 }
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
For bus connections, store a list of member connections.

References m_members.

Referenced by SCH_EDIT_FRAME::SetCrossProbeConnection().

◆ AppendInfoToMsgPanel()

void SCH_CONNECTION::AppendInfoToMsgPanel ( MSG_PANEL_ITEMS aList) const

Adds information about the connection object to aList.

Definition at line 331 of file sch_connection.cpp.

332 {
333  wxString msg, group_name;
334  std::vector<wxString> group_members;
335 
336  aList.push_back( MSG_PANEL_ITEM( _( "Connection Name" ), UnescapeString( Name() ), BROWN ) );
337 
338  // NOTE(JE) Disabling this for now, because net codes are generated in the netlist exporter
339  // in order to avoid sort costs. It may make sense to just tear out net codes from the
340  // CONNECTION_GRAPH entirely in the future, as they are mostly only useful for netlist exports.
341 #if 0
342  if( !IsBus() )
343  {
344  msg.Printf( "%d", m_net_code );
345  aList.push_back( MSG_PANEL_ITEM( _( "Net Code" ), msg, BROWN ) );
346  }
347 #endif
348 
349  if( auto alias = m_graph->GetBusAlias( m_name ) )
350  {
351  msg.Printf( _( "Bus Alias %s Members" ), m_name );
352 
353  wxString members;
354 
355  for( const auto& member : alias->Members() )
356  members << member << " ";
357 
358  aList.push_back( MSG_PANEL_ITEM( msg, members, RED ) );
359  }
360  else if( NET_SETTINGS::ParseBusGroup( m_name, &group_name, &group_members ) )
361  {
362  for( const auto& group_member : group_members )
363  {
364  if( auto group_alias = m_graph->GetBusAlias( group_member ) )
365  {
366  msg.Printf( _( "Bus Alias %s Members" ), group_alias->GetName() );
367 
368  wxString members;
369 
370  for( const auto& member : group_alias->Members() )
371  members << member << " ";
372 
373  aList.push_back( MSG_PANEL_ITEM( msg, members, RED ) );
374  }
375  }
376  }
377 
378 #if defined(DEBUG)
379  // These messages are not flagged as translatable, because they are only debug messages
380 
381  if( !ADVANCED_CFG::GetCfg().m_realTimeConnectivity || !CONNECTION_GRAPH::m_allowRealTime )
382  return;
383 
384  if( IsBus() )
385  {
386  msg.Printf( "%d", m_bus_code );
387  aList.push_back( MSG_PANEL_ITEM( "Bus Code", msg, BROWN ) );
388  }
389 
390  msg.Printf( "%d", m_subgraph_code );
391  aList.push_back( MSG_PANEL_ITEM( "Subgraph Code", msg, BROWN ) );
392 
393  if( auto driver = Driver() )
394  {
395  msg.Printf( "%s at %p", driver->GetSelectMenuText( EDA_UNITS::MILLIMETRES ), driver );
396  aList.push_back( MSG_PANEL_ITEM( "Connection Source", msg, RED ) );
397  }
398 #endif
399 }
int m_subgraph_code
Groups directly-connected items.
std::shared_ptr< BUS_ALIAS > GetBusAlias(const wxString &aName)
Returns a bus alias pointer for the given name if it exists (from cache)
wxString m_name
Name of the connection.
Definition: color4d.h:61
static bool ParseBusGroup(wxString aGroup, wxString *name, std::vector< wxString > *aMemberList)
Parses a bus group label into the name and a list of components.
SCH_ITEM * Driver() const
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.
const wxString & Name(bool aIgnoreSheet=false) const
Definition: color4d.h:59
static bool m_allowRealTime
#define _(s)
Definition: 3d_actions.cpp:33
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:125
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers of advanced config.
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
bool IsBus() const

References _, BROWN, Driver(), CONNECTION_GRAPH::GetBusAlias(), ADVANCED_CFG::GetCfg(), IsBus(), CONNECTION_GRAPH::m_allowRealTime, m_bus_code, m_graph, m_name, m_net_code, m_subgraph_code, MILLIMETRES, Name(), NET_SETTINGS::ParseBusGroup(), RED, and UnescapeString().

Referenced by LIB_PIN::GetMsgPanelInfo().

◆ BusCode()

int SCH_CONNECTION::BusCode ( ) const
inline

Definition at line 216 of file sch_connection.h.

217  {
218  return m_bus_code;
219  }

References m_bus_code.

Referenced by Clone().

◆ BusPrefix()

wxString SCH_CONNECTION::BusPrefix ( ) const
inline

Definition at line 181 of file sch_connection.h.

182  {
183  return m_bus_prefix;
184  }
wxString m_bus_prefix
Optional prefix of a bux group (always empty for nets and vector buses)

References m_bus_prefix.

Referenced by Clone().

◆ ClearDirty()

void SCH_CONNECTION::ClearDirty ( )
inline

Definition at line 151 of file sch_connection.h.

152  {
153  m_dirty = false;
154  }

References m_dirty.

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), and CONNECTION_SUBGRAPH::UpdateItemConnections().

◆ Clone()

void SCH_CONNECTION::Clone ( SCH_CONNECTION aOther)

Copies connectivity information (but not parent) from another connection.

Parameters
aOtheris the connection to clone

Definition at line 218 of file sch_connection.cpp.

219 {
220  m_graph = aOther.m_graph;
221  m_type = aOther.Type();
222  m_driver = aOther.Driver();
223  m_sheet = aOther.Sheet();
224  m_name = aOther.m_name;
225  // Note: m_local_name is not cloned
226  m_prefix = aOther.Prefix();
227  m_bus_prefix = aOther.BusPrefix();
228  m_suffix = aOther.Suffix();
229  m_members = aOther.Members();
230  m_net_code = aOther.NetCode();
231  m_bus_code = aOther.BusCode();
232  m_vector_start = aOther.VectorStart();
233  m_vector_end = aOther.VectorEnd();
234  // Note: m_vector_index is not cloned
235  m_vector_prefix = aOther.VectorPrefix();
236 
237  // Note: subgraph code isn't cloned, it should remain with the original object
238 
239  recacheName();
240 }
wxString Prefix() const
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
For bus connections, store a list of member connections.
wxString m_name
Name of the connection.
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
wxString m_bus_prefix
Optional prefix of a bux group (always empty for nets and vector buses)
int BusCode() const
CONNECTION_TYPE m_type
int NetCode() const
wxString Suffix() const
long VectorEnd() const
SCH_ITEM * Driver() const
wxString m_prefix
Prefix if connection is member of a labeled bus group (or "" if not)
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.
wxString m_suffix
Name suffix (used only for disambiguation)
SCH_SHEET_PATH Sheet() const
long m_vector_start
Highest member of a vector bus.
wxString VectorPrefix() const
wxString BusPrefix() const
long VectorStart() const
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members()
long m_vector_end
Lowest member of a vector bus.
wxString m_vector_prefix
CONNECTION_TYPE Type() const

References BusCode(), BusPrefix(), Driver(), m_bus_code, m_bus_prefix, m_driver, m_graph, m_members, m_name, m_net_code, m_prefix, m_sheet, m_suffix, m_type, m_vector_end, m_vector_prefix, m_vector_start, Members(), NetCode(), Prefix(), recacheName(), Sheet(), Suffix(), Type(), VectorEnd(), VectorPrefix(), and VectorStart().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::propagateToNeighbors(), and CONNECTION_SUBGRAPH::UpdateItemConnections().

◆ ConfigureFromLabel()

void SCH_CONNECTION::ConfigureFromLabel ( const wxString &  aLabel)

Configures the connection given a label.

For CONNECTION_NET, this just sets the name. For CONNECTION_BUS, this will deduce the correct BUS_TYPE and also generate a correct list of members.

Definition at line 122 of file sch_connection.cpp.

123 {
124  m_members.clear();
125 
126  m_name = aLabel;
127  m_local_name = aLabel;
128 
129  wxString prefix;
130  std::vector<wxString> members;
131 
132  wxString unescaped = UnescapeString( aLabel );
133 
134  if( NET_SETTINGS::ParseBusVector( unescaped, &prefix, &members ) )
135  {
137  m_vector_prefix = prefix;
138 
139  long i = 0;
140 
141  for( const wxString& vector_member : members )
142  {
143  auto member = std::make_shared<SCH_CONNECTION>( m_parent, m_sheet );
144  member->m_type = CONNECTION_TYPE::NET;
145  member->m_prefix = m_prefix;
146  member->m_local_name = vector_member;
147  member->m_vector_index = i++;
148  member->SetName( vector_member );
149  member->SetGraph( m_graph );
150  m_members.push_back( member );
151  }
152  }
153  else if( NET_SETTINGS::ParseBusGroup( unescaped, &prefix, &members ) )
154  {
156  m_bus_prefix = prefix;
157 
158  // Named bus groups generate a net prefix, unnamed ones don't
159  if( !prefix.IsEmpty() )
160  prefix += wxT( "." );
161 
162  for( const wxString& group_member : members )
163  {
164  // Handle alias inside bus group member list
165  if( auto alias = m_graph->GetBusAlias( group_member ) )
166  {
167  for( const wxString& alias_member : alias->Members() )
168  {
169  auto member = std::make_shared< SCH_CONNECTION >( m_parent, m_sheet );
170  member->SetPrefix( prefix );
171  member->SetGraph( m_graph );
172  member->ConfigureFromLabel( alias_member );
173  m_members.push_back( member );
174  }
175  }
176  else
177  {
178  auto member = std::make_shared< SCH_CONNECTION >( m_parent, m_sheet );
179  member->SetPrefix( prefix );
180  member->SetGraph( m_graph );
181  member->ConfigureFromLabel( group_member );
182  m_members.push_back( member );
183  }
184  }
185  }
186  else
187  {
189  }
190 
191  recacheName();
192 }
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
For bus connections, store a list of member connections.
std::shared_ptr< BUS_ALIAS > GetBusAlias(const wxString &aName)
Returns a bus alias pointer for the given name if it exists (from cache)
wxString m_name
Name of the connection.
This item represents a bus group.
wxString m_bus_prefix
Optional prefix of a bux group (always empty for nets and vector buses)
CONNECTION_TYPE m_type
static bool ParseBusGroup(wxString aGroup, wxString *name, std::vector< wxString > *aMemberList)
Parses a bus group label into the name and a list of components.
wxString m_prefix
Prefix if connection is member of a labeled bus group (or "" if not)
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.
This item represents a net.
wxString m_local_name
For bus members, we want to keep track of the "local" name of a member, that is, the name it takes on...
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:125
static bool ParseBusVector(const wxString &aBus, wxString *aName, std::vector< wxString > *aMemberList)
Parses a bus vector (e.g.
wxString m_vector_prefix
SCH_ITEM * m_parent
The SCH_ITEM this connection is owned by.
This item represents a bus vector.

References BUS, BUS_GROUP, CONNECTION_GRAPH::GetBusAlias(), m_bus_prefix, m_graph, m_local_name, m_members, m_name, m_parent, m_prefix, m_sheet, m_type, m_vector_prefix, NET, NET_SETTINGS::ParseBusGroup(), NET_SETTINGS::ParseBusVector(), recacheName(), and UnescapeString().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), and DIALOG_MIGRATE_BUSES::getProposedLabels().

◆ Driver()

SCH_ITEM* SCH_CONNECTION::Driver ( ) const
inline

Definition at line 109 of file sch_connection.h.

110  {
111  return m_driver;
112  }
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.

References m_driver.

Referenced by AppendInfoToMsgPanel(), Clone(), BACK_ANNOTATE::processNetNameChange(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ FullLocalName()

wxString SCH_CONNECTION::FullLocalName ( ) const
inline

Definition at line 165 of file sch_connection.h.

166  {
167  return m_prefix + m_local_name + m_suffix;
168  }
wxString m_prefix
Prefix if connection is member of a labeled bus group (or "" if not)
wxString m_suffix
Name suffix (used only for disambiguation)
wxString m_local_name
For bus members, we want to keep track of the "local" name of a member, that is, the name it takes on...

References m_local_name, m_prefix, and m_suffix.

Referenced by IsSubsetOf().

◆ IsBus()

◆ IsBusLabel()

bool SCH_CONNECTION::IsBusLabel ( const wxString &  aLabel)
static

Test if aLabel has a bus notation.

Parameters
aLabelA wxString object containing the label to test.
Returns
true if text is a bus notation format otherwise false is returned.

Definition at line 402 of file sch_connection.cpp.

403 {
404  const wxString& unescaped = UnescapeString( aLabel );
405 
406  return NET_SETTINGS::ParseBusVector( unescaped, nullptr, nullptr )
407  || NET_SETTINGS::ParseBusGroup( unescaped, nullptr, nullptr );
408 }
static bool ParseBusGroup(wxString aGroup, wxString *name, std::vector< wxString > *aMemberList)
Parses a bus group label into the name and a list of components.
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:125
static bool ParseBusVector(const wxString &aBus, wxString *aName, std::vector< wxString > *aMemberList)
Parses a bus vector (e.g.

References NET_SETTINGS::ParseBusGroup(), NET_SETTINGS::ParseBusVector(), and UnescapeString().

Referenced by SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), NETLIST_OBJECT::ConvertBusToNetListItems(), SCH_TEXT::GetNetListItem(), and SCH_SHEET::GetNetListItem().

◆ IsDirty()

bool SCH_CONNECTION::IsDirty ( ) const
inline

Definition at line 141 of file sch_connection.h.

142  {
143  return m_dirty;
144  }

References m_dirty.

◆ IsDriver()

bool SCH_CONNECTION::IsDriver ( ) const

Checks if the SCH_ITEM this connection is attached to can drive connections Drivers can be labels, sheet pins, or component pins.

Returns
true if the attached items is a driver

Definition at line 243 of file sch_connection.cpp.

244 {
245  wxASSERT( Parent() );
246 
247  switch( Parent()->Type() )
248  {
249  case SCH_LABEL_T:
250  case SCH_GLOBAL_LABEL_T:
251  case SCH_HIER_LABEL_T:
252  case SCH_SHEET_PIN_T:
253  case SCH_SHEET_T:
254  case LIB_PIN_T:
255  return true;
256 
257  case SCH_PIN_T:
258  {
259  auto pin = static_cast<SCH_PIN*>( Parent() );
260 
261  // Only annotated components should drive nets
262  return ( pin->IsPowerConnection()
263  || pin->GetParentComponent()->IsAnnotated( &m_sheet ) );
264  }
265 
266  default:
267  return false;
268  }
269 }
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.
SCH_ITEM * Parent() const
CONNECTION_TYPE Type() const

References LIB_PIN_T, m_sheet, Parent(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, SCH_SHEET_PIN_T, SCH_SHEET_T, and Type().

Referenced by CONNECTION_SUBGRAPH::AddItem().

◆ IsMemberOfBus()

bool SCH_CONNECTION::IsMemberOfBus ( SCH_CONNECTION aOther) const

Returns true if this connection is a member of bus connection aOther.

Will always return false if aOther is not a bus connection

Definition at line 535 of file sch_connection.cpp.

536 {
537  if( !aOther->IsBus() )
538  return false;
539 
540  auto me = Name( true );
541 
542  for( const auto& m : aOther->Members() )
543  if( m->Name( true ) == me )
544  return true;
545 
546  return false;
547 }
const wxString & Name(bool aIgnoreSheet=false) const
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members()
bool IsBus() const

References IsBus(), Members(), and Name().

◆ IsNet()

bool SCH_CONNECTION::IsNet ( ) const
inline

◆ IsSubsetOf()

bool SCH_CONNECTION::IsSubsetOf ( SCH_CONNECTION aOther) const

Returns true if this connection is contained within aOther (but not the same as aOther)

Returns
true if this connection is a member of aOther

Definition at line 520 of file sch_connection.cpp.

521 {
522  if( !aOther->IsBus() )
523  return false;
524 
525  for( const auto& member : aOther->Members() )
526  {
527  if( member->FullLocalName() == FullLocalName() )
528  return true;
529  }
530 
531  return false;
532 }
wxString FullLocalName() const
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members()
bool IsBus() const

References FullLocalName(), IsBus(), and Members().

Referenced by CONNECTION_SUBGRAPH::ResolveDrivers().

◆ LocalName()

wxString SCH_CONNECTION::LocalName ( ) const
inline

Definition at line 163 of file sch_connection.h.

163 { return m_local_name; }
wxString m_local_name
For bus members, we want to keep track of the "local" name of a member, that is, the name it takes on...

References m_local_name.

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

◆ Members() [1/2]

std::vector< std::shared_ptr< SCH_CONNECTION > >& SCH_CONNECTION::Members ( )
inline

◆ Members() [2/2]

const std::vector< std::shared_ptr< SCH_CONNECTION > >& SCH_CONNECTION::Members ( ) const
inline

Definition at line 261 of file sch_connection.h.

262  {
263  return m_members;
264  }
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
For bus connections, store a list of member connections.

References m_members.

◆ MightBeBusLabel()

bool SCH_CONNECTION::MightBeBusLabel ( const wxString &  aLabel)
static

Test if aLabel looks like a bus notation.

This check is much less expensive than IsBusLabel.

Parameters
aLabelA wxString object containing the label to test.
Returns
true if text might be a bus label

Definition at line 411 of file sch_connection.cpp.

412 {
413  // Weak heuristic for performance reasons. Stronger test will be used for connectivity
414  wxString label = UnescapeString( aLabel );
415 
416  return label.Contains( wxT( "[" ) ) || label.Contains( wxT( "{" ) );
417 }
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:125

References UnescapeString().

Referenced by SCH_SCREEN::IsTerminalPoint().

◆ Name()

◆ NetCode()

int SCH_CONNECTION::NetCode ( ) const
inline

Definition at line 206 of file sch_connection.h.

207  {
208  return m_net_code;
209  }

References m_net_code.

Referenced by Clone().

◆ operator!=()

bool SCH_CONNECTION::operator!= ( const SCH_CONNECTION aOther) const

Definition at line 116 of file sch_connection.cpp.

117 {
118  return !( aOther == *this );
119 }

◆ operator==()

bool SCH_CONNECTION::operator== ( const SCH_CONNECTION aOther) const

Note: the equality operator for SCH_CONNECTION only tests the net properties, not the ownership / sheet location!

Definition at line 79 of file sch_connection.cpp.

80 {
81  // NOTE: Not comparing m_dirty or net/bus/subgraph codes
82  if( ( aOther.m_driver == m_driver ) &&
83  ( aOther.m_type == m_type ) &&
84  ( aOther.m_name == m_name ) &&
85  ( aOther.m_sheet == m_sheet ) )
86  {
87  return true;
88  }
89 
90  return false;
91 }
wxString m_name
Name of the connection.
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
CONNECTION_TYPE m_type
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.

References m_driver, m_name, m_sheet, and m_type.

◆ Parent()

SCH_ITEM* SCH_CONNECTION::Parent ( ) const
inline

Definition at line 104 of file sch_connection.h.

105  {
106  return m_parent;
107  }
SCH_ITEM * m_parent
The SCH_ITEM this connection is owned by.

References m_parent.

Referenced by IsDriver(), recacheName(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ Prefix()

wxString SCH_CONNECTION::Prefix ( ) const
inline

Definition at line 176 of file sch_connection.h.

177  {
178  return m_prefix;
179  }
wxString m_prefix
Prefix if connection is member of a labeled bus group (or "" if not)

References m_prefix.

Referenced by Clone().

◆ PrintBusForUI()

wxString SCH_CONNECTION::PrintBusForUI ( const wxString &  aString)
static

Definition at line 438 of file sch_connection.cpp.

439 {
440  size_t groupLen = aGroup.length();
441  size_t i = 0;
442  wxString ret;
443  int braceNesting = 0;
444  int tildeNesting = 0;
445 
446  // Parse prefix
447  //
448  for( ; i < groupLen; ++i )
449  {
450  if( isSuperSub( aGroup[i] ) && i + 1 < groupLen && aGroup[i+1] == '{' )
451  {
452  braceNesting++;
453  i++;
454  continue;
455  }
456  else if( aGroup[i] == '~' )
457  {
458  if( tildeNesting )
459  {
460  tildeNesting = 0;
461  continue;
462  }
463  else
464  {
465  tildeNesting++;
466  }
467  }
468  else if( aGroup[i] == '}' )
469  {
470  braceNesting--;
471  continue;
472  }
473 
474  ret += aGroup[i];
475 
476  if( aGroup[i] == '{' )
477  break;
478  }
479 
480  // Parse members
481  //
482  i++; // '{' character
483 
484  for( ; i < groupLen; ++i )
485  {
486  if( isSuperSub( aGroup[i] ) && i + 1 < groupLen && aGroup[i+1] == '{' )
487  {
488  braceNesting++;
489  i++;
490  continue;
491  }
492  else if( aGroup[i] == '~' )
493  {
494  if( tildeNesting )
495  {
496  tildeNesting = 0;
497  continue;
498  }
499  else
500  {
501  tildeNesting++;
502  }
503  }
504  else if( aGroup[i] == '}' )
505  {
506  braceNesting--;
507  continue;
508  }
509 
510  ret += aGroup[i];
511 
512  if( aGroup[i] == '}' )
513  break;
514  }
515 
516  return ret;
517 }
static bool isSuperSub(wxChar c)

References isSuperSub().

Referenced by BUS_UNFOLD_MENU::update().

◆ RawName()

const wxString& SCH_CONNECTION::RawName ( ) const
inline

Definition at line 158 of file sch_connection.h.

159  {
160  return m_name;
161  }
wxString m_name
Name of the connection.

References m_name.

◆ recacheName()

void SCH_CONNECTION::recacheName ( )
private

Definition at line 279 of file sch_connection.cpp.

280 {
281  m_cached_name = m_name.IsEmpty() ? "<NO NET>" : m_prefix + m_name + m_suffix;
282 
283  bool prepend_path = true;
284 
285  if( !Parent() || m_type == CONNECTION_TYPE::NONE )
286  prepend_path = false;
287 
288  if( m_driver )
289  {
290  switch( m_driver->Type() )
291  {
292  case SCH_GLOBAL_LABEL_T:
293  case SCH_PIN_T:
294  // Pins are either power connections or belong to a uniquely-annotated
295  // component, so they don't need a path if they are driving the subgraph
296  prepend_path = false;
297  break;
298 
299  default:
300  break;
301  }
302  }
303 
306 }
wxString m_cached_name
Full name, including prefix and suffix.
wxString m_name
Name of the connection.
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
wxString m_cached_name_with_path
Full name including sheet path (if not global)
CONNECTION_TYPE m_type
No connection to this item.
wxString m_prefix
Prefix if connection is member of a labeled bus group (or "" if not)
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.
wxString m_suffix
Name suffix (used only for disambiguation)
SCH_ITEM * Parent() const
wxString PathHumanReadable() const
Function PathHumanReadable returns the sheet path in a human readable form, i.e.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References m_cached_name, m_cached_name_with_path, m_driver, m_name, m_prefix, m_sheet, m_suffix, m_type, NONE, Parent(), SCH_SHEET_PATH::PathHumanReadable(), SCH_GLOBAL_LABEL_T, SCH_PIN_T, and EDA_ITEM::Type().

Referenced by Clone(), ConfigureFromLabel(), SetDriver(), SetName(), SetPrefix(), SetSheet(), SetSuffix(), and SetType().

◆ Reset()

void SCH_CONNECTION::Reset ( )

Clears connectivity information.

Definition at line 195 of file sch_connection.cpp.

196 {
198  m_name.Empty();
199  m_local_name.Empty();
200  m_cached_name.Empty();
201  m_cached_name_with_path.Empty();
202  m_prefix.Empty();
203  m_bus_prefix.Empty();
204  m_suffix .Empty();
205  m_driver = nullptr;
206  m_members.clear();
207  m_dirty = true;
208  m_net_code = 0;
209  m_bus_code = 0;
210  m_subgraph_code = 0;
211  m_vector_start = 0;
212  m_vector_end = 0;
213  m_vector_index = 0;
214  m_vector_prefix.Empty();
215 }
int m_subgraph_code
Groups directly-connected items.
wxString m_cached_name
Full name, including prefix and suffix.
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
For bus connections, store a list of member connections.
wxString m_name
Name of the connection.
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
wxString m_bus_prefix
Optional prefix of a bux group (always empty for nets and vector buses)
wxString m_cached_name_with_path
Full name including sheet path (if not global)
CONNECTION_TYPE m_type
No connection to this item.
wxString m_prefix
Prefix if connection is member of a labeled bus group (or "" if not)
wxString m_suffix
Name suffix (used only for disambiguation)
wxString m_local_name
For bus members, we want to keep track of the "local" name of a member, that is, the name it takes on...
long m_vector_start
Highest member of a vector bus.
long m_vector_index
Index of bus vector member nets.
long m_vector_end
Lowest member of a vector bus.
wxString m_vector_prefix

References m_bus_code, m_bus_prefix, m_cached_name, m_cached_name_with_path, m_dirty, m_driver, m_local_name, m_members, m_name, m_net_code, m_prefix, m_subgraph_code, m_suffix, m_type, m_vector_end, m_vector_index, m_vector_prefix, m_vector_start, and NONE.

Referenced by SCH_ITEM::InitializeConnection(), and SCH_CONNECTION().

◆ SetBusCode()

void SCH_CONNECTION::SetBusCode ( int  aCode)
inline

Definition at line 221 of file sch_connection.h.

222  {
223  m_bus_code = aCode;
224  }

References m_bus_code.

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ SetDirty()

void SCH_CONNECTION::SetDirty ( )
inline

Definition at line 146 of file sch_connection.h.

147  {
148  m_dirty = true;
149  }

References m_dirty.

◆ SetDriver()

void SCH_CONNECTION::SetDriver ( SCH_ITEM aItem)

Definition at line 94 of file sch_connection.cpp.

95 {
96  m_driver = aItem;
97 
98  recacheName();
99 
100  for( const auto& member : m_members )
101  member->SetDriver( aItem );
102 }
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
For bus connections, store a list of member connections.
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.

References m_driver, m_members, and recacheName().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ SetGraph()

void SCH_CONNECTION::SetGraph ( CONNECTION_GRAPH aGraph)
inline

Definition at line 79 of file sch_connection.h.

80  {
81  m_graph = aGraph;
82  }
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.

References m_graph.

◆ SetName()

void SCH_CONNECTION::SetName ( const wxString &  aName)
inline

Definition at line 170 of file sch_connection.h.

171  {
172  m_name = aName;
173  recacheName();
174  }
wxString m_name
Name of the connection.

References m_name, and recacheName().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ SetNetCode()

void SCH_CONNECTION::SetNetCode ( int  aCode)
inline

Definition at line 211 of file sch_connection.h.

212  {
213  m_net_code = aCode;
214  }

References m_net_code.

Referenced by CONNECTION_GRAPH::assignNewNetCode(), and CONNECTION_GRAPH::buildConnectionGraph().

◆ SetPrefix()

void SCH_CONNECTION::SetPrefix ( const wxString &  aPrefix)

Definition at line 309 of file sch_connection.cpp.

310 {
311  m_prefix = aPrefix;
312 
313  recacheName();
314 
315  for( const auto& m : Members() )
316  m->SetPrefix( aPrefix );
317 }
wxString m_prefix
Prefix if connection is member of a labeled bus group (or "" if not)
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members()

References m_prefix, Members(), and recacheName().

◆ SetSheet()

void SCH_CONNECTION::SetSheet ( SCH_SHEET_PATH  aSheet)

Definition at line 105 of file sch_connection.cpp.

106 {
107  m_sheet = aSheet;
108 
109  recacheName();
110 
111  for( const auto& member : m_members )
112  member->SetSheet( aSheet );
113 }
std::vector< std::shared_ptr< SCH_CONNECTION > > m_members
For bus connections, store a list of member connections.
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.

References m_members, m_sheet, and recacheName().

Referenced by SCH_ITEM::InitializeConnection().

◆ SetSubgraphCode()

void SCH_CONNECTION::SetSubgraphCode ( int  aCode)
inline

Definition at line 231 of file sch_connection.h.

232  {
233  m_subgraph_code = aCode;
234  }
int m_subgraph_code
Groups directly-connected items.

References m_subgraph_code.

Referenced by CONNECTION_SUBGRAPH::Absorb(), and CONNECTION_GRAPH::buildConnectionGraph().

◆ SetSuffix()

void SCH_CONNECTION::SetSuffix ( const wxString &  aSuffix)

Definition at line 320 of file sch_connection.cpp.

321 {
322  m_suffix = aSuffix;
323 
324  recacheName();
325 
326  for( const auto& m : Members() )
327  m->SetSuffix( aSuffix );
328 }
wxString m_suffix
Name suffix (used only for disambiguation)
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members()

References m_suffix, Members(), and recacheName().

◆ SetType()

void SCH_CONNECTION::SetType ( CONNECTION_TYPE  aType)
inline

Definition at line 200 of file sch_connection.h.

201  {
202  m_type = aType;
203  recacheName();
204  }
CONNECTION_TYPE m_type

References m_type, and recacheName().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ Sheet()

SCH_SHEET_PATH SCH_CONNECTION::Sheet ( ) const
inline

Definition at line 114 of file sch_connection.h.

115  {
116  return m_sheet;
117  }
SCH_SHEET_PATH m_sheet
The hierarchical sheet this connection is on.

References m_sheet.

Referenced by Clone(), and BACK_ANNOTATE::processNetNameChange().

◆ SubgraphCode()

int SCH_CONNECTION::SubgraphCode ( ) const
inline

Definition at line 226 of file sch_connection.h.

227  {
228  return m_subgraph_code;
229  }
int m_subgraph_code
Groups directly-connected items.

References m_subgraph_code.

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ Suffix()

wxString SCH_CONNECTION::Suffix ( ) const
inline

Definition at line 186 of file sch_connection.h.

187  {
188  return m_suffix;
189  }
wxString m_suffix
Name suffix (used only for disambiguation)

References m_suffix.

Referenced by Clone().

◆ Type()

CONNECTION_TYPE SCH_CONNECTION::Type ( ) const
inline

Definition at line 195 of file sch_connection.h.

196  {
197  return m_type;
198  }
CONNECTION_TYPE m_type

References m_type.

Referenced by Clone(), CONNECTION_SUBGRAPH::GetBusLabels(), IsDriver(), and CONNECTION_GRAPH::matchBusMember().

◆ VectorEnd()

long SCH_CONNECTION::VectorEnd ( ) const
inline

Definition at line 241 of file sch_connection.h.

242  {
243  return m_vector_end;
244  }
long m_vector_end
Lowest member of a vector bus.

References m_vector_end.

Referenced by Clone(), and NETLIST_OBJECT::ConvertBusToNetListItems().

◆ VectorIndex()

long SCH_CONNECTION::VectorIndex ( ) const
inline

Definition at line 246 of file sch_connection.h.

247  {
248  return m_vector_index;
249  }
long m_vector_index
Index of bus vector member nets.

References m_vector_index.

Referenced by CONNECTION_GRAPH::matchBusMember().

◆ VectorPrefix()

wxString SCH_CONNECTION::VectorPrefix ( ) const
inline

Definition at line 251 of file sch_connection.h.

252  {
253  return m_vector_prefix;
254  }
wxString m_vector_prefix

References m_vector_prefix.

Referenced by Clone().

◆ VectorStart()

long SCH_CONNECTION::VectorStart ( ) const
inline

Definition at line 236 of file sch_connection.h.

237  {
238  return m_vector_start;
239  }
long m_vector_start
Highest member of a vector bus.

References m_vector_start.

Referenced by Clone(), and NETLIST_OBJECT::ConvertBusToNetListItems().

Member Data Documentation

◆ m_bus_code

int SCH_CONNECTION::m_bus_code
private

Definition at line 343 of file sch_connection.h.

Referenced by AppendInfoToMsgPanel(), BusCode(), Clone(), Reset(), and SetBusCode().

◆ m_bus_prefix

wxString SCH_CONNECTION::m_bus_prefix
private

Optional prefix of a bux group (always empty for nets and vector buses)

Definition at line 337 of file sch_connection.h.

Referenced by BusPrefix(), Clone(), ConfigureFromLabel(), and Reset().

◆ m_cached_name

wxString SCH_CONNECTION::m_cached_name
private

Full name, including prefix and suffix.

Definition at line 320 of file sch_connection.h.

Referenced by Name(), recacheName(), and Reset().

◆ m_cached_name_with_path

wxString SCH_CONNECTION::m_cached_name_with_path
private

Full name including sheet path (if not global)

Definition at line 322 of file sch_connection.h.

Referenced by Name(), recacheName(), and Reset().

◆ m_dirty

bool SCH_CONNECTION::m_dirty
private

Definition at line 308 of file sch_connection.h.

Referenced by ClearDirty(), IsDirty(), Reset(), and SetDirty().

◆ m_driver

SCH_ITEM* SCH_CONNECTION::m_driver
private

The SCH_ITEM that drives this connection's net.

Definition at line 314 of file sch_connection.h.

Referenced by Clone(), Driver(), operator==(), recacheName(), Reset(), and SetDriver().

◆ m_graph

CONNECTION_GRAPH* SCH_CONNECTION::m_graph
private

Pointer to the connection graph for the schematic this connection exists on.

Needed for bus alias lookups.

Definition at line 368 of file sch_connection.h.

Referenced by AppendInfoToMsgPanel(), Clone(), ConfigureFromLabel(), and SetGraph().

◆ m_local_name

wxString SCH_CONNECTION::m_local_name
private

For bus members, we want to keep track of the "local" name of a member, that is, the name it takes on from its parent bus name.

This is because we always want to use the local name for bus unfolding, matching within buses, etc. The actual resolved name of this bus member might change, for example if it's connected elsewhere to some other item with higher priority.

Definition at line 331 of file sch_connection.h.

Referenced by ConfigureFromLabel(), FullLocalName(), LocalName(), and Reset().

◆ m_members

std::vector< std::shared_ptr< SCH_CONNECTION > > SCH_CONNECTION::m_members
private

For bus connections, store a list of member connections.

NOTE: All connections that Clone() others share the list of member pointers. This seems fine at the moment.

Definition at line 362 of file sch_connection.h.

Referenced by AllMembers(), Clone(), ConfigureFromLabel(), Members(), Reset(), SetDriver(), and SetSheet().

◆ m_name

wxString SCH_CONNECTION::m_name
private

Name of the connection.

Definition at line 318 of file sch_connection.h.

Referenced by AppendInfoToMsgPanel(), Clone(), ConfigureFromLabel(), operator==(), RawName(), recacheName(), Reset(), and SetName().

◆ m_net_code

int SCH_CONNECTION::m_net_code
private

Definition at line 341 of file sch_connection.h.

Referenced by AppendInfoToMsgPanel(), Clone(), NetCode(), Reset(), and SetNetCode().

◆ m_parent

SCH_ITEM* SCH_CONNECTION::m_parent
private

The SCH_ITEM this connection is owned by.

Definition at line 312 of file sch_connection.h.

Referenced by ConfigureFromLabel(), and Parent().

◆ m_prefix

wxString SCH_CONNECTION::m_prefix
private

Prefix if connection is member of a labeled bus group (or "" if not)

Definition at line 334 of file sch_connection.h.

Referenced by Clone(), ConfigureFromLabel(), FullLocalName(), Prefix(), recacheName(), Reset(), and SetPrefix().

◆ m_sheet

SCH_SHEET_PATH SCH_CONNECTION::m_sheet
private

The hierarchical sheet this connection is on.

Definition at line 310 of file sch_connection.h.

Referenced by Clone(), ConfigureFromLabel(), IsDriver(), operator==(), recacheName(), SetSheet(), and Sheet().

◆ m_subgraph_code

int SCH_CONNECTION::m_subgraph_code
private

Groups directly-connected items.

Definition at line 345 of file sch_connection.h.

Referenced by AppendInfoToMsgPanel(), Reset(), SetSubgraphCode(), and SubgraphCode().

◆ m_suffix

wxString SCH_CONNECTION::m_suffix
private

Name suffix (used only for disambiguation)

Definition at line 339 of file sch_connection.h.

Referenced by Clone(), FullLocalName(), recacheName(), Reset(), SetSuffix(), and Suffix().

◆ m_type

CONNECTION_TYPE SCH_CONNECTION::m_type
private

◆ m_vector_end

long SCH_CONNECTION::m_vector_end
private

Lowest member of a vector bus.

Prefix name of the vector, if m_type == CONNECTION_BUS (or "" if not)

Definition at line 351 of file sch_connection.h.

Referenced by Clone(), Reset(), and VectorEnd().

◆ m_vector_index

long SCH_CONNECTION::m_vector_index
private

Index of bus vector member nets.

Definition at line 347 of file sch_connection.h.

Referenced by Reset(), and VectorIndex().

◆ m_vector_prefix

wxString SCH_CONNECTION::m_vector_prefix
private

Definition at line 354 of file sch_connection.h.

Referenced by Clone(), ConfigureFromLabel(), Reset(), and VectorPrefix().

◆ m_vector_start

long SCH_CONNECTION::m_vector_start
private

Highest member of a vector bus.

Definition at line 349 of file sch_connection.h.

Referenced by Clone(), Reset(), and VectorStart().


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