Store information read from a netlist along with the flags used to update the NETLIST in the BOARD. More...

#include <pcb_netlist.h>

Public Member Functions
	NETLIST ()

bool	IsEmpty () const

void	Clear ()
	Remove all components from the netlist. More...

unsigned	GetCount () const

COMPONENT *	GetComponent (unsigned aIndex)
	Return the COMPONENT at aIndex. More...

void	AddComponent (COMPONENT *aComponent)
	Add aComponent to the NETLIST. More...

COMPONENT *	GetComponentByReference (const wxString &aReference)
	Return a COMPONENT by aReference. More...

COMPONENT *	GetComponentByPath (const KIID_PATH &aPath)
	Return a COMPONENT by aPath. More...

void	SortByFPID ()

void	SortByReference ()

void	SetFindByTimeStamp (bool aFindByTimeStamp)

bool	IsFindByTimeStamp () const

void	SetReplaceFootprints (bool aReplace)

bool	GetReplaceFootprints () const

bool	AnyFootprintsLinked () const

void	Format (const char aDocName, OUTPUTFORMATTER aOut, int aNestLevel, int aCtl=0)

void	FormatCvpcbNetlist (OUTPUTFORMATTER *aOut)

Private Attributes
COMPONENTS	m_components

bool	m_findByTimeStamp

bool	m_replaceFootprints

Detailed Description

Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.

Definition at line 212 of file pcb_netlist.h.

Constructor & Destructor Documentation

◆ NETLIST()

NETLIST::NETLIST ( )

inline

Definition at line 215 of file pcb_netlist.h.

 :
 m_findByTimeStamp( false ),
 m_replaceFootprints( false )
 {
 }

Member Function Documentation

◆ AddComponent()

void NETLIST::AddComponent ( COMPONENT * aComponent )

Add aComponent to the NETLIST.

Note: If aComponent already exists in the NETLIST, aComponent is deleted to prevent memory leaks. An assertion is raised in debug builds.

Parameters

aComponent is the COMPONENT to save to the NETLIST.

Definition at line 145 of file pcb_netlist.cpp.

{
 m_components.push_back( aComponent );
}

References m_components.

Referenced by LEGACY_NETLIST_READER::loadComponent(), and KICAD_NETLIST_PARSER::parseComponent().

◆ AnyFootprintsLinked()

bool NETLIST::AnyFootprintsLinked ( ) const

Returns: true if any component with a footprint link is found.

Definition at line 224 of file pcb_netlist.cpp.

{
 for( unsigned i = 0; i < m_components.size(); i++ )
 {
 if( !m_components[i].GetFPID().empty() )
 return true;
 }
 
 return false;
}

References empty(), and m_components.

Referenced by CVPCB_MAINFRAME::readNetListAndFpFiles().

◆ Clear()

void NETLIST::Clear ( )

inline

Remove all components from the netlist.

Definition at line 229 of file pcb_netlist.h.

229{ m_components.clear(); }

References m_components.

Referenced by CVPCB_MAINFRAME::readSchematicNetlist().

◆ Format()

void NETLIST::Format	(	const char *	aDocName,
		OUTPUTFORMATTER *	aOut,
		int	aNestLevel,
		int	aCtl = `0`
	)

Definition at line 130 of file pcb_netlist.cpp.

{
 int nl = aNestLevel;
 
 aOut->Print( nl, "(%s\n", aDocName );
 
 for( unsigned i = 0; i < m_components.size(); i++ )
 {
 m_components[i].Format( aOut, nl+1, aCtl );
 }
 
 aOut->Print( nl, ")\n" );
}

References m_components, and OUTPUTFORMATTER::Print().

Referenced by FormatCvpcbNetlist().

◆ FormatCvpcbNetlist()

void NETLIST::FormatCvpcbNetlist ( OUTPUTFORMATTER * aOut )

inline

Definition at line 293 of file pcb_netlist.h.

 {
 Format( "cvpcb_netlist", aOut, 0, CTL_FOR_CVPCB );
 }

References CTL_FOR_CVPCB, and Format().

Referenced by CVPCB_MAINFRAME::SaveFootprintAssociation().

◆ GetComponent()

COMPONENT * NETLIST::GetComponent ( unsigned aIndex )

inline

Return the COMPONENT at aIndex.

Parameters

aIndex the index in m_components to fetch.

Returns: a pointer to the COMPONENT at Index.

Definition at line 242 of file pcb_netlist.h.

242{ return &m_components[ aIndex ]; }

References m_components.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::BuildSymbolsListBox(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), CVPCB_MAINFRAME::GetComponentIndices(), CVPCB_MAINFRAME::GetSelectedComponent(), PCB_EDIT_FRAME::LoadFootprints(), KICAD_NETLIST_READER::LoadNetlist(), KICAD_NETLIST_PARSER::parseLibPartList(), CVPCB_MAINFRAME::readNetListAndFpFiles(), CVPCB_MAINFRAME::readSchematicNetlist(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetComponentByPath()

COMPONENT * NETLIST::GetComponentByPath ( const KIID_PATH & aPath )

Return a COMPONENT by aPath.

Parameters

aPath is the KIID_PATH [ sheetUUID, .., compUUID ] of the COMPONENT.

Returns: a pointer to the COMPONENT that matches aPath if found. Otherwise NULL.

Definition at line 168 of file pcb_netlist.cpp.

{
 if( aUuidPath.empty() )
 return nullptr;
 
 KIID comp_uuid = aUuidPath.back();
 KIID_PATH base = aUuidPath;
 
 if( !base.empty() )
 base.pop_back();
 
 for( COMPONENT& component : m_components )
 {
 const std::vector<KIID>& kiids = component.GetKIIDs();
 
 if( base != component.GetPath() )
 continue;
 
 if( std::find( kiids.begin(), kiids.end(), comp_uuid ) != kiids.end() )
 return &component;
 }
 
 return nullptr;
}

References m_components.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetComponentByReference()

COMPONENT * NETLIST::GetComponentByReference ( const wxString & aReference )

Return a COMPONENT by aReference.

Parameters

aReference is the reference designator the COMPONENT.

Returns: a pointer to the COMPONENT that matches aReference if found. Otherwise NULL.

Definition at line 151 of file pcb_netlist.cpp.

{
 COMPONENT* component = nullptr;
 
 for( unsigned i = 0; i < m_components.size(); i++ )
 {
 if( m_components[i].GetReference() == aReference )
 {
 component = &m_components[i];
 break;
 }
 }
 
 return component;
}