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_ITEM *	Parent () const
SCH_ITEM *	Driver () 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_ITEM *	m_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_ITEM *	m_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_GRAPH *	m_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.

                                                                        :
        m_sheet( aPath ),
        m_parent( aParent ),
        m_driver( nullptr ),
        m_graph( nullptr )
{
    Reset();
}

References Reset().

SCH_CONNECTION() [2/2]

SCH_CONNECTION::SCH_CONNECTION

(

CONNECTION_GRAPH *

aGraph

)

Definition at line 74 of file sch_connection.cpp.

                                                         :
        m_sheet( SCH_SHEET_PATH() ),
        m_parent( nullptr ),
        m_driver( nullptr ),
        m_graph( aGraph )
{
    Reset();
}

References Reset().

~SCH_CONNECTION()

SCH_CONNECTION::~SCH_CONNECTION ( )

inline

Definition at line 68 of file sch_connection.h.

    {}

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.

{
    std::vector< std::shared_ptr< SCH_CONNECTION > > ret( m_members );

    for( const auto& member : m_members )
        if( member->IsBus() )
            ret.insert( ret.end(), member->Members().begin(), member->Members().end() );

    return ret;
}

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.

{
    wxString msg, group_name;
    std::vector<wxString> group_members;

    aList.push_back( MSG_PANEL_ITEM( _( "Connection Name" ), UnescapeString( Name() ) ) );

    // NOTE(JE) Disabling this for now, because net codes are generated in the netlist exporter
    // in order to avoid sort costs.  It may make sense to just tear out net codes from the
    // CONNECTION_GRAPH entirely in the future, as they are mostly only useful for netlist exports.
#if 0
    if( !IsBus() )
    {
        msg.Printf( "%d", m_net_code );
        aList.push_back( MSG_PANEL_ITEM( _( "Net Code" ), msg ) );
    }
#endif

    if( auto alias = m_graph->GetBusAlias( m_name ) )
    {
        msg.Printf( _( "Bus Alias %s Members" ), m_name );

        wxString members;

        for( const auto& member : alias->Members() )
            members << member << " ";

        aList.push_back( MSG_PANEL_ITEM( msg, members ) );
    }
    else if( NET_SETTINGS::ParseBusGroup( m_name, &group_name, &group_members ) )
    {
        for( const auto& group_member : group_members )
        {
            if( auto group_alias = m_graph->GetBusAlias( group_member ) )
            {
                msg.Printf( _( "Bus Alias %s Members" ), group_alias->GetName() );

                wxString members;

                for( const auto& member : group_alias->Members() )
                    members << member << " ";

                aList.push_back( MSG_PANEL_ITEM( msg, members ) );
            }
        }
    }

#if defined(DEBUG)
    // These messages are not flagged as translatable, because they are only debug messages

    if( !ADVANCED_CFG::GetCfg().m_RealTimeConnectivity || !CONNECTION_GRAPH::m_allowRealTime )
        return;

    if( IsBus() )
    {
        msg.Printf( "%d", m_bus_code );
        aList.push_back( MSG_PANEL_ITEM( "Bus Code", msg ) );
    }

    msg.Printf( "%d", m_subgraph_code );
    aList.push_back( MSG_PANEL_ITEM( "Subgraph Code", msg ) );

    if( auto driver = Driver() )
    {
        msg.Printf( "%s at %p", driver->GetSelectMenuText( EDA_UNITS::MILLIMETRES ), driver );
        aList.push_back( MSG_PANEL_ITEM( "Connection Source", msg ) );
    }
#endif
}

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.

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

{ return m_bus_prefix; }

References m_bus_prefix.

ClearDirty()

void SCH_CONNECTION::ClearDirty ( )

inline

Definition at line 134 of file sch_connection.h.

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

{
    m_lastDriver = m_driver;
}

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

aOther

is the connection to clone

Definition at line 227 of file sch_connection.cpp.

{
    m_graph = aOther.m_graph;
    // Note: m_lastDriver is not cloned as it needs to be the last driver of *this* connection
    m_driver = aOther.Driver();
    m_sheet  = aOther.Sheet();
    m_name   = aOther.m_name;
    // Note: m_local_name is not cloned if not set yet
    if( m_local_name.IsEmpty() )
    {
        m_local_name   = aOther.LocalName();
        m_local_prefix = aOther.Prefix();
    }

    m_prefix       = aOther.Prefix();
    // m_bus_prefix is not cloned; only used for local names
    m_suffix       = aOther.Suffix();
    m_net_code     = aOther.NetCode();
    m_bus_code     = aOther.BusCode();
    m_vector_start = aOther.VectorStart();
    m_vector_end   = aOther.VectorEnd();
    // Note: m_vector_index is not cloned
    m_vector_prefix = aOther.VectorPrefix();

    // Note: subgraph code isn't cloned, it should remain with the original object

    // Handle vector bus members: make sure local names are preserved where possible
    const std::vector<std::shared_ptr<SCH_CONNECTION>>& otherMembers = aOther.Members();

    if( m_type == CONNECTION_TYPE::BUS && aOther.Type() == CONNECTION_TYPE::BUS )
    {
        if( m_members.empty() )
        {
            m_members = otherMembers;
        }
        else
        {
            size_t cloneLimit = std::min( m_members.size(), otherMembers.size() );

            for( size_t i = 0; i < cloneLimit; ++i )
                m_members[i]->Clone( *otherMembers[i] );
        }
    }
    else if( m_type == CONNECTION_TYPE::BUS_GROUP && aOther.Type() == CONNECTION_TYPE::BUS_GROUP )
    {
        if( m_members.empty() )
        {
            m_members = otherMembers;
        }
        else
        {
            // TODO: refactor this once we support deep nesting
            for( size_t i = 0; i < m_members.size(); ++i )
            {
                auto it = std::find_if( otherMembers.begin(), otherMembers.end(),
                                        [&]( const std::shared_ptr<SCH_CONNECTION>& aTest )
                                        {
                                            return aTest->LocalName() == m_members[i]->LocalName();
                                        } );

                if( it != otherMembers.end() )
                    m_members[i]->Clone( **it );
            }
        }
    }

    m_type = aOther.Type();

    recacheName();
}

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.

{
    m_members.clear();

    m_name         = aLabel;
    m_local_name   = aLabel;
    m_local_prefix = m_prefix;

    wxString prefix;
    std::vector<wxString> members;

    wxString unescaped = UnescapeString( aLabel );

    if( NET_SETTINGS::ParseBusVector( unescaped, &prefix, &members ) )
    {
        m_type = CONNECTION_TYPE::BUS;
        m_vector_prefix = prefix;

        long i = 0;

        for( const wxString& vector_member : members )
        {
            auto member            = std::make_shared<SCH_CONNECTION>( m_parent, m_sheet );
            member->m_type         = CONNECTION_TYPE::NET;
            member->m_prefix       = m_prefix;
            member->m_local_name   = vector_member;
            member->m_local_prefix = m_prefix;
            member->m_vector_index = i++;
            member->SetName( vector_member );
            member->SetGraph( m_graph );
            m_members.push_back( member );
        }
    }
    else if( NET_SETTINGS::ParseBusGroup( unescaped, &prefix, &members ) )
    {
        m_type       = CONNECTION_TYPE::BUS_GROUP;
        m_bus_prefix = prefix;

        // Named bus groups generate a net prefix, unnamed ones don't
        if( !prefix.IsEmpty() )
            prefix += wxT( "." );

        for( const wxString& group_member : members )
        {
            // Handle alias inside bus group member list
            if( auto alias = m_graph->GetBusAlias( group_member ) )
            {
                for( const wxString& alias_member : alias->Members() )
                {
                    auto member = std::make_shared< SCH_CONNECTION >( m_parent, m_sheet );
                    member->SetPrefix( prefix );
                    member->SetGraph( m_graph );
                    member->ConfigureFromLabel( alias_member );
                    m_members.push_back( member );
                }
            }
            else
            {
                auto member = std::make_shared< SCH_CONNECTION >( m_parent, m_sheet );
                member->SetPrefix( prefix );
                member->SetGraph( m_graph );
                member->ConfigureFromLabel( group_member );
                m_members.push_back( member );
            }
        }
    }
    else
    {
        m_type = CONNECTION_TYPE::NET;
    }

    recacheName();
}

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.

{ return m_driver; }

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.

    {
        return m_local_prefix + m_local_name + m_suffix;
    }

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.

{ return m_lastDriver; }

References m_lastDriver.

HasDriverChanged()

bool SCH_CONNECTION::HasDriverChanged

(

)

const

Definition at line 327 of file sch_connection.cpp.

{
    return m_driver != m_lastDriver;
}

References m_driver, and m_lastDriver.

Referenced by SCH_EDIT_FRAME::OnModify().

IsBus()

bool SCH_CONNECTION::IsBus ( ) const

inline

Definition at line 120 of file sch_connection.h.

    {
        return ( m_type == CONNECTION_TYPE::BUS || m_type == CONNECTION_TYPE::BUS_GROUP );
    }

References BUS, BUS_GROUP, and m_type.

Referenced by AppendInfoToMsgPanel(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckLabels(), IsMemberOfBus(), IsSubsetOf(), EE_SELECTION_TOOL::Main(), CONNECTION_GRAPH::matchBusMember(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), CONNECTION_GRAPH::propagateToNeighbors(), CONNECTION_SUBGRAPH::ResolveDrivers(), BUS_UNFOLD_MENU::update(), CONNECTION_SUBGRAPH::UpdateItemConnections(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsBusLabel()

bool SCH_CONNECTION::IsBusLabel ( const wxString &  aLabel )

static

Test if aLabel has a bus notation.

Parameters

aLabel

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

{
    const wxString& unescaped = UnescapeString( aLabel );

    return NET_SETTINGS::ParseBusVector( unescaped, nullptr, nullptr )
                || NET_SETTINGS::ParseBusGroup( unescaped, nullptr, nullptr );
}

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.

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

{
    wxASSERT( Parent() );

    switch( Parent()->Type() )
    {
    case SCH_LABEL_T:
    case SCH_GLOBAL_LABEL_T:
    case SCH_HIER_LABEL_T:
    case SCH_SHEET_PIN_T:
    case SCH_SHEET_T:
    case LIB_PIN_T:
        return true;

    case SCH_PIN_T:
    {
        auto pin = static_cast<SCH_PIN*>( Parent() );

        // Only annotated components should drive nets
        return pin->IsPowerConnection() || pin->GetParentSymbol()->IsAnnotated( &m_sheet );
    }

    default:
        return false;
    }
}

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.

{
    if( !aOther->IsBus() )
        return false;

    auto me = Name( true );

    for( const auto& m : aOther->Members() )
        if( m->Name( true ) == me )
            return true;

    return false;
}

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

IsNet()

bool SCH_CONNECTION::IsNet ( ) const

inline

Definition at line 125 of file sch_connection.h.

    {
        return ( m_type == CONNECTION_TYPE::NET );
    }

References m_type, and NET.

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), EE_SELECTION_TOOL::Main(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CONNECTION_SUBGRAPH::UpdateItemConnections(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

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.

{
    if( !aOther->IsBus() )
        return false;

    for( const auto& member : aOther->Members() )
    {
        if( member->FullLocalName() == FullLocalName() )
            return true;
    }

    return false;
}

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.

{ return ( m_type == CONNECTION_TYPE::NONE ); }

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.

{ return m_local_name; }

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

Definition at line 187 of file sch_connection.h.

    {
        return m_members;
    }

References m_members.

Referenced by CONNECTION_GRAPH::assignNetCodesToBus(), Clone(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), IsMemberOfBus(), IsSubsetOf(), CONNECTION_GRAPH::matchBusMember(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SetPrefix(), SetSuffix(), BUS_UNFOLD_MENU::update(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

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.

    {
        return m_members;
    }

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

aLabel

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

{
    // Weak heuristic for performance reasons.  Stronger test will be used for connectivity
    wxString label = UnescapeString( aLabel );

    return label.Contains( wxT( "[" ) ) || label.Contains( wxT( "{" ) );
}

References UnescapeString().

Name()

wxString SCH_CONNECTION::Name

(

bool

aIgnoreSheet = false

)

const

Definition at line 340 of file sch_connection.cpp.

{
    wxASSERT( !m_cached_name.IsEmpty() );
    return aIgnoreSheet ? m_cached_name : m_cached_name_with_path;
}

References m_cached_name, and m_cached_name_with_path.

Referenced by AppendInfoToMsgPanel(), BACK_ANNOTATE::applyChangelist(), SCH_EDITOR_CONTROL::AssignNetclass(), CONNECTION_GRAPH::assignNewNetCode(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_SUBGRAPH::GetNetName(), IsMemberOfBus(), SCH_ITEM::NetClass(), CONNECTION_GRAPH::propagateToNeighbors(), CONNECTION_GRAPH::recacheSubgraphName(), SCH_EDIT_FRAME::SetCrossProbeConnection(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

NetCode()

int SCH_CONNECTION::NetCode ( ) const

inline

Definition at line 171 of file sch_connection.h.

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

{
    return !( aOther == *this );
}

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.

{
    // NOTE: Not comparing m_dirty or net/bus/subgraph codes
    if( ( aOther.m_driver == m_driver ) &&
        ( aOther.m_type == m_type ) &&
        ( aOther.m_name == m_name ) &&
        ( aOther.m_sheet == m_sheet ) )
    {
        return true;
    }

    return false;
}

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.

{ return m_parent; }

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.

{ return m_prefix; }

References m_prefix.

Referenced by Clone().

PrintBusForUI()

wxString SCH_CONNECTION::PrintBusForUI ( const wxString &  aString )

static

Definition at line 506 of file sch_connection.cpp.

{
    size_t   groupLen = aGroup.length();
    size_t   i = 0;
    wxString ret;
    int      braceNesting = 0;
    int      tildeNesting = 0;

    // Parse prefix
    //
    for( ; i < groupLen; ++i )
    {
        if( isSuperSub( aGroup[i] ) && i + 1 < groupLen && aGroup[i+1] == '{' )
        {
            braceNesting++;
            i++;
            continue;
        }
        else if( aGroup[i] == '~' )
        {
            if( tildeNesting )
            {
                tildeNesting = 0;
                continue;
            }
            else
            {
                tildeNesting++;
            }
        }
        else if( aGroup[i] == '}' )
        {
            braceNesting--;
            continue;
        }

        ret += aGroup[i];

        if( aGroup[i] == '{' )
            break;
    }

    // Parse members
    //
    i++;  // '{' character

    for( ; i < groupLen; ++i )
    {
        if( isSuperSub( aGroup[i] ) && i + 1 < groupLen && aGroup[i+1] == '{' )
        {
            braceNesting++;
            i++;
            continue;
        }
        else if( aGroup[i] == '~' )
        {
            if( tildeNesting )
            {
                tildeNesting = 0;
                continue;
            }
            else
            {
                tildeNesting++;
            }
        }
        else if( aGroup[i] == '}' )
        {
            braceNesting--;
            continue;
        }

        ret += aGroup[i];

        if( aGroup[i] == '}' )
            break;
    }

    return ret;
}

References isSuperSub().

Referenced by BUS_UNFOLD_MENU::update().

recacheName()

void SCH_CONNECTION::recacheName ( )

private

Definition at line 347 of file sch_connection.cpp.

{
    m_cached_name = m_name.IsEmpty() ? "<NO NET>" : m_prefix + m_name + m_suffix;

    bool prepend_path = true;

    if( !Parent() || m_type == CONNECTION_TYPE::NONE )
        prepend_path = false;

    if( m_driver )
    {
        switch( m_driver->Type() )
        {
        case SCH_GLOBAL_LABEL_T:
        case SCH_PIN_T:
            // Pins are either power connections or belong to a uniquely-annotated
            // component, so they don't need a path if they are driving the subgraph
            prepend_path = false;
            break;

        default:
            break;
        }
    }

    m_cached_name_with_path =
            prepend_path ? m_sheet.PathHumanReadable() + m_cached_name : m_cached_name;
}

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.

{
    m_type = CONNECTION_TYPE::NONE;
    m_name.Empty();
    m_local_name.Empty();
    m_local_prefix.Empty();
    m_cached_name.Empty();
    m_cached_name_with_path.Empty();
    m_prefix.Empty();
    m_bus_prefix.Empty();
    m_suffix .Empty();
    m_lastDriver = m_driver;
    m_driver = nullptr;
    m_members.clear();
    m_dirty = true;
    m_net_code = 0;
    m_bus_code = 0;
    m_subgraph_code = 0;
    m_vector_start = 0;
    m_vector_end = 0;
    m_vector_index = 0;
    m_vector_prefix.Empty();
}

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.

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

{ m_dirty = true; }

References m_dirty.

SetDriver()

void SCH_CONNECTION::SetDriver

(

SCH_ITEM *

aItem

)

Definition at line 99 of file sch_connection.cpp.

{
    m_driver = aItem;

    recacheName();

    for( const std::shared_ptr<SCH_CONNECTION>& member : m_members )
        member->SetDriver( aItem );
}

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.

    {
        m_graph = aGraph;
    }

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.

    {
        m_name = aName;
        recacheName();
    }

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.

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

{
    m_prefix = aPrefix;

    recacheName();

    for( const auto& m : Members() )
        m->SetPrefix( aPrefix );
}

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

SetSheet()

void SCH_CONNECTION::SetSheet

(

SCH_SHEET_PATH

aSheet

)

Definition at line 110 of file sch_connection.cpp.

{
    m_sheet = aSheet;

    recacheName();

    for( const std::shared_ptr<SCH_CONNECTION>& member : m_members )
        member->SetSheet( aSheet );
}

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.

{ m_subgraph_code = aCode; }

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.

{
    m_suffix = aSuffix;

    recacheName();

    for( const auto& m : Members() )
        m->SetSuffix( aSuffix );
}

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

SetType()

void SCH_CONNECTION::SetType ( CONNECTION_TYPE  aType )

inline

Definition at line 165 of file sch_connection.h.

    {
        m_type = aType;
        recacheName();
    }

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.

{ return m_sheet; }

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.

{ return m_subgraph_code; }

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.

{ return m_suffix; }

References m_suffix.

Referenced by Clone().

Type()

CONNECTION_TYPE SCH_CONNECTION::Type ( ) const

inline

Definition at line 163 of file sch_connection.h.

{ return m_type; }

References m_type.

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

VectorEnd()

long SCH_CONNECTION::VectorEnd ( ) const

inline

Definition at line 181 of file sch_connection.h.

{ return m_vector_end; }

References m_vector_end.

Referenced by Clone().

VectorIndex()

long SCH_CONNECTION::VectorIndex ( ) const

inline

Definition at line 183 of file sch_connection.h.

{ return m_vector_index; }

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.

{ return 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.

{ return m_vector_start; }

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

See also

enum CONNECTION_TYPE

Definition at line 250 of file sch_connection.h.

Referenced by Clone(), ConfigureFromLabel(), IsBus(), IsNet(), IsUnconnected(), operator==(), recacheName(), Reset(), SetType(), and Type().

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:

• sch_connection.h
• sch_connection.cpp