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 (const SCH_CONNECTION &aOther)
 Copies connectivity information (but not parent) from another connection. More...
 
SCH_ITEMParent () const
 
SCH_ITEMDriver () const
 
void SetDriver (SCH_ITEM *aItem)
 
SCH_SHEET_PATH Sheet () const
 
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 IsUnconnected () const
 
bool IsDirty () const
 
void SetDirty ()
 
void ClearDirty ()
 
bool HasDriverChanged () const
 
void ClearDriverChanged ()
 
void * GetLastDriver () const
 
wxString Name (bool aIgnoreSheet=false) const
 
wxString LocalName () const
 
wxString FullLocalName () const
 
void SetName (const wxString &aName)
 
wxString Prefix () const
 
void SetPrefix (const wxString &aPrefix)
 
wxString BusPrefix () const
 
wxString Suffix () const
 
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...
 
void * m_lastDriver
 WEAK POINTER (there is no guarantee it is still allocated) Equality comparisons are OK, but that's pretty much it. 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_local_prefix
 Local prefix for group bus members (used with m_local_name) 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.

Symbols 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 64 of file sch_connection.cpp.

64  :
65  m_sheet( aPath ),
66  m_parent( aParent ),
67  m_driver( nullptr ),
68  m_graph( nullptr )
69 {
70  Reset();
71 }
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
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 74 of file sch_connection.cpp.

74  :
76  m_parent( nullptr ),
77  m_driver( nullptr ),
78  m_graph( aGraph )
79 {
80  Reset();
81 }
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
void Reset()
Clears connectivity information.
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
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 488 of file sch_connection.cpp.

489 {
490  std::vector< std::shared_ptr< SCH_CONNECTION > > ret( m_members );
491 
492  for( const auto& member : m_members )
493  if( member->IsBus() )
494  ret.insert( ret.end(), member->Members().begin(), member->Members().end() );
495 
496  return ret;
497 }
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 399 of file sch_connection.cpp.

400 {
401  wxString msg, group_name;
402  std::vector<wxString> group_members;
403 
404  aList.push_back( MSG_PANEL_ITEM( _( "Connection Name" ), UnescapeString( Name() ) ) );
405 
406  // NOTE(JE) Disabling this for now, because net codes are generated in the netlist exporter
407  // in order to avoid sort costs. It may make sense to just tear out net codes from the
408  // CONNECTION_GRAPH entirely in the future, as they are mostly only useful for netlist exports.
409 #if 0
410  if( !IsBus() )
411  {
412  msg.Printf( "%d", m_net_code );
413  aList.push_back( MSG_PANEL_ITEM( _( "Net Code" ), msg ) );
414  }
415 #endif
416 
417  if( auto alias = m_graph->GetBusAlias( m_name ) )
418  {
419  msg.Printf( _( "Bus Alias %s Members" ), m_name );
420 
421  wxString members;
422 
423  for( const auto& member : alias->Members() )
424  members << member << " ";
425 
426  aList.push_back( MSG_PANEL_ITEM( msg, members ) );
427  }
428  else if( NET_SETTINGS::ParseBusGroup( m_name, &group_name, &group_members ) )
429  {
430  for( const auto& group_member : group_members )
431  {
432  if( auto group_alias = m_graph->GetBusAlias( group_member ) )
433  {
434  msg.Printf( _( "Bus Alias %s Members" ), group_alias->GetName() );
435 
436  wxString members;
437 
438  for( const auto& member : group_alias->Members() )
439  members << member << " ";
440 
441  aList.push_back( MSG_PANEL_ITEM( msg, members ) );
442  }
443  }
444  }
445 
446 #if defined(DEBUG)
447  // These messages are not flagged as translatable, because they are only debug messages
448 
449  if( !ADVANCED_CFG::GetCfg().m_RealTimeConnectivity || !CONNECTION_GRAPH::m_allowRealTime )
450  return;
451 
452  if( IsBus() )
453  {
454  msg.Printf( "%d", m_bus_code );
455  aList.push_back( MSG_PANEL_ITEM( "Bus Code", msg ) );
456  }
457 
458  msg.Printf( "%d", m_subgraph_code );
459  aList.push_back( MSG_PANEL_ITEM( "Subgraph Code", msg ) );
460 
461  if( auto driver = Driver() )
462  {
463  msg.Printf( "%s at %p", driver->GetSelectMenuText( EDA_UNITS::MILLIMETRES ), driver );
464  aList.push_back( MSG_PANEL_ITEM( "Connection Source", msg ) );
465  }
466 #endif
467 }
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.
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 Name(bool aIgnoreSheet=false) const
SCH_ITEM * Driver() const
CONNECTION_GRAPH * m_graph
Pointer to the connection graph for the schematic this connection exists on.
static bool m_allowRealTime
#define _(s)
Definition: 3d_actions.cpp:33
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:151
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:54
bool IsBus() const

References _, 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(), and UnescapeString().

Referenced by SCH_PIN::GetMsgPanelInfo().

◆ BusCode()

int SCH_CONNECTION::BusCode ( ) const
inline

Definition at line 174 of file sch_connection.h.

174 { return m_bus_code; }

References m_bus_code.

Referenced by Clone().

◆ BusPrefix()

wxString SCH_CONNECTION::BusPrefix ( ) const
inline

Definition at line 158 of file sch_connection.h.

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

References m_bus_prefix.

◆ ClearDirty()

void SCH_CONNECTION::ClearDirty ( )
inline

Definition at line 134 of file sch_connection.h.

134 { m_dirty = false; }

References m_dirty.

Referenced by CONNECTION_SUBGRAPH::ResolveDrivers(), and CONNECTION_SUBGRAPH::UpdateItemConnections().

◆ ClearDriverChanged()

void SCH_CONNECTION::ClearDriverChanged ( )

Definition at line 333 of file sch_connection.cpp.

334 {
336 }
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
void * m_lastDriver
WEAK POINTER (there is no guarantee it is still allocated) Equality comparisons are OK,...

References m_driver, and m_lastDriver.

Referenced by SCH_EDIT_FRAME::OnModify().

◆ Clone()

void SCH_CONNECTION::Clone ( const SCH_CONNECTION aOther)

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

Parameters
aOtheris the connection to clone

Definition at line 227 of file sch_connection.cpp.

228 {
229  m_graph = aOther.m_graph;
230  // Note: m_lastDriver is not cloned as it needs to be the last driver of *this* connection
231  m_driver = aOther.Driver();
232  m_sheet = aOther.Sheet();
233  m_name = aOther.m_name;
234  // Note: m_local_name is not cloned if not set yet
235  if( m_local_name.IsEmpty() )
236  {
237  m_local_name = aOther.LocalName();
238  m_local_prefix = aOther.Prefix();
239  }
240 
241  m_prefix = aOther.Prefix();
242  // m_bus_prefix is not cloned; only used for local names
243  m_suffix = aOther.Suffix();
244  m_net_code = aOther.NetCode();
245  m_bus_code = aOther.BusCode();
246  m_vector_start = aOther.VectorStart();
247  m_vector_end = aOther.VectorEnd();
248  // Note: m_vector_index is not cloned
249  m_vector_prefix = aOther.VectorPrefix();
250 
251  // Note: subgraph code isn't cloned, it should remain with the original object
252 
253  // Handle vector bus members: make sure local names are preserved where possible
254  const std::vector<std::shared_ptr<SCH_CONNECTION>>& otherMembers = aOther.Members();
255 
256  if( m_type == CONNECTION_TYPE::BUS && aOther.Type() == CONNECTION_TYPE::BUS )
257  {
258  if( m_members.empty() )
259  {
260  m_members = otherMembers;
261  }
262  else
263  {
264  size_t cloneLimit = std::min( m_members.size(), otherMembers.size() );
265 
266  for( size_t i = 0; i < cloneLimit; ++i )
267  m_members[i]->Clone( *otherMembers[i] );
268  }
269  }
271  {
272  if( m_members.empty() )
273  {
274  m_members = otherMembers;
275  }
276  else
277  {
278  // TODO: refactor this once we support deep nesting
279  for( size_t i = 0; i < m_members.size(); ++i )
280  {
281  auto it = std::find_if( otherMembers.begin(), otherMembers.end(),
282  [&]( const std::shared_ptr<SCH_CONNECTION>& aTest )
283  {
284  return aTest->LocalName() == m_members[i]->LocalName();
285  } );
286 
287  if( it != otherMembers.end() )
288  m_members[i]->Clone( **it );
289  }
290  }
291  }
292 
293  m_type = aOther.Type();
294 
295  recacheName();
296 }
wxString Prefix() const
void Clone(const SCH_CONNECTION &aOther)
Copies connectivity information (but not parent) from another connection.
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.
This item represents a bus group.
wxString LocalName() const
int BusCode() const
CONNECTION_TYPE m_type
int NetCode() const
wxString Suffix() const
long VectorEnd() const
wxString m_local_prefix
Local prefix for group bus members (used with m_local_name)
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)
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...
SCH_SHEET_PATH Sheet() const
long m_vector_start
Highest member of a vector bus.
wxString VectorPrefix() 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
This item represents a bus vector.

References BUS, BUS_GROUP, BusCode(), Driver(), LocalName(), m_bus_code, m_driver, m_graph, m_local_name, m_local_prefix, 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 127 of file sch_connection.cpp.

128 {
129  m_members.clear();
130 
131  m_name = aLabel;
132  m_local_name = aLabel;
134 
135  wxString prefix;
136  std::vector<wxString> members;
137 
138  wxString unescaped = UnescapeString( aLabel );
139 
140  if( NET_SETTINGS::ParseBusVector( unescaped, &prefix, &members ) )
141  {
143  m_vector_prefix = prefix;
144 
145  long i = 0;
146 
147  for( const wxString& vector_member : members )
148  {
149  auto member = std::make_shared<SCH_CONNECTION>( m_parent, m_sheet );
150  member->m_type = CONNECTION_TYPE::NET;
151  member->m_prefix = m_prefix;
152  member->m_local_name = vector_member;
153  member->m_local_prefix = m_prefix;
154  member->m_vector_index = i++;
155  member->SetName( vector_member );
156  member->SetGraph( m_graph );
157  m_members.push_back( member );
158  }
159  }
160  else if( NET_SETTINGS::ParseBusGroup( unescaped, &prefix, &members ) )
161  {
163  m_bus_prefix = prefix;
164 
165  // Named bus groups generate a net prefix, unnamed ones don't
166  if( !prefix.IsEmpty() )
167  prefix += wxT( "." );
168 
169  for( const wxString& group_member : members )
170  {
171  // Handle alias inside bus group member list
172  if( auto alias = m_graph->GetBusAlias( group_member ) )
173  {
174  for( const wxString& alias_member : alias->Members() )
175  {
176  auto member = std::make_shared< SCH_CONNECTION >( m_parent, m_sheet );
177  member->SetPrefix( prefix );
178  member->SetGraph( m_graph );
179  member->ConfigureFromLabel( alias_member );
180  m_members.push_back( member );
181  }
182  }
183  else
184  {
185  auto member = std::make_shared< SCH_CONNECTION >( m_parent, m_sheet );
186  member->SetPrefix( prefix );
187  member->SetGraph( m_graph );
188  member->ConfigureFromLabel( group_member );
189  m_members.push_back( member );
190  }
191  }
192  }
193  else
194  {
196  }
197 
198  recacheName();
199 }
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_local_prefix
Local prefix for group bus members (used with m_local_name)
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:151
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_local_prefix, 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(), DIALOG_MIGRATE_BUSES::getProposedLabels(), and CONNECTION_SUBGRAPH::ResolveDrivers().

◆ Driver()

SCH_ITEM* SCH_CONNECTION::Driver ( ) const
inline

Definition at line 106 of file sch_connection.h.

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

References m_driver.

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

◆ FullLocalName()

wxString SCH_CONNECTION::FullLocalName ( ) const
inline

Definition at line 144 of file sch_connection.h.

145  {
147  }
wxString m_local_prefix
Local prefix for group bus members (used with m_local_name)
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_local_prefix, and m_suffix.

Referenced by IsSubsetOf().

◆ GetLastDriver()

void* SCH_CONNECTION::GetLastDriver ( ) const
inline

Definition at line 138 of file sch_connection.h.

138 { return m_lastDriver; }
void * m_lastDriver
WEAK POINTER (there is no guarantee it is still allocated) Equality comparisons are OK,...

References m_lastDriver.

◆ HasDriverChanged()

bool SCH_CONNECTION::HasDriverChanged ( ) const

Definition at line 327 of file sch_connection.cpp.

328 {
329  return m_driver != m_lastDriver;
330 }
SCH_ITEM * m_driver
The SCH_ITEM that drives this connection's net.
void * m_lastDriver
WEAK POINTER (there is no guarantee it is still allocated) Equality comparisons are OK,...

References m_driver, and m_lastDriver.

Referenced by SCH_EDIT_FRAME::OnModify().

◆ 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 470 of file sch_connection.cpp.

471 {
472  const wxString& unescaped = UnescapeString( aLabel );
473 
474  return NET_SETTINGS::ParseBusVector( unescaped, nullptr, nullptr )
475  || NET_SETTINGS::ParseBusGroup( unescaped, nullptr, nullptr );
476 }
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:151
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().

◆ IsDirty()

bool SCH_CONNECTION::IsDirty ( ) const
inline

Definition at line 132 of file sch_connection.h.

132 { return m_dirty; }

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 299 of file sch_connection.cpp.

300 {
301  wxASSERT( Parent() );
302 
303  switch( Parent()->Type() )
304  {
305  case SCH_LABEL_T:
306  case SCH_GLOBAL_LABEL_T:
307  case SCH_HIER_LABEL_T:
308  case SCH_SHEET_PIN_T:
309  case SCH_SHEET_T:
310  case LIB_PIN_T:
311  return true;
312 
313  case SCH_PIN_T:
314  {
315  auto pin = static_cast<SCH_PIN*>( Parent() );
316 
317  // Only annotated components should drive nets
318  return pin->IsPowerConnection() || pin->GetParentSymbol()->IsAnnotated( &m_sheet );
319  }
320 
321  default:
322  return false;
323  }
324 }
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(), pin, 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 603 of file sch_connection.cpp.

604 {
605  if( !aOther->IsBus() )
606  return false;
607 
608  auto me = Name( true );
609 
610  for( const auto& m : aOther->Members() )
611  if( m->Name( true ) == me )
612  return true;
613 
614  return false;
615 }
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 588 of file sch_connection.cpp.

589 {
590  if( !aOther->IsBus() )
591  return false;
592 
593  for( const auto& member : aOther->Members() )
594  {
595  if( member->FullLocalName() == FullLocalName() )
596  return true;
597  }
598 
599  return false;
600 }
wxString FullLocalName() const
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members()
bool IsBus() const

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

Referenced by CONNECTION_SUBGRAPH::ResolveDrivers().

◆ IsUnconnected()

bool SCH_CONNECTION::IsUnconnected ( ) const
inline

Definition at line 130 of file sch_connection.h.

130 { return ( m_type == CONNECTION_TYPE::NONE ); }
CONNECTION_TYPE m_type
No connection to this item.

References m_type, and NONE.

Referenced by EE_SELECTION_TOOL::Main().

◆ LocalName()

wxString SCH_CONNECTION::LocalName ( ) const
inline

Definition at line 142 of file sch_connection.h.

142 { 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 Clone(), 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 192 of file sch_connection.h.

193  {
194  return m_members;
195  }
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 479 of file sch_connection.cpp.

480 {
481  // Weak heuristic for performance reasons. Stronger test will be used for connectivity
482  wxString label = UnescapeString( aLabel );
483 
484  return label.Contains( wxT( "[" ) ) || label.Contains( wxT( "{" ) );
485 }
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:151

References UnescapeString().

◆ Name()

◆ NetCode()

int SCH_CONNECTION::NetCode ( ) const
inline

Definition at line 171 of file sch_connection.h.

171 { return m_net_code; }

References m_net_code.

Referenced by Clone().

◆ operator!=()

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

Definition at line 121 of file sch_connection.cpp.

122 {
123  return !( aOther == *this );
124 }

◆ 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 84 of file sch_connection.cpp.

85 {
86  // NOTE: Not comparing m_dirty or net/bus/subgraph codes
87  if( ( aOther.m_driver == m_driver ) &&
88  ( aOther.m_type == m_type ) &&
89  ( aOther.m_name == m_name ) &&
90  ( aOther.m_sheet == m_sheet ) )
91  {
92  return true;
93  }
94 
95  return false;
96 }
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.

104 { return m_parent; }
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 155 of file sch_connection.h.

155 { return m_prefix; }
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 506 of file sch_connection.cpp.

507 {
508  size_t groupLen = aGroup.length();
509  size_t i = 0;
510  wxString ret;
511  int braceNesting = 0;
512  int tildeNesting = 0;
513 
514  // Parse prefix
515  //
516  for( ; i < groupLen; ++i )
517  {
518  if( isSuperSub( aGroup[i] ) && i + 1 < groupLen && aGroup[i+1] == '{' )
519  {
520  braceNesting++;
521  i++;
522  continue;
523  }
524  else if( aGroup[i] == '~' )
525  {
526  if( tildeNesting )
527  {
528  tildeNesting = 0;
529  continue;
530  }
531  else
532  {
533  tildeNesting++;
534  }
535  }
536  else if( aGroup[i] == '}' )
537  {
538  braceNesting--;
539  continue;
540  }
541 
542  ret += aGroup[i];
543 
544  if( aGroup[i] == '{' )
545  break;
546  }
547 
548  // Parse members
549  //
550  i++; // '{' character
551 
552  for( ; i < groupLen; ++i )
553  {
554  if( isSuperSub( aGroup[i] ) && i + 1 < groupLen && aGroup[i+1] == '{' )
555  {
556  braceNesting++;
557  i++;
558  continue;
559  }
560  else if( aGroup[i] == '~' )
561  {
562  if( tildeNesting )
563  {
564  tildeNesting = 0;
565  continue;
566  }
567  else
568  {
569  tildeNesting++;
570  }
571  }
572  else if( aGroup[i] == '}' )
573  {
574  braceNesting--;
575  continue;
576  }
577 
578  ret += aGroup[i];
579 
580  if( aGroup[i] == '}' )
581  break;
582  }
583 
584  return ret;
585 }
static bool isSuperSub(wxChar c)

References isSuperSub().

Referenced by BUS_UNFOLD_MENU::update().

◆ recacheName()

void SCH_CONNECTION::recacheName ( )
private

Definition at line 347 of file sch_connection.cpp.

348 {
349  m_cached_name = m_name.IsEmpty() ? "<NO NET>" : m_prefix + m_name + m_suffix;
350 
351  bool prepend_path = true;
352 
353  if( !Parent() || m_type == CONNECTION_TYPE::NONE )
354  prepend_path = false;
355 
356  if( m_driver )
357  {
358  switch( m_driver->Type() )
359  {
360  case SCH_GLOBAL_LABEL_T:
361  case SCH_PIN_T:
362  // Pins are either power connections or belong to a uniquely-annotated
363  // component, so they don't need a path if they are driving the subgraph
364  prepend_path = false;
365  break;
366 
367  default:
368  break;
369  }
370  }
371 
374 }
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 PathHumanReadable(bool aUseShortRootName=true) const
Return the sheet path in a human readable form made from the sheet names.
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
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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 202 of file sch_connection.cpp.

203 {
205  m_name.Empty();
206  m_local_name.Empty();
207  m_local_prefix.Empty();
208  m_cached_name.Empty();
209  m_cached_name_with_path.Empty();
210  m_prefix.Empty();
211  m_bus_prefix.Empty();
212  m_suffix .Empty();
214  m_driver = nullptr;
215  m_members.clear();
216  m_dirty = true;
217  m_net_code = 0;
218  m_bus_code = 0;
219  m_subgraph_code = 0;
220  m_vector_start = 0;
221  m_vector_end = 0;
222  m_vector_index = 0;
223  m_vector_prefix.Empty();
224 }
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_local_prefix
Local prefix for group bus members (used with m_local_name)
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
void * m_lastDriver
WEAK POINTER (there is no guarantee it is still allocated) Equality comparisons are OK,...

References m_bus_code, m_bus_prefix, m_cached_name, m_cached_name_with_path, m_dirty, m_driver, m_lastDriver, m_local_name, m_local_prefix, 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 175 of file sch_connection.h.

175 { m_bus_code = aCode; }

References m_bus_code.

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ SetDirty()

void SCH_CONNECTION::SetDirty ( )
inline

Definition at line 133 of file sch_connection.h.

133 { m_dirty = true; }

References m_dirty.

◆ SetDriver()

void SCH_CONNECTION::SetDriver ( SCH_ITEM aItem)

Definition at line 99 of file sch_connection.cpp.

100 {
101  m_driver = aItem;
102 
103  recacheName();
104 
105  for( const std::shared_ptr<SCH_CONNECTION>& member : m_members )
106  member->SetDriver( aItem );
107 }
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_SUBGRAPH::ResolveDrivers().

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

Referenced by SCH_ITEM::InitializeConnection().

◆ SetName()

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

Definition at line 149 of file sch_connection.h.

150  {
151  m_name = aName;
152  recacheName();
153  }
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 172 of file sch_connection.h.

172 { m_net_code = aCode; }

References m_net_code.

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

◆ SetPrefix()

void SCH_CONNECTION::SetPrefix ( const wxString &  aPrefix)

Definition at line 377 of file sch_connection.cpp.

378 {
379  m_prefix = aPrefix;
380 
381  recacheName();
382 
383  for( const auto& m : Members() )
384  m->SetPrefix( aPrefix );
385 }
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 110 of file sch_connection.cpp.

111 {
112  m_sheet = aSheet;
113 
114  recacheName();
115 
116  for( const std::shared_ptr<SCH_CONNECTION>& member : m_members )
117  member->SetSheet( aSheet );
118 }
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 178 of file sch_connection.h.

178 { m_subgraph_code = aCode; }
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 388 of file sch_connection.cpp.

389 {
390  m_suffix = aSuffix;
391 
392  recacheName();
393 
394  for( const auto& m : Members() )
395  m->SetSuffix( aSuffix );
396 }
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 165 of file sch_connection.h.

166  {
167  m_type = aType;
168  recacheName();
169  }
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 109 of file sch_connection.h.

109 { return m_sheet; }
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 177 of file sch_connection.h.

177 { return m_subgraph_code; }
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 160 of file sch_connection.h.

160 { return m_suffix; }
wxString m_suffix
Name suffix (used only for disambiguation)

References m_suffix.

Referenced by Clone().

◆ Type()

CONNECTION_TYPE SCH_CONNECTION::Type ( ) const
inline

◆ VectorEnd()

long SCH_CONNECTION::VectorEnd ( ) const
inline

Definition at line 181 of file sch_connection.h.

181 { return m_vector_end; }
long m_vector_end
Lowest member of a vector bus.

References m_vector_end.

Referenced by Clone().

◆ VectorIndex()

long SCH_CONNECTION::VectorIndex ( ) const
inline

Definition at line 183 of file sch_connection.h.

183 { return m_vector_index; }
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 185 of file sch_connection.h.

185 { return m_vector_prefix; }
wxString m_vector_prefix

References m_vector_prefix.

Referenced by Clone().

◆ VectorStart()

long SCH_CONNECTION::VectorStart ( ) const
inline

Definition at line 180 of file sch_connection.h.

180 { return m_vector_start; }
long m_vector_start
Highest member of a vector bus.

References m_vector_start.

Referenced by Clone().

Member Data Documentation

◆ m_bus_code

int SCH_CONNECTION::m_bus_code
private

Definition at line 280 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 274 of file sch_connection.h.

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

◆ m_cached_name

wxString SCH_CONNECTION::m_cached_name
private

Full name, including prefix and suffix.

Definition at line 254 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 256 of file sch_connection.h.

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

◆ m_dirty

bool SCH_CONNECTION::m_dirty
private

Definition at line 239 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 248 of file sch_connection.h.

Referenced by ClearDriverChanged(), Clone(), Driver(), HasDriverChanged(), 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 305 of file sch_connection.h.

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

◆ m_lastDriver

void* SCH_CONNECTION::m_lastDriver
private

WEAK POINTER (there is no guarantee it is still allocated) Equality comparisons are OK, but that's pretty much it.

Definition at line 245 of file sch_connection.h.

Referenced by ClearDriverChanged(), GetLastDriver(), HasDriverChanged(), and Reset().

◆ 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 265 of file sch_connection.h.

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

◆ m_local_prefix

wxString SCH_CONNECTION::m_local_prefix
private

Local prefix for group bus members (used with m_local_name)

Definition at line 271 of file sch_connection.h.

Referenced by Clone(), ConfigureFromLabel(), FullLocalName(), 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 299 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 252 of file sch_connection.h.

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

◆ m_net_code

int SCH_CONNECTION::m_net_code
private

Definition at line 278 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 243 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 268 of file sch_connection.h.

Referenced by Clone(), ConfigureFromLabel(), 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 241 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 282 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 276 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 288 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 284 of file sch_connection.h.

Referenced by Reset(), and VectorIndex().

◆ m_vector_prefix

wxString SCH_CONNECTION::m_vector_prefix
private

Definition at line 291 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 286 of file sch_connection.h.

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


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