NETLIST Class Reference

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.
unsigned	GetCount () const
COMPONENT *	GetComponent (unsigned aIndex)
	Return the COMPONENT at aIndex.
void	AddComponent (COMPONENT *aComponent)
	Add aComponent to the NETLIST.
COMPONENT *	GetComponentByReference (const wxString &aReference)
	Return a COMPONENT by aReference.
COMPONENT *	GetComponentByPath (const KIID_PATH &aPath)
	Return a COMPONENT by aPath.
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 229 of file pcb_netlist.h.

Constructor & Destructor Documentation

NETLIST()

NETLIST::NETLIST ( )

inline

Definition at line 232 of file pcb_netlist.h.

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 160 of file pcb_netlist.cpp.

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 239 of file pcb_netlist.cpp.

References empty(), and m_components.

Referenced by CVPCB_MAINFRAME::readNetListAndFpFiles().

Clear()

void NETLIST::Clear ( )

inline

Remove all components from the netlist.

Definition at line 246 of file pcb_netlist.h.

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 145 of file pcb_netlist.cpp.

References m_components, and OUTPUTFORMATTER::Print().

Referenced by FormatCvpcbNetlist().

FormatCvpcbNetlist()

void NETLIST::FormatCvpcbNetlist ( OUTPUTFORMATTER *  aOut )

inline

Definition at line 305 of file pcb_netlist.h.

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

References m_components.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), 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 183 of file pcb_netlist.cpp.

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 166 of file pcb_netlist.cpp.

References m_components.

Referenced by CMP_READER::Load(), LEGACY_NETLIST_READER::loadFootprintFilters(), KICAD_NETLIST_PARSER::parseNet(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

GetCount()

unsigned NETLIST::GetCount ( ) const

inline

Returns

the number of components in the netlist.

Definition at line 251 of file pcb_netlist.h.

References m_components.

Referenced by CVPCB_MAINFRAME::AutomaticFootprintMatching(), 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(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

GetReplaceFootprints()

bool NETLIST::GetReplaceFootprints ( ) const

inline

Definition at line 294 of file pcb_netlist.h.

References m_replaceFootprints.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

IsEmpty()

bool NETLIST::IsEmpty ( ) const

inline

Returns

true if there are no components in the netlist.

Definition at line 241 of file pcb_netlist.h.

References m_components.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::GetComponentIndices(), PCB_EDIT_FRAME::LoadFootprints(), and CVPCB_MAINFRAME::SendComponentSelectionToSch().

IsFindByTimeStamp()

bool NETLIST::IsFindByTimeStamp ( ) const

inline

Definition at line 291 of file pcb_netlist.h.

References m_findByTimeStamp.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

SetFindByTimeStamp()

void NETLIST::SetFindByTimeStamp ( bool  aFindByTimeStamp )

inline

Definition at line 290 of file pcb_netlist.h.

References m_findByTimeStamp.

Referenced by DIALOG_UPDATE_PCB::PerformUpdate().

SetReplaceFootprints()

void NETLIST::SetReplaceFootprints ( bool  aReplace )

inline

Definition at line 293 of file pcb_netlist.h.

References m_replaceFootprints.

Referenced by DIALOG_UPDATE_PCB::PerformUpdate().

SortByFPID()

void NETLIST::SortByFPID

(

)

Definition at line 218 of file pcb_netlist.cpp.

References ByFPID(), and m_components.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

SortByReference()

void NETLIST::SortByReference

(

)

Definition at line 233 of file pcb_netlist.cpp.

References m_components.

Referenced by DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), and CVPCB_MAINFRAME::readSchematicNetlist().

Member Data Documentation

m_components

COMPONENTS NETLIST::m_components

private

Definition at line 311 of file pcb_netlist.h.

Referenced by AddComponent(), AnyFootprintsLinked(), Clear(), Format(), GetComponent(), GetComponentByPath(), GetComponentByReference(), GetCount(), IsEmpty(), SortByFPID(), and SortByReference().

m_findByTimeStamp

bool NETLIST::m_findByTimeStamp

private

Definition at line 313 of file pcb_netlist.h.

Referenced by IsFindByTimeStamp(), and SetFindByTimeStamp().

m_replaceFootprints

bool NETLIST::m_replaceFootprints

private

Definition at line 314 of file pcb_netlist.h.

Referenced by GetReplaceFootprints(), and SetReplaceFootprints().

---

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

• pcb_netlist.h
• pcb_netlist.cpp