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

#include <netlist.h>

Inheritance diagram for COMPONENT:

Classes
struct	UNIT_INFO

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	SetFields (nlohmann::ordered_map< wxString, wxString > aFields)

const nlohmann::ordered_map< wxString, wxString > &	GetFields () 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

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

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

void	SetHumanReadablePath (const wxString &aPath)

const wxString &	GetHumanReadablePath () const

void	SetComponentClassNames (const std::unordered_set< wxString > &aClassNames)

std::unordered_set< wxString > &	GetComponentClassNames ()

bool	GetDuplicatePadNumbersAreJumpers () const

void	SetDuplicatePadNumbersAreJumpers (bool aEnabled)

std::vector< std::set< wxString > > &	JumperPadGroups ()

const std::vector< std::set< wxString > > &	JumperPadGroups () const

NETLIST_GROUP *	GetGroup () const

void	SetGroup (NETLIST_GROUP *aGroup)

void	SetUnitInfo (const std::vector< UNIT_INFO > &aUnits)

const std::vector< UNIT_INFO > &	GetUnitInfo () const

	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	SetFields (nlohmann::ordered_map< wxString, wxString > aFields)

const nlohmann::ordered_map< wxString, wxString > &	GetFields () 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)

void	SetHumanReadablePath (const wxString &aPath)

const wxString &	GetHumanReadablePath () const

void	SetComponentClassNames (const std::unordered_set< wxString > &aClassNames)

std::unordered_set< wxString > &	GetComponentClassNames ()

bool	GetDuplicatePadNumbersAreJumpers () const

void	SetDuplicatePadNumbersAreJumpers (bool aEnabled)

std::vector< std::set< wxString > > &	JumperPadGroups ()

const std::vector< std::set< wxString > > &	JumperPadGroups () const

NETLIST_GROUP *	GetGroup () const

void	SetGroup (NETLIST_GROUP *aGroup)

void	SetUnitInfo (const std::vector< UNIT_INFO > &aUnits)

const std::vector< UNIT_INFO > &	GetUnitInfo () const

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

wxArrayString	m_footprintFilters

int	m_pinCount

wxString	m_reference

wxString	m_value

wxString	m_humanReadablePath

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

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

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

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

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

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.

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

nlohmann::ordered_map< wxString, wxString >	m_fields
	Component-specific user fields found in the netlist.

std::unordered_set< wxString >	m_componentClassNames
	Component classes for this footprint.

std::vector< std::set< wxString > >	m_jumperPadGroups
	Jumper pad groups for this footprint.

bool	m_duplicatePadNumbersAreJumpers
	Flag that this footprint should automatically treat sets of two or more pads with the same number as jumpered pin groups.

NETLIST_GROUP *	m_group
	Group membership for this footprint. Nullptr if none.

std::vector< UNIT_INFO >	m_units

Static Protected Attributes
static COMPONENT_NET	m_emptyNet

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

Detailed Description

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

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

This is the base class that handles netlist data without PCB-specific dependencies like FOOTPRINT. Derived classes in pcbnew can extend this with footprint-specific functionality.

Definition at line 103 of file common/netlist_reader/netlist.h.

Constructor & Destructor Documentation

◆ COMPONENT() [1/2]

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 106 of file common/netlist_reader/netlist.h.

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

Referenced by PCB_COMPONENT::PCB_COMPONENT().

◆ ~COMPONENT() [1/2]

virtual COMPONENT::~COMPONENT ( )

inlinevirtual

Definition at line 122 of file common/netlist_reader/netlist.h.

◆ COMPONENT() [2/2]

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 102 of file pcb_netlist.h.

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

◆ ~COMPONENT() [2/2]

virtual COMPONENT::~COMPONENT ( )

inlinevirtual

Definition at line 118 of file pcb_netlist.h.

Member Function Documentation

◆ AddNet() [1/2]

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

inline

Definition at line 124 of file common/netlist_reader/netlist.h.

References m_nets.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOARD_EDITOR_CONTROL::ExportNetlist(), PCB_EDIT_FRAME::KiwayMailIn(), and LEGACY_NETLIST_READER::loadNet().

◆ AddNet() [2/2]

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

inline

Definition at line 120 of file pcb_netlist.h.

References m_nets.

◆ ClearNets() [1/2]

void COMPONENT::ClearNets ( )

inline

Definition at line 136 of file common/netlist_reader/netlist.h.

References m_nets.

◆ ClearNets() [2/2]

void COMPONENT::ClearNets ( )

inline

Definition at line 132 of file pcb_netlist.h.

References m_nets.

◆ Format() [1/2]

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

Definition at line 95 of file common/netlist_reader/netlist.cpp.

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

◆ Format() [2/2]

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

◆ GetAltFPID() [1/2]

const LIB_ID & COMPONENT::GetAltFPID ( ) const

inline

Definition at line 168 of file common/netlist_reader/netlist.h.

References m_altFpid.

Referenced by CVPCB_MAINFRAME::readNetListAndFpFiles().

◆ GetAltFPID() [2/2]

const LIB_ID & COMPONENT::GetAltFPID ( ) const

inline

Definition at line 164 of file pcb_netlist.h.

References m_altFpid.

◆ GetComponentClassNames() [1/2]

std::unordered_set< wxString > & COMPONENT::GetComponentClassNames ( )

inline

Definition at line 195 of file common/netlist_reader/netlist.h.

References m_componentClassNames.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), and BOARD_NETLIST_UPDATER::updateComponentClass().

◆ GetComponentClassNames() [2/2]

std::unordered_set< wxString > & COMPONENT::GetComponentClassNames ( )

inline

Definition at line 198 of file pcb_netlist.h.

References m_componentClassNames.

◆ GetDuplicatePadNumbersAreJumpers() [1/2]

bool COMPONENT::GetDuplicatePadNumbersAreJumpers ( ) const

inline

Definition at line 197 of file common/netlist_reader/netlist.h.

References m_duplicatePadNumbersAreJumpers.

Referenced by BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetDuplicatePadNumbersAreJumpers() [2/2]

bool COMPONENT::GetDuplicatePadNumbersAreJumpers ( ) const

inline

Definition at line 200 of file pcb_netlist.h.

References m_duplicatePadNumbersAreJumpers.

◆ GetFields() [1/2]

const nlohmann::ordered_map< wxString, wxString > & COMPONENT::GetFields ( ) const

inline

Definition at line 156 of file common/netlist_reader/netlist.h.

References m_fields.

Referenced by BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetFields() [2/2]

const nlohmann::ordered_map< wxString, wxString > & COMPONENT::GetFields ( ) const

inline

Definition at line 152 of file pcb_netlist.h.

References m_fields.

◆ GetFootprint()

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

inline

Definition at line 176 of file pcb_netlist.h.

References m_footprint.

◆ GetFootprintFilters() [1/2]

const wxArrayString & COMPONENT::GetFootprintFilters ( ) const

inline

Definition at line 175 of file common/netlist_reader/netlist.h.

References m_footprintFilters.

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

◆ GetFootprintFilters() [2/2]

const wxArrayString & COMPONENT::GetFootprintFilters ( ) const

inline

Definition at line 171 of file pcb_netlist.h.

References m_footprintFilters.

◆ GetFPID() [1/2]

const LIB_ID & COMPONENT::GetFPID ( ) const

inline

◆ GetFPID() [2/2]

const LIB_ID & COMPONENT::GetFPID ( ) const

inline

Definition at line 161 of file pcb_netlist.h.

References m_fpid.

◆ GetGroup() [1/2]

NETLIST_GROUP * COMPONENT::GetGroup ( ) const

inline

Definition at line 203 of file common/netlist_reader/netlist.h.

References m_group.

Referenced by BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ GetGroup() [2/2]

NETLIST_GROUP * COMPONENT::GetGroup ( ) const

inline

Definition at line 206 of file pcb_netlist.h.

References m_group.

◆ GetHumanReadablePath() [1/2]

const wxString & COMPONENT::GetHumanReadablePath ( ) const

inline

Definition at line 188 of file common/netlist_reader/netlist.h.

References m_humanReadablePath.

Referenced by BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetHumanReadablePath() [2/2]

const wxString & COMPONENT::GetHumanReadablePath ( ) const

inline

Definition at line 191 of file pcb_netlist.h.

References m_humanReadablePath.

◆ GetKIIDs() [1/2]

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

inline

Definition at line 172 of file common/netlist_reader/netlist.h.

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().

◆ GetKIIDs() [2/2]

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

inline

Definition at line 168 of file pcb_netlist.h.

References m_kiids.

◆ GetLibrary() [1/2]

const wxString & COMPONENT::GetLibrary ( ) const

inline

Definition at line 144 of file common/netlist_reader/netlist.h.

References m_library.

◆ GetLibrary() [2/2]

const wxString & COMPONENT::GetLibrary ( ) const

inline

Definition at line 140 of file pcb_netlist.h.

References m_library.

◆ GetName() [1/2]

const wxString & COMPONENT::GetName ( ) const

inline

Definition at line 141 of file common/netlist_reader/netlist.h.

References m_name.

◆ GetName() [2/2]

const wxString & COMPONENT::GetName ( ) const

inline

Definition at line 137 of file pcb_netlist.h.

References m_name.

◆ GetNet() [1/4]

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

Definition at line 44 of file common/netlist_reader/netlist.cpp.

References ExpandStackedPinNotation(), m_emptyNet, m_nets, and m_reference.

◆ GetNet() [2/4]

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

◆ GetNet() [3/4]

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

inline

Definition at line 132 of file common/netlist_reader/netlist.h.

References m_nets.

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

◆ GetNet() [4/4]

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

inline

Definition at line 128 of file pcb_netlist.h.

References m_nets.

◆ GetNetCount() [1/2]

unsigned COMPONENT::GetNetCount ( ) const

inline

Definition at line 130 of file common/netlist_reader/netlist.h.

References m_nets.

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

◆ GetNetCount() [2/2]

unsigned COMPONENT::GetNetCount ( ) const

inline

Definition at line 126 of file pcb_netlist.h.

References m_nets.

◆ GetPath() [1/2]

const KIID_PATH & COMPONENT::GetPath ( ) const

inline

Definition at line 170 of file common/netlist_reader/netlist.h.

References m_path.

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

◆ GetPath() [2/2]

const KIID_PATH & COMPONENT::GetPath ( ) const

inline

Definition at line 166 of file pcb_netlist.h.

References m_path.

◆ GetPinCount() [1/2]

int COMPONENT::GetPinCount ( ) const

inline

Definition at line 178 of file common/netlist_reader/netlist.h.

References m_pinCount.

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

◆ GetPinCount() [2/2]

int COMPONENT::GetPinCount ( ) const

inline

Definition at line 174 of file pcb_netlist.h.

References m_pinCount.

◆ GetProperties() [1/2]

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

inline

Definition at line 162 of file common/netlist_reader/netlist.h.

References m_properties.

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

◆ GetProperties() [2/2]

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

inline

Definition at line 158 of file pcb_netlist.h.

References m_properties.

◆ GetReference() [1/2]

const wxString & COMPONENT::GetReference ( ) const

inline

Definition at line 147 of file common/netlist_reader/netlist.h.

References m_reference.

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::LoadFootprints(), operator<(), KICAD_NETLIST_PARSER::parseLibPartList(), CVPCB_MAINFRAME::readNetListAndFpFiles(), BOARD_NETLIST_UPDATER::replaceFootprint(), FOOTPRINTS_LISTBOX::SetFootprints(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetReference() [2/2]

const wxString & COMPONENT::GetReference ( ) const

inline

Definition at line 143 of file pcb_netlist.h.

References m_reference.

◆ GetUnitInfo() [1/2]

const std::vector< UNIT_INFO > & COMPONENT::GetUnitInfo ( ) const

inline

Definition at line 214 of file common/netlist_reader/netlist.h.

References m_units.

Referenced by BOARD_NETLIST_UPDATER::updateComponentUnits().

◆ GetUnitInfo() [2/2]

const std::vector< UNIT_INFO > & COMPONENT::GetUnitInfo ( ) const

inline

Definition at line 217 of file pcb_netlist.h.

References m_units.

◆ GetValue() [1/2]

const wxString & COMPONENT::GetValue ( ) const

inline

Definition at line 150 of file common/netlist_reader/netlist.h.

References m_value.

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

◆ GetValue() [2/2]

const wxString & COMPONENT::GetValue ( ) const

inline

Definition at line 146 of file pcb_netlist.h.

References m_value.

◆ IsLibSource() [1/2]

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

inline

Definition at line 180 of file common/netlist_reader/netlist.h.

References m_library, and m_name.

Referenced by KICAD_NETLIST_PARSER::parseLibPartList().

◆ IsLibSource() [2/2]

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

inline

Definition at line 183 of file pcb_netlist.h.

References m_library, and m_name.

◆ JumperPadGroups() [1/4]

std::vector< std::set< wxString > > & COMPONENT::JumperPadGroups ( )

inline

Definition at line 200 of file common/netlist_reader/netlist.h.

References m_jumperPadGroups.

Referenced by KICAD_NETLIST_PARSER::parseComponent(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ JumperPadGroups() [2/4]

std::vector< std::set< wxString > > & COMPONENT::JumperPadGroups ( )

inline

Definition at line 203 of file pcb_netlist.h.

References m_jumperPadGroups.

◆ JumperPadGroups() [3/4]

const std::vector< std::set< wxString > > & COMPONENT::JumperPadGroups ( ) const

inline

Definition at line 201 of file common/netlist_reader/netlist.h.

References m_jumperPadGroups.

◆ JumperPadGroups() [4/4]

const std::vector< std::set< wxString > > & COMPONENT::JumperPadGroups ( ) const

inline

Definition at line 204 of file pcb_netlist.h.

References m_jumperPadGroups.

◆ SetAltFPID() [1/2]

void COMPONENT::SetAltFPID ( const LIB_ID & aFPID )

inline

Definition at line 167 of file common/netlist_reader/netlist.h.

References m_altFpid.

Referenced by CMP_READER::Load().

◆ SetAltFPID() [2/2]

void COMPONENT::SetAltFPID ( const LIB_ID & aFPID )

inline

Definition at line 163 of file pcb_netlist.h.

References m_altFpid.

◆ SetComponentClassNames() [1/2]

void COMPONENT::SetComponentClassNames ( const std::unordered_set< wxString > & aClassNames )

inline

Definition at line 190 of file common/netlist_reader/netlist.h.

References m_componentClassNames.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetComponentClassNames() [2/2]

void COMPONENT::SetComponentClassNames ( const std::unordered_set< wxString > & aClassNames )

inline

Definition at line 193 of file pcb_netlist.h.

References m_componentClassNames.

◆ SetDuplicatePadNumbersAreJumpers() [1/2]

void COMPONENT::SetDuplicatePadNumbersAreJumpers ( bool aEnabled )

inline

Definition at line 198 of file common/netlist_reader/netlist.h.

References m_duplicatePadNumbersAreJumpers.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetDuplicatePadNumbersAreJumpers() [2/2]

void COMPONENT::SetDuplicatePadNumbersAreJumpers ( bool aEnabled )

inline

Definition at line 201 of file pcb_netlist.h.

References m_duplicatePadNumbersAreJumpers.

◆ SetFields() [1/2]

void COMPONENT::SetFields ( nlohmann::ordered_map< wxString, wxString > aFields )

inline

Definition at line 152 of file common/netlist_reader/netlist.h.

References m_fields.

Referenced by BOARD_EDITOR_CONTROL::ExportNetlist(), PCB_EDIT_FRAME::KiwayMailIn(), and KICAD_NETLIST_PARSER::parseComponent().

◆ SetFields() [2/2]

void COMPONENT::SetFields ( nlohmann::ordered_map< wxString, wxString > aFields )

inline

Definition at line 148 of file pcb_netlist.h.

References m_fields.

◆ SetFootprint()

void COMPONENT::SetFootprint ( FOOTPRINT * aFootprint )

Definition at line 44 of file pcb_netlist.cpp.

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

Referenced by PCB_EDIT_FRAME::LoadFootprints().

◆ SetFootprintFilters() [1/2]

void COMPONENT::SetFootprintFilters ( const wxArrayString & aFilters )

inline

Definition at line 174 of file common/netlist_reader/netlist.h.

References m_footprintFilters.

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

◆ SetFootprintFilters() [2/2]

void COMPONENT::SetFootprintFilters ( const wxArrayString & aFilters )

inline

Definition at line 170 of file pcb_netlist.h.

References m_footprintFilters.

◆ SetFPID() [1/2]

void COMPONENT::SetFPID ( const LIB_ID & aFPID )

inline

Definition at line 164 of file common/netlist_reader/netlist.h.

References m_fpid.

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

◆ SetFPID() [2/2]

void COMPONENT::SetFPID ( const LIB_ID & aFPID )

inline

Definition at line 160 of file pcb_netlist.h.

References m_fpid.

◆ SetGroup() [1/2]

void COMPONENT::SetGroup ( NETLIST_GROUP * aGroup )

inline

Definition at line 204 of file common/netlist_reader/netlist.h.

References m_group.

Referenced by NETLIST::ApplyGroupMembership().

◆ SetGroup() [2/2]

void COMPONENT::SetGroup ( NETLIST_GROUP * aGroup )

inline

Definition at line 207 of file pcb_netlist.h.

References m_group.

◆ SetHumanReadablePath() [1/2]

void COMPONENT::SetHumanReadablePath ( const wxString & aPath )

inline

Definition at line 187 of file common/netlist_reader/netlist.h.

References m_humanReadablePath.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetHumanReadablePath() [2/2]

void COMPONENT::SetHumanReadablePath ( const wxString & aPath )

inline

Definition at line 190 of file pcb_netlist.h.

References m_humanReadablePath.

◆ SetLibrary() [1/2]

void COMPONENT::SetLibrary ( const wxString & aLibrary )

inline

Definition at line 143 of file common/netlist_reader/netlist.h.

References m_library.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetLibrary() [2/2]

void COMPONENT::SetLibrary ( const wxString & aLibrary )

inline

Definition at line 139 of file pcb_netlist.h.

References m_library.

◆ SetName() [1/2]

void COMPONENT::SetName ( const wxString & aName )

inline

Definition at line 140 of file common/netlist_reader/netlist.h.

References m_name.

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

◆ SetName() [2/2]

void COMPONENT::SetName ( const wxString & aName )

inline

Definition at line 136 of file pcb_netlist.h.

References m_name.

◆ SetPinCount() [1/2]

void COMPONENT::SetPinCount ( int aPinCount )

inline

Definition at line 177 of file common/netlist_reader/netlist.h.

References m_pinCount.

Referenced by KICAD_NETLIST_PARSER::parseLibPartList().

◆ SetPinCount() [2/2]

void COMPONENT::SetPinCount ( int aPinCount )

inline

Definition at line 173 of file pcb_netlist.h.

References m_pinCount.

◆ SetProperties() [1/2]

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

inline

Definition at line 158 of file common/netlist_reader/netlist.h.

References m_properties.

Referenced by PCB_EDIT_FRAME::KiwayMailIn(), and KICAD_NETLIST_PARSER::parseComponent().

◆ SetProperties() [2/2]

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

inline

Definition at line 154 of file pcb_netlist.h.

References m_properties.

◆ SetReference() [1/2]

void COMPONENT::SetReference ( const wxString & aReference )

inline

Definition at line 146 of file common/netlist_reader/netlist.h.

References m_reference.

◆ SetReference() [2/2]

void COMPONENT::SetReference ( const wxString & aReference )

inline

Definition at line 142 of file pcb_netlist.h.

References m_reference.

◆ SetUnitInfo() [1/2]

void COMPONENT::SetUnitInfo ( const std::vector< UNIT_INFO > & aUnits )

inline

Definition at line 213 of file common/netlist_reader/netlist.h.

References m_units.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetUnitInfo() [2/2]

void COMPONENT::SetUnitInfo ( const std::vector< UNIT_INFO > & aUnits )

inline

Definition at line 216 of file pcb_netlist.h.

References m_units.

◆ SetValue() [1/2]

void COMPONENT::SetValue ( const wxString & aValue )

inline

Definition at line 149 of file common/netlist_reader/netlist.h.

References m_value.

◆ SetValue() [2/2]

void COMPONENT::SetValue ( const wxString & aValue )

inline

Definition at line 145 of file pcb_netlist.h.

References m_value.

◆ SortPins() [1/2]

void COMPONENT::SortPins ( )

inline

Definition at line 138 of file common/netlist_reader/netlist.h.

References m_nets.

◆ SortPins() [2/2]

void COMPONENT::SortPins ( )

inline

Definition at line 134 of file pcb_netlist.h.

References m_nets.

Member Data Documentation

◆ m_altFpid

LIB_ID COMPONENT::m_altFpid

protected

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 245 of file common/netlist_reader/netlist.h.

Referenced by GetAltFPID(), and SetAltFPID().

◆ m_componentClassNames

std::unordered_set< wxString > COMPONENT::m_componentClassNames

protected

Component classes for this footprint.

Definition at line 254 of file common/netlist_reader/netlist.h.

Referenced by GetComponentClassNames(), and SetComponentClassNames().

◆ m_duplicatePadNumbersAreJumpers

bool COMPONENT::m_duplicatePadNumbersAreJumpers

protected

Flag that this footprint should automatically treat sets of two or more pads with the same number as jumpered pin groups.

Definition at line 261 of file common/netlist_reader/netlist.h.

Referenced by COMPONENT(), GetDuplicatePadNumbersAreJumpers(), and SetDuplicatePadNumbersAreJumpers().

◆ m_emptyNet

static COMPONENT_NET COMPONENT::m_emptyNet

staticprotected

Definition at line 266 of file common/netlist_reader/netlist.h.

Referenced by GetNet().

◆ m_fields

nlohmann::ordered_map< wxString, wxString > COMPONENT::m_fields

protected

Component-specific user fields found in the netlist.

Definition at line 251 of file common/netlist_reader/netlist.h.

Referenced by Format(), GetFields(), and SetFields().

◆ m_footprint

std::unique_ptr<FOOTPRINT> COMPONENT::m_footprint

private

The FOOTPRINT loaded for #m_FPID.

Definition at line 251 of file pcb_netlist.h.

Referenced by GetFootprint(), and SetFootprint().

◆ m_footprintFilters

wxArrayString COMPONENT::m_footprintFilters

protected

Definition at line 219 of file common/netlist_reader/netlist.h.

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

◆ m_fpid

LIB_ID COMPONENT::m_fpid

protected

The LIB_ID of the footprint assigned to the component.

Definition at line 240 of file common/netlist_reader/netlist.h.

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

◆ m_group

NETLIST_GROUP * COMPONENT::m_group

protected

Group membership for this footprint. Nullptr if none.

Definition at line 264 of file common/netlist_reader/netlist.h.

Referenced by COMPONENT(), GetGroup(), and SetGroup().

◆ m_humanReadablePath

wxString COMPONENT::m_humanReadablePath

protected

Definition at line 225 of file common/netlist_reader/netlist.h.

Referenced by GetHumanReadablePath(), and SetHumanReadablePath().

◆ m_jumperPadGroups

std::vector< std::set< wxString > > COMPONENT::m_jumperPadGroups

protected

Jumper pad groups for this footprint.

Definition at line 257 of file common/netlist_reader/netlist.h.

Referenced by JumperPadGroups(), and JumperPadGroups().

◆ m_kiids

std::vector< KIID > COMPONENT::m_kiids

protected

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

Definition at line 231 of file common/netlist_reader/netlist.h.

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

◆ m_library

wxString COMPONENT::m_library

protected

The name of the component library where m_name was found.

Definition at line 237 of file common/netlist_reader/netlist.h.

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

◆ m_name

wxString COMPONENT::m_name

protected

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

Definition at line 234 of file common/netlist_reader/netlist.h.

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

◆ m_nets

std::vector< COMPONENT_NET > COMPONENT::m_nets

protected

list of nets shared by the component pins

Definition at line 217 of file common/netlist_reader/netlist.h.

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

◆ m_path

KIID_PATH COMPONENT::m_path

protected

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

Definition at line 228 of file common/netlist_reader/netlist.h.

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

◆ m_pinCount

int COMPONENT::m_pinCount

protected

Definition at line 220 of file common/netlist_reader/netlist.h.

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

◆ m_properties

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

protected

Component-specific properties found in the netlist.

Definition at line 248 of file common/netlist_reader/netlist.h.

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

◆ m_reference

wxString COMPONENT::m_reference

protected

Definition at line 221 of file common/netlist_reader/netlist.h.

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

◆ m_units

std::vector< UNIT_INFO > COMPONENT::m_units

protected

Definition at line 269 of file common/netlist_reader/netlist.h.

Referenced by GetUnitInfo(), SetFootprint(), and SetUnitInfo().

◆ m_value

wxString COMPONENT::m_value

protected

Definition at line 222 of file common/netlist_reader/netlist.h.

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

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

Classes

Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ COMPONENT() [1/2]

◆ ~COMPONENT() [1/2]

◆ COMPONENT() [2/2]

◆ ~COMPONENT() [2/2]

Member Function Documentation

◆ AddNet() [1/2]

◆ AddNet() [2/2]

◆ ClearNets() [1/2]

◆ ClearNets() [2/2]

◆ Format() [1/2]

◆ Format() [2/2]

◆ GetAltFPID() [1/2]

◆ GetAltFPID() [2/2]

◆ GetComponentClassNames() [1/2]

◆ GetComponentClassNames() [2/2]

◆ GetDuplicatePadNumbersAreJumpers() [1/2]

◆ GetDuplicatePadNumbersAreJumpers() [2/2]

◆ GetFields() [1/2]

◆ GetFields() [2/2]

◆ GetFootprint()

◆ GetFootprintFilters() [1/2]

◆ GetFootprintFilters() [2/2]

◆ GetFPID() [1/2]

◆ GetFPID() [2/2]

◆ GetGroup() [1/2]

◆ GetGroup() [2/2]

◆ GetHumanReadablePath() [1/2]

◆ GetHumanReadablePath() [2/2]

◆ GetKIIDs() [1/2]

◆ GetKIIDs() [2/2]

◆ GetLibrary() [1/2]

◆ GetLibrary() [2/2]

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetNet() [1/4]

◆ GetNet() [2/4]

◆ GetNet() [3/4]

◆ GetNet() [4/4]

◆ GetNetCount() [1/2]

◆ GetNetCount() [2/2]

◆ GetPath() [1/2]

◆ GetPath() [2/2]

◆ GetPinCount() [1/2]

◆ GetPinCount() [2/2]

◆ GetProperties() [1/2]

◆ GetProperties() [2/2]

◆ GetReference() [1/2]

◆ GetReference() [2/2]

◆ GetUnitInfo() [1/2]

◆ GetUnitInfo() [2/2]

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ IsLibSource() [1/2]

◆ IsLibSource() [2/2]

◆ JumperPadGroups() [1/4]

◆ JumperPadGroups() [2/4]

◆ JumperPadGroups() [3/4]

◆ JumperPadGroups() [4/4]

◆ SetAltFPID() [1/2]

◆ SetAltFPID() [2/2]

◆ SetComponentClassNames() [1/2]

◆ SetComponentClassNames() [2/2]

◆ SetDuplicatePadNumbersAreJumpers() [1/2]

◆ SetDuplicatePadNumbersAreJumpers() [2/2]

◆ SetFields() [1/2]

◆ SetFields() [2/2]

◆ SetFootprint()

◆ SetFootprintFilters() [1/2]

◆ SetFootprintFilters() [2/2]

◆ SetFPID() [1/2]

◆ SetFPID() [2/2]

◆ SetGroup() [1/2]

◆ SetGroup() [2/2]