Container for NETINFO_ITEM elements, which are the nets. More...

#include <netinfo.h>

Classes
class	iterator

Public Member Functions
	NETINFO_LIST (BOARD *aParent)

	~NETINFO_LIST ()

NETINFO_ITEM *	GetNetItem (int aNetCode) const

NETINFO_ITEM *	GetNetItem (const wxString &aNetName) const

unsigned	GetNetCount () const

void	AppendNet (NETINFO_ITEM *aNewElement)
	Add aNewElement to the end of the net list. More...

void	RemoveNet (NETINFO_ITEM *aNet)
	Remove a net from the net list. More...

void	RemoveUnusedNets ()

const NETNAMES_MAP &	NetsByName () const
	Return the name map, at least for python. More...

const NETCODES_MAP &	NetsByNetcode () const
	Return the netcode map, at least for python. More...

iterator	begin () const

iterator	end () const

BOARD *	GetParent () const

Static Public Member Functions
static NETINFO_ITEM *	OrphanedItem ()
	Wrapper class, so you can iterate through NETINFO_ITEMs, not std::pair<int/wxString, NETINFO_ITEM> More...

Static Public Attributes
static const int	UNCONNECTED = 0
	Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) when calling SetNetCode on board connected items. More...

static const int	ORPHANED = -1
	NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net list available. More...

Private Member Functions
void	clear ()
	Delete the list of nets (and free memory). More...

void	buildListOfNets ()
	Rebuild the list of NETINFO_ITEMs. More...

int	getFreeNetCode ()
	Return the first available net code that is not used by any other net. More...

Private Attributes
BOARD *	m_parent

NETNAMES_MAP	m_netNames
	map of <wxString, NETINFO_ITEM*>, is NETINFO_ITEM owner More...

NETCODES_MAP	m_netCodes
	map of <int, NETINFO_ITEM*> is NOT owner More...

int	m_newNetCode
	possible value for new net code assignment More...

Friends
class	BOARD

Detailed Description

Container for NETINFO_ITEM elements, which are the nets.

Definition at line 315 of file netinfo.h.

Constructor & Destructor Documentation

◆ NETINFO_LIST()

NETINFO_LIST::NETINFO_LIST ( BOARD * aParent )

Definition at line 35 of file netinfo_list.cpp.

                                            :
         m_parent( aParent )
 {
     // Make sure that the unconnected net has number 0
     AppendNet( new NETINFO_ITEM( aParent, wxEmptyString, 0 ) );
 
     m_newNetCode = 0;
 }

References AppendNet(), and m_newNetCode.

◆ ~NETINFO_LIST()

NETINFO_LIST::~NETINFO_LIST ( )

Definition at line 45 of file netinfo_list.cpp.

 {
     clear();
 }

References clear().

Member Function Documentation

◆ AppendNet()

void NETINFO_LIST::AppendNet ( NETINFO_ITEM * aNewElement )

Add aNewElement to the end of the net list.

Negative net code means it is going to be auto-assigned.

Definition at line 133 of file netinfo_list.cpp.

 {
     // if there is a net with such name then just assign the correct number
     NETINFO_ITEM* sameName = GetNetItem( aNewElement->GetNetname() );
 
     if( sameName != nullptr )
     {
         aNewElement->m_netCode = sameName->GetNetCode();
 
         return;
     }
     else if( aNewElement->m_netCode != (int) m_netCodes.size() || aNewElement->m_netCode < 0 )
     {
         // be sure that net codes are consecutive
         // negative net code means that it has to be auto assigned
         aNewElement->m_netCode = getFreeNetCode();
     }
 
     // net names & codes are supposed to be unique
     assert( GetNetItem( aNewElement->GetNetname() ) == nullptr );
     assert( GetNetItem( aNewElement->GetNetCode() ) == nullptr );
 
     // add an entry for fast look up by a net name using a map
     m_netNames.insert( std::make_pair( aNewElement->GetNetname(), aNewElement ) );
     m_netCodes.insert( std::make_pair( aNewElement->GetNetCode(), aNewElement ) );
 }

References getFreeNetCode(), NETINFO_ITEM::GetNetCode(), GetNetItem(), NETINFO_ITEM::GetNetname(), NETINFO_ITEM::m_netCode, m_netCodes, and m_netNames.

Referenced by NET_SELECTOR_COMBOPOPUP::Accept(), BOARD::Add(), NETINFO_LIST(), and DIALOG_NET_INSPECTOR::onRenameNet().

◆ begin()

iterator NETINFO_LIST::begin ( ) const

inline

Definition at line 436 of file netinfo.h.

     {
         return iterator( m_netNames.begin() );
     }

References m_netNames.

Referenced by BOARD::BeginNets(), DSN::SPECCTRA_DB::FromBOARD(), and TestForExistingItem().

◆ buildListOfNets()

void NETINFO_LIST::buildListOfNets ( )

private

Rebuild the list of NETINFO_ITEMs.

The list is sorted by names.

Definition at line 161 of file netinfo_list.cpp.

 {
     // Restore the initial state of NETINFO_ITEMs
     for( NETINFO_ITEM* net : *this )
         net->Clear();
 
     m_parent->SynchronizeNetsAndNetClasses( );
     m_parent->SetAreasNetCodesFromNetNames();
 }

References NETINFO_ITEM::Clear(), m_parent, BOARD::SetAreasNetCodesFromNetNames(), and BOARD::SynchronizeNetsAndNetClasses().

Referenced by BOARD::BuildListOfNets().

◆ clear()

void NETINFO_LIST::clear ( )

private

Delete the list of nets (and free memory).

Definition at line 51 of file netinfo_list.cpp.

 {
     NETNAMES_MAP::iterator it, itEnd;
     for( it = m_netNames.begin(), itEnd = m_netNames.end(); it != itEnd; ++it )
         delete it->second;
 
     m_netNames.clear();
     m_netCodes.clear();
     m_newNetCode = 0;
 }

References m_netCodes, m_netNames, and m_newNetCode.

Referenced by ~NETINFO_LIST().

◆ end()

iterator NETINFO_LIST::end ( ) const

inline

Definition at line 441 of file netinfo.h.

     {
         return iterator( m_netNames.end() );
     }

References m_netNames.

Referenced by BOARD::EndNets(), DSN::SPECCTRA_DB::FromBOARD(), and TestForExistingItem().

◆ getFreeNetCode()

int NETINFO_LIST::getFreeNetCode ( )

private

Return the first available net code that is not used by any other net.

Definition at line 189 of file netinfo_list.cpp.

 {
     do
     {
         if( m_newNetCode < 0 )
             m_newNetCode = 0;
     } while( m_netCodes.count( ++m_newNetCode ) != 0 );
 
     return m_newNetCode;
 }

References m_netCodes, and m_newNetCode.

Referenced by AppendNet().

◆ GetNetCount()

unsigned NETINFO_LIST::GetNetCount ( ) const

inline

Returns: the number of nets ( always >= 1 ) because the first net is the "not connected" net and always exists

Definition at line 339 of file netinfo.h.

339 { return m_netNames.size(); }

NETINFO_LIST::m_netNames

NETNAMES_MAP m_netNames

map of <wxString, NETINFO_ITEM*>, is NETINFO_ITEM owner

Definition: netinfo.h:472

References m_netNames.

Referenced by DIALOG_COPPER_ZONE::buildListOfNets(), BOARD::FindNet(), BOARD::GetMsgPanelInfo(), BOARD::GetNetCount(), FABMASTER::loadZones(), and DIALOG_COPPER_ZONE::readNetInformation().

◆ GetNetItem() [1/2]

NETINFO_ITEM * NETINFO_LIST::GetNetItem ( int aNetCode ) const

Parameters

aNetCode netcode to identify a given NETINFO_ITEM.

Returns: net item by aNetCode, or NULL if not found.

Definition at line 63 of file netinfo_list.cpp.

 {
     NETCODES_MAP::const_iterator result = m_netCodes.find( aNetCode );
 
     if( result != m_netCodes.end() )
         return (*result).second;
 
     return nullptr;
 }

References m_netCodes.

Referenced by NET_SELECTOR_COMBOPOPUP::Accept(), AppendNet(), BOARD::FindNet(), NET_SELECTOR_COMBOPOPUP::GetSelectedNetname(), NET_SELECTOR_COMBOPOPUP::GetStringValue(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onNetclassContextMenu(), NET_SELECTOR_COMBOPOPUP::rebuildList(), BOARD::Remove(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_EDIT_FRAME::SaveProjectSettings(), NET_SELECTOR_COMBOPOPUP::SetSelectedNet(), and APPEARANCE_CONTROLS::showNetclass().

◆ GetNetItem() [2/2]

NETINFO_ITEM * NETINFO_LIST::GetNetItem ( const wxString & aNetName ) const

Parameters

aNetName net name to identify a given NETINFO_ITEM.

Returns: net item by aNetName, or NULL if not found.

Definition at line 74 of file netinfo_list.cpp.

 {
     NETNAMES_MAP::const_iterator result = m_netNames.find( aNetName );
 
     if( result != m_netNames.end() )
         return (*result).second;
 
     return nullptr;
 }

References m_netNames.

◆ GetParent()

BOARD* NETINFO_LIST::GetParent ( void ) const

inline

Definition at line 447 of file netinfo.h.

     {
         return m_parent;
     }

References m_parent.

Referenced by NET_SELECTOR_COMBOPOPUP::Accept().

◆ NetsByName()

const NETNAMES_MAP& NETINFO_LIST::NetsByName ( ) const

inline

Return the name map, at least for python.

Returns: the number of pads in board.

Definition at line 358 of file netinfo.h.

358 { return m_netNames; }

NETINFO_LIST::m_netNames

NETNAMES_MAP m_netNames

map of <wxString, NETINFO_ITEM*>, is NETINFO_ITEM owner

Definition: netinfo.h:472

Referenced by FABMASTER::loadEtch(), FABMASTER::loadFootprints(), FABMASTER::loadVias(), FABMASTER::loadZone(), and NET_GRID_TABLE::Rebuild().

◆ NetsByNetcode()

const NETCODES_MAP& NETINFO_LIST::NetsByNetcode ( ) const

inline

Return the netcode map, at least for python.

Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are actually not connected items

Definition at line 361 of file netinfo.h.

References m_netCodes.

Referenced by DIALOG_NET_INSPECTOR::buildNetsList().

◆ OrphanedItem()

static NETINFO_ITEM* NETINFO_LIST::OrphanedItem ( )

inlinestatic

Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString, NETINFO_ITEM*>

Definition at line 373 of file netinfo.h.

References UNCONNECTED.

Referenced by BOARD::FindNet(), PCB_CONTROL::Paste(), and BOARD_CONNECTED_ITEM::SetNetCode().

◆ RemoveNet()

void NETINFO_LIST::RemoveNet ( NETINFO_ITEM * aNet )

Remove a net from the net list.

Definition at line 85 of file netinfo_list.cpp.

 {
     bool removed = false;
 
     for( NETCODES_MAP::iterator i = m_netCodes.begin(); i != m_netCodes.end(); ++i )
     {
         if ( i->second == aNet )
         {
             removed = true;
             m_netCodes.erase(i);
             break;
         }
     }
 
     for( NETNAMES_MAP::iterator i = m_netNames.begin(); i != m_netNames.end(); ++i )
     {
         if ( i->second == aNet )
         {
             wxASSERT_MSG( removed, "NETINFO_LIST::RemoveNet: target net found in m_netNames "
                           "but not m_netCodes!" );
             m_netNames.erase(i);
             break;
         }
     }
 
     if( removed )
         m_newNetCode = std::min( m_newNetCode, aNet->m_netCode - 1 );
 }

References NETINFO_ITEM::m_netCode, m_netCodes, m_netNames, and m_newNetCode.

Referenced by NET_SELECTOR_COMBOPOPUP::Accept(), DIALOG_NET_INSPECTOR::onRenameNet(), and BOARD::Remove().

◆ RemoveUnusedNets()

void NETINFO_LIST::RemoveUnusedNets ( )

Definition at line 115 of file netinfo_list.cpp.

 {
     NETCODES_MAP existingNets = m_netCodes;
 
     m_netCodes.clear();
     m_netNames.clear();
 
     for( std::pair<const int, NETINFO_ITEM*> item : existingNets )
     {
         if( item.second->IsCurrent() )
         {
             m_netNames.insert( std::make_pair( item.second->GetNetname(), item.second ) );
             m_netCodes.insert( std::make_pair( item.first, item.second ) );
         }
     }
 }

References m_netCodes, and m_netNames.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

Friends And Related Function Documentation

◆ BOARD

friend class BOARD

friend

Definition at line 317 of file netinfo.h.

Member Data Documentation

◆ m_netCodes

NETCODES_MAP NETINFO_LIST::m_netCodes

private

map of <int, NETINFO_ITEM*> is NOT owner

Definition at line 473 of file netinfo.h.

Referenced by AppendNet(), clear(), getFreeNetCode(), GetNetItem(), NetsByNetcode(), RemoveNet(), and RemoveUnusedNets().

◆ m_netNames

NETNAMES_MAP NETINFO_LIST::m_netNames

private

map of <wxString, NETINFO_ITEM*>, is NETINFO_ITEM owner

Definition at line 472 of file netinfo.h.

Referenced by AppendNet(), begin(), clear(), end(), GetNetCount(), GetNetItem(), RemoveNet(), and RemoveUnusedNets().

◆ m_newNetCode

int NETINFO_LIST::m_newNetCode

private

possible value for new net code assignment

Definition at line 475 of file netinfo.h.

Referenced by clear(), getFreeNetCode(), NETINFO_LIST(), and RemoveNet().

◆ m_parent

BOARD* NETINFO_LIST::m_parent

private

Definition at line 470 of file netinfo.h.

Referenced by buildListOfNets(), and GetParent().

◆ ORPHANED

const int NETINFO_LIST::ORPHANED = -1

static

NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net list available.

Definition at line 369 of file netinfo.h.

Referenced by FOOTPRINT::ClearAllNets(), PCB_PARSER::parsePAD(), and BOARD::SanitizeNetcodes().

◆ UNCONNECTED

const int NETINFO_LIST::UNCONNECTED = 0

static

Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) when calling SetNetCode on board connected items.

Definition at line 365 of file netinfo.h.

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), BOARD::FindNet(), PCB_IO::format(), ALTIUM_PCB::GetNetCode(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadZONE_CONTAINER(), OrphanedItem(), PCB_PARSER::parseNETINFO_ITEM(), PCB_PARSER::parseZONE(), BOARD::Remove(), PCB_SELECTION_CONDITIONS::sameNetFunc(), BOARD::SetAreasNetCodesFromNetNames(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and BOARD_NETLIST_UPDATER::updateComponentPadConnections().

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

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NETINFO_LIST()

◆ ~NETINFO_LIST()

Member Function Documentation

◆ AppendNet()

◆ begin()

◆ buildListOfNets()

◆ clear()

◆ end()

◆ getFreeNetCode()

◆ GetNetCount()

◆ GetNetItem() [1/2]

◆ GetNetItem() [2/2]

◆ GetParent()

◆ NetsByName()

◆ NetsByNetcode()

◆ OrphanedItem()

◆ RemoveNet()

◆ RemoveUnusedNets()

Friends And Related Function Documentation

◆ BOARD

Member Data Documentation

◆ m_netCodes

◆ m_netNames

◆ m_newNetCode

◆ m_parent

◆ ORPHANED

◆ UNCONNECTED