Store all of the related footprint information found in a netlist. More...

#include <pcb_netlist.h>

Public Member Functions
	COMPONENT (const LIB_ID &aFPID, const wxString &aReference, const wxString &aValue, const KIID_PATH &aPath, const std::vector< KIID > &aKiids)

virtual	~COMPONENT ()

void	AddNet (const wxString &aPinName, const wxString &aNetName, const wxString &aPinFunction, const wxString &aPinType)

unsigned	GetNetCount () const

const COMPONENT_NET &	GetNet (unsigned aIndex) const

const COMPONENT_NET &	GetNet (const wxString &aPinName) const

void	ClearNets ()

void	SortPins ()

void	SetName (const wxString &aName)

const wxString &	GetName () const

void	SetLibrary (const wxString &aLibrary)

const wxString &	GetLibrary () const

void	SetReference (const wxString &aReference)

const wxString &	GetReference () const

void	SetValue (const wxString &aValue)

const wxString &	GetValue () const

void	SetProperties (std::map< wxString, wxString > &aProps)

const std::map< wxString, wxString > &	GetProperties () const

void	SetFPID (const LIB_ID &aFPID)

const LIB_ID &	GetFPID () const

void	SetAltFPID (const LIB_ID &aFPID)

const LIB_ID &	GetAltFPID () const

const KIID_PATH &	GetPath () const

const std::vector< KIID > &	GetKIIDs () const

void	SetFootprintFilters (const wxArrayString &aFilters)

const wxArrayString &	GetFootprintFilters () const

void	SetPinCount (int aPinCount)

int	GetPinCount () const

FOOTPRINT *	GetFootprint (bool aRelease=false)

void	SetFootprint (FOOTPRINT *aFootprint)

bool	IsLibSource (const wxString &aLibrary, const wxString &aName) const

void	Format (OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl)

Private Attributes
std::vector< COMPONENT_NET >	m_nets
	list of nets shared by the component pins More...

wxArrayString	m_footprintFilters

int	m_pinCount

wxString	m_reference

wxString	m_value

KIID_PATH	m_path
	A fully specified path to the component (but not the component: [ sheetUUID, sheetUUID, .. ]. More...

std::vector< KIID >	m_kiids
	A vector of possible KIIDs corresponding to all units in a symbol. More...

wxString	m_name
	The name of the component in m_library used when it was placed on the schematic. More...

wxString	m_library
	The name of the component library where m_name was found. More...

LIB_ID	m_fpid
	The LIB_ID of the footprint assigned to the component. More...

LIB_ID	m_altFpid
	The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist, the other from the .cmp file. More...

std::unique_ptr< FOOTPRINT >	m_footprint
	The FOOTPRINT loaded for #m_FPID. More...

std::map< wxString, wxString >	m_properties
	Component-specific properties found in the netlist. More...

Static Private Attributes
static COMPONENT_NET	m_emptyNet

Detailed Description

Store all of the related footprint information found in a netlist.

Definition at line 84 of file pcb_netlist.h.

Constructor & Destructor Documentation

◆ COMPONENT()

COMPONENT::COMPONENT	(	const LIB_ID &	aFPID,
		const wxString &	aReference,
		const wxString &	aValue,
		const KIID_PATH &	aPath,
		const std::vector< KIID > &	aKiids
	)

inline

Definition at line 87 of file pcb_netlist.h.

 {
 m_fpid = aFPID;
 m_reference = aReference;
 m_value = aValue;
 m_pinCount = 0;
 m_path = aPath;
 m_kiids = aKiids;
 }

References m_fpid, m_kiids, m_path, m_pinCount, m_reference, and m_value.

◆ ~COMPONENT()

virtual COMPONENT::~COMPONENT ( )

inlinevirtual

Definition at line 101 of file pcb_netlist.h.

101{ };

Member Function Documentation

◆ AddNet()

void COMPONENT::AddNet	(	const wxString &	aPinName,
		const wxString &	aNetName,
		const wxString &	aPinFunction,
		const wxString &	aPinType
	)

inline

Definition at line 103 of file pcb_netlist.h.

 {
 m_nets.emplace_back( aPinName, aNetName, aPinFunction, aPinType );
 }

References m_nets.

Referenced by BOARD_EDITOR_CONTROL::ExportNetlist(), PCB_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_VIEWER_FRAME::KiwayMailIn(), LEGACY_NETLIST_READER::loadNet(), and KICAD_NETLIST_PARSER::parseNet().

◆ ClearNets()

void COMPONENT::ClearNets ( )

inline

Definition at line 115 of file pcb_netlist.h.

115{ m_nets.clear(); }

References m_nets.

Referenced by FOOTPRINT_VIEWER_FRAME::KiwayMailIn().

◆ Format()

void COMPONENT::Format	(	OUTPUTFORMATTER *	aOut,
		int	aNestLevel,
		int	aCtl
	)

Definition at line 74 of file pcb_netlist.cpp.

{
 int nl = aNestLevel;
 
 aOut->Print( nl, "(ref %s ", aOut->Quotew( m_reference ).c_str() );
 aOut->Print( 0, "(fpid %s)\n", aOut->Quotew( m_fpid.Format() ).c_str() );
 
 if( !( aCtl & CTL_OMIT_EXTRA ) )
 {
 aOut->Print( nl+1, "(value %s)\n", aOut->Quotew( m_value ).c_str() );
 aOut->Print( nl+1, "(name %s)\n", aOut->Quotew( m_name ).c_str() );
 aOut->Print( nl+1, "(library %s)\n", aOut->Quotew( m_library ).c_str() );
 
 wxString path;
 
 for( const KIID& pathStep : m_path )
 path += '/' + pathStep.AsString();
 
 if( !( aCtl & CTL_OMIT_FP_UUID ) && !m_kiids.empty() )
 path += '/' + m_kiids.front().AsString();
 
 aOut->Print( nl+1, "(timestamp %s)\n", aOut->Quotew( path ).c_str() );
 }
 
 if( !( aCtl & CTL_OMIT_FILTERS ) && m_footprintFilters.GetCount() )
 {
 aOut->Print( nl+1, "(fp_filters" );
 
 for( unsigned i = 0; i < m_footprintFilters.GetCount(); ++i )
 aOut->Print( 0, " %s", aOut->Quotew( m_footprintFilters[i] ).c_str() );
 
 aOut->Print( 0, ")\n" );
 }
 
 if( !( aCtl & CTL_OMIT_NETS ) && m_nets.size() )
 {
 int llen = aOut->Print( nl+1, "(nets " );
 
 for( unsigned i = 0; i < m_nets.size(); ++i )
 {
 if( llen > 80 )
 {
 aOut->Print( 0, "\n" );
 llen = aOut->Print( nl+1, " " );
 }
 
 llen += m_nets[i].Format( aOut, 0, aCtl );
 }
 
 aOut->Print( 0, ")\n" );
 }
 
 aOut->Print( nl, ")\n" ); // </ref>
}

References CTL_OMIT_EXTRA, CTL_OMIT_FILTERS, CTL_OMIT_FP_UUID, CTL_OMIT_NETS, LIB_ID::Format(), m_footprintFilters, m_fpid, m_kiids, m_library, m_name, m_nets, m_path, m_reference, m_value, path, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

◆ GetAltFPID()

const LIB_ID & COMPONENT::GetAltFPID ( ) const

inline

Definition at line 141 of file pcb_netlist.h.

141{ return m_altFpid; }

COMPONENT::m_altFpid

LIB_ID m_altFpid

The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist...

Definition: pcb_netlist.h:193

References m_altFpid.

Referenced by CVPCB_MAINFRAME::readNetListAndFpFiles().

◆ GetFootprint()

FOOTPRINT * COMPONENT::GetFootprint ( bool aRelease = false )

inline

Definition at line 153 of file pcb_netlist.h.

 {
 return ( aRelease ) ? m_footprint.release() : m_footprint.get();
 }

References m_footprint.

◆ GetFootprintFilters()

const wxArrayString & COMPONENT::GetFootprintFilters ( ) const

inline

Definition at line 148 of file pcb_netlist.h.

148{ return m_footprintFilters; }

References m_footprintFilters.

Referenced by CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::DisplayStatus(), and FOOTPRINTS_LISTBOX::SetFootprints().

◆ GetFPID()

const LIB_ID & COMPONENT::GetFPID ( ) const

inline

◆ GetKIIDs()

const std::vector< KIID > & COMPONENT::GetKIIDs ( ) const

inline

Definition at line 145 of file pcb_netlist.h.

145{ return m_kiids; }

References m_kiids.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), PCB_EDIT_FRAME::LoadFootprints(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetLibrary()

const wxString & COMPONENT::GetLibrary ( ) const

inline

Definition at line 123 of file pcb_netlist.h.

123{ return m_library; }

References m_library.

◆ GetName()

const wxString & COMPONENT::GetName ( void ) const

inline

Definition at line 120 of file pcb_netlist.h.

120{ return m_name; }

References m_name.

◆ GetNet() [1/2]

const COMPONENT_NET & COMPONENT::GetNet ( const wxString & aPinName ) const

Definition at line 62 of file pcb_netlist.cpp.

{
 for( const COMPONENT_NET& net : m_nets )
 {
 if( net.GetPinName() == aPinName )
 return net;
 }
 
 return m_emptyNet;
}

References m_emptyNet, and m_nets.

◆ GetNet() [2/2]

const COMPONENT_NET & COMPONENT::GetNet ( unsigned aIndex ) const

inline

Definition at line 111 of file pcb_netlist.h.

111{ return m_nets[aIndex]; }

References m_nets.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), FOOTPRINT_VIEWER_FRAME::displayFootprint(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateCopperZoneNets().

◆ GetNetCount()

unsigned COMPONENT::GetNetCount ( ) const

inline

Definition at line 109 of file pcb_netlist.h.

109{ return m_nets.size(); }

References m_nets.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::updateCopperZoneNets().

◆ GetPath()

const KIID_PATH & COMPONENT::GetPath ( ) const

inline

Definition at line 143 of file pcb_netlist.h.

143{ return m_path; }

References m_path.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), PCB_EDIT_FRAME::LoadFootprints(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetPinCount()

int COMPONENT::GetPinCount ( ) const

inline

Definition at line 151 of file pcb_netlist.h.

151{ return m_pinCount; }

References m_pinCount.

Referenced by CVPCB_MAINFRAME::DisplayStatus(), and FOOTPRINTS_LISTBOX::SetFootprints().

◆ GetProperties()

const std::map< wxString, wxString > & COMPONENT::GetProperties ( ) const

inline

Definition at line 135 of file pcb_netlist.h.

135{ return m_properties; }

COMPONENT::m_properties

std::map< wxString, wxString > m_properties

Component-specific properties found in the netlist.

Definition: pcb_netlist.h:199

References m_properties.

Referenced by BOARD_NETLIST_UPDATER::updateFootprintParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetReference()

const wxString & COMPONENT::GetReference ( void ) const

inline

Definition at line 126 of file pcb_netlist.h.

126{ return m_reference; }

References m_reference.

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::BuildSymbolsListBox(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), PCB_EDIT_FRAME::LoadFootprints(), operator<(), CVPCB_MAINFRAME::readNetListAndFpFiles(), BOARD_NETLIST_UPDATER::replaceFootprint(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetValue()

const wxString & COMPONENT::GetValue ( ) const

inline

Definition at line 129 of file pcb_netlist.h.

129{ return m_value; }

References m_value.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::BuildSymbolsListBox(), CVPCB_MAINFRAME::readNetListAndFpFiles(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ IsLibSource()

bool COMPONENT::IsLibSource	(	const wxString &	aLibrary,
		const wxString &	aName
	)		const

inline

Definition at line 160 of file pcb_netlist.h.

 {
 return aLibrary == m_library && aName == m_name;
 }

References m_library, and m_name.

Referenced by KICAD_NETLIST_PARSER::parseLibPartList().

◆ SetAltFPID()

void COMPONENT::SetAltFPID ( const LIB_ID & aFPID )

inline

Definition at line 140 of file pcb_netlist.h.

140{ m_altFpid = aFPID; }

References m_altFpid.

Referenced by CMP_READER::Load().

◆ SetFootprint()

void COMPONENT::SetFootprint ( FOOTPRINT * aFootprint )

Definition at line 40 of file pcb_netlist.cpp.

{
 m_footprint.reset( aFootprint );
 KIID_PATH path = m_path;
 
 if( !m_kiids.empty() )
 path.push_back( m_kiids.front() );
 
 if( aFootprint == nullptr )
 return;
 
 aFootprint->SetReference( m_reference );
 aFootprint->SetValue( m_value );
 aFootprint->SetFPID( m_fpid );
 aFootprint->SetPath( path );
 aFootprint->SetProperties( m_properties );
}

References m_footprint, m_fpid, m_kiids, m_path, m_properties, m_reference, m_value, path, FOOTPRINT::SetFPID(), FOOTPRINT::SetPath(), FOOTPRINT::SetProperties(), FOOTPRINT::SetReference(), and FOOTPRINT::SetValue().

Referenced by PCB_EDIT_FRAME::LoadFootprints().

◆ SetFootprintFilters()

void COMPONENT::SetFootprintFilters ( const wxArrayString & aFilters )

inline

Definition at line 147 of file pcb_netlist.h.

147{ m_footprintFilters = aFilters; }

References m_footprintFilters.

Referenced by LEGACY_NETLIST_READER::loadFootprintFilters(), and KICAD_NETLIST_PARSER::parseLibPartList().

◆ SetFPID()

void COMPONENT::SetFPID ( const LIB_ID & aFPID )

inline

Definition at line 137 of file pcb_netlist.h.

137{ m_fpid = aFPID; }

References m_fpid.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), FOOTPRINT_VIEWER_FRAME::KiwayMailIn(), CMP_READER::Load(), CVPCB_MAINFRAME::readNetListAndFpFiles(), and CVPCB_MAINFRAME::readSchematicNetlist().

◆ SetLibrary()

void COMPONENT::SetLibrary ( const wxString & aLibrary )

inline

Definition at line 122 of file pcb_netlist.h.

122{ m_library = aLibrary; }

References m_library.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetName()

void COMPONENT::SetName ( const wxString & aName )

inline

Definition at line 119 of file pcb_netlist.h.

119{ m_name = aName;}

References m_name.

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

◆ SetPinCount()

void COMPONENT::SetPinCount ( int aPinCount )

inline

Definition at line 150 of file pcb_netlist.h.

150{ m_pinCount = aPinCount; }

References m_pinCount.

Referenced by KICAD_NETLIST_PARSER::parseLibPartList().

◆ SetProperties()

void COMPONENT::SetProperties ( std::map< wxString, wxString > & aProps )

inline

Definition at line 131 of file pcb_netlist.h.

 {
 m_properties = std::move( aProps );
 }

References m_properties.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetReference()

void COMPONENT::SetReference ( const wxString & aReference )

inline

Definition at line 125 of file pcb_netlist.h.

125{ m_reference = aReference; }

References m_reference.

Referenced by FOOTPRINT_VIEWER_FRAME::KiwayMailIn().

◆ SetValue()

void COMPONENT::SetValue ( const wxString & aValue )

inline

Definition at line 128 of file pcb_netlist.h.

128{ m_value = aValue; }

References m_value.

Referenced by FOOTPRINT_VIEWER_FRAME::KiwayMailIn().

◆ SortPins()

void COMPONENT::SortPins ( )

inline

Definition at line 117 of file pcb_netlist.h.

117{ sort( m_nets.begin(), m_nets.end() ); }

References m_nets.

Referenced by KICAD_NETLIST_READER::LoadNetlist().

Member Data Documentation

◆ m_altFpid

LIB_ID COMPONENT::m_altFpid

private

The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist, the other from the .cmp file.

this one is a copy of the netlist footprint assignment

Definition at line 193 of file pcb_netlist.h.

Referenced by GetAltFPID(), and SetAltFPID().

◆ m_emptyNet

COMPONENT_NET COMPONENT::m_emptyNet

staticprivate

Definition at line 201 of file pcb_netlist.h.

Referenced by GetNet().

◆ m_footprint

std::unique_ptr<FOOTPRINT> COMPONENT::m_footprint

private

The FOOTPRINT loaded for #m_FPID.

Definition at line 196 of file pcb_netlist.h.

Referenced by GetFootprint(), and SetFootprint().

◆ m_footprintFilters

wxArrayString COMPONENT::m_footprintFilters

private

Definition at line 170 of file pcb_netlist.h.

Referenced by Format(), GetFootprintFilters(), and SetFootprintFilters().

◆ m_fpid

LIB_ID COMPONENT::m_fpid

private

The LIB_ID of the footprint assigned to the component.

Definition at line 188 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetFPID(), SetFootprint(), and SetFPID().

◆ m_kiids

std::vector<KIID> COMPONENT::m_kiids

private

A vector of possible KIIDs corresponding to all units in a symbol.

Definition at line 179 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetKIIDs(), and SetFootprint().

◆ m_library

wxString COMPONENT::m_library

private

The name of the component library where m_name was found.

Definition at line 185 of file pcb_netlist.h.

Referenced by Format(), GetLibrary(), IsLibSource(), and SetLibrary().

◆ m_name

wxString COMPONENT::m_name

private

The name of the component in m_library used when it was placed on the schematic.

Definition at line 182 of file pcb_netlist.h.

Referenced by Format(), GetName(), IsLibSource(), and SetName().

◆ m_nets

std::vector<COMPONENT_NET> COMPONENT::m_nets

private

list of nets shared by the component pins

Definition at line 168 of file pcb_netlist.h.

Referenced by AddNet(), ClearNets(), Format(), GetNet(), GetNetCount(), and SortPins().

◆ m_path

KIID_PATH COMPONENT::m_path

private

A fully specified path to the component (but not the component: [ sheetUUID, sheetUUID, .. ].

Definition at line 176 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetPath(), and SetFootprint().

◆ m_pinCount

int COMPONENT::m_pinCount

private

Definition at line 171 of file pcb_netlist.h.

Referenced by COMPONENT(), GetPinCount(), and SetPinCount().

◆ m_properties

std::map<wxString, wxString> COMPONENT::m_properties

private

Component-specific properties found in the netlist.

Definition at line 199 of file pcb_netlist.h.

Referenced by GetProperties(), SetFootprint(), and SetProperties().

◆ m_reference

wxString COMPONENT::m_reference

private

Definition at line 172 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetReference(), SetFootprint(), and SetReference().

◆ m_value

wxString COMPONENT::m_value

private

Definition at line 173 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetValue(), SetFootprint(), and SetValue().

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

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ COMPONENT()

◆ ~COMPONENT()

Member Function Documentation

◆ AddNet()

◆ ClearNets()

◆ Format()

◆ GetAltFPID()

◆ GetFootprint()

◆ GetFootprintFilters()

◆ GetFPID()

◆ GetKIIDs()

◆ GetLibrary()

◆ GetName()

◆ GetNet() [1/2]

◆ GetNet() [2/2]

◆ GetNetCount()

◆ GetPath()

◆ GetPinCount()

◆ GetProperties()

◆ GetReference()

◆ GetValue()

◆ IsLibSource()

◆ SetAltFPID()

◆ SetFootprint()

◆ SetFootprintFilters()

◆ SetFPID()

◆ SetLibrary()

◆ SetName()

◆ SetPinCount()

◆ SetProperties()

◆ SetReference()

◆ SetValue()

◆ SortPins()

Member Data Documentation

◆ m_altFpid

◆ m_emptyNet

◆ m_footprint

◆ m_footprintFilters

◆ m_fpid

◆ m_kiids

◆ m_library

◆ m_name

◆ m_nets

◆ m_path

◆ m_pinCount

◆ m_properties

◆ m_reference

◆ m_value